diff --git a/Cisco/Catalyst SD-WAN Manager/OpenAPIs/cisco_catalyst_sdwan_manager-20.12.json b/Cisco/Catalyst SD-WAN Manager/OpenAPIs/cisco_catalyst_sdwan_manager-20.12.json
new file mode 100644
index 0000000..b832e9d
--- /dev/null
+++ b/Cisco/Catalyst SD-WAN Manager/OpenAPIs/cisco_catalyst_sdwan_manager-20.12.json
@@ -0,0 +1 @@
+{"openapi":"3.0.1","info":{"title":"Cisco SD-WAN vManage API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"20.12","x-vendor-api-version":"2.0.0"},"servers":[{"url":"/dataservice"}],"paths":{"/aas/init":{"post":{"tags":["SDWAN as a Platform - Initialize"],"summary":"Initialize SDWAN as a Platform","description":"Initialize SDWAN as a Platform","operationId":"initAasProperties","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitBlob"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/aas/reset-credentials/{credType}":{"post":{"tags":["SDWAN as a Platform - Manage Credentials"],"summary":"SDWAN as a Platform - Manage Credentials","description":"SDWAN as a Platform - Manage Credentials","operationId":"resetCredentials","parameters":[{"name":"credType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/accesstoken/{regionBaseUri}/{clientId}":{"get":{"tags":["Monitoring - SecureX Integration"],"description":"Get Access Token for SecureX Ribbon","operationId":"getSecureXAccessToken","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/aaa":{"get":{"tags":["Administration - User and Group"],"description":"Get aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getAaaConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aaa"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Administration - User and Group"],"description":"Update aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"updateAaaConfig","requestBody":{"description":"aaa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aaa"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"createAaaConfig","requestBody":{"description":"aaa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aaa"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"deleteAaaConfig","responses":{"200":{"description":"Ok"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/cologroup":{"get":{"tags":["Administration - User and Group"],"description":"Get COLO groups","operationId":"getColoGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Colocation groups":{"description":"Colocation groups","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Manage Users-read,Manage Users-write"},"post":{"tags":["Administration - User and Group"],"description":"Add COLO group","operationId":"createColoGroup","requestBody":{"description":"Colocation group","content":{"application/json":{"schema":{"type":"object"},"examples":{"Colocation group":{"description":"Colocation group","value":{"rbacRequired":true,"userGroupName":"usergrp1","name":"cologrp1","description":"Colocation Group One"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Manage Users-write"}},"/admin/cologroup/{id}":{"put":{"tags":["Administration - User and Group"],"description":"Update COLO group","operationId":"editColoGroup","parameters":[{"name":"id","in":"path","description":"Colocation group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Colocation group","content":{"application/json":{"schema":{"type":"object"},"examples":{"Colocation group":{"description":"Colocation group","value":{"rbacRequired":true,"userGroupName":"usergrp1","name":"cologrp2","description":"Colocation Group Two","coloGroupId":"f02e27c3-b30b-4425-93a3-e0c0207f8c23"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Manage Users-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete COLO group","operationId":"deleteColoGroup","parameters":[{"name":"id","in":"path","description":"Colocation group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Manage Users-write"}},"/admin/events/{sseSessionId}":{"get":{"operationId":"listenAuthEvents","parameters":[{"name":"sseSessionId","in":"path","description":"sse session Id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/event-stream":{}}}}}},"/admin/radius":{"get":{"tags":["Administration - User and Group"],"description":"Get radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getRadiusConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Administration - User and Group"],"description":"Update radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"updateRadiusConfig","requestBody":{"description":"radius","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"createRadiusConfig","requestBody":{"description":"radius","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"deleteRadiusConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/resourcegroup":{"get":{"tags":["Administration - User and Group"],"description":"Get all groups","operationId":"getAllGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceGroup"}},"examples":{"Group":{"description":"Group","value":"[ {\"name\": \"west\", \"desc\": \"US - West coast\", \"siteIds\": [100, 110, 120]}, {\"name\": \"east\", \"desc\": \"US - East coast\"}, \"siteIds\": [300, 310, 320] ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create a group","operationId":"createResourceGroup","requestBody":{"description":"Create a group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"},"examples":{"Group":{"description":"Group","value":{"name":"west","desc":"US - West coast","siteIds":[110,120,130]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/resourcegroup/switch":{"post":{"tags":["Administration - User and Group"],"description":"Global netadmin switches to a different resource group view","operationId":"switchResourceGroup","requestBody":{"description":"Global netadmin switches to a different resource group view","content":{"application/json":{"schema":{"type":"object"},"examples":{"switchGroupsDetails":{"description":"switchGroupsDetails","value":{"resourceGroupName":"west"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VResourceGroupName model":{"description":"VResourceGroupName model","value":"{\n \u201cVResourceGroupName\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/resourcegroup/{groupId}":{"put":{"tags":["Administration - User and Group"],"description":"Update a group","operationId":"updateResourceGroup","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update group description","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceGroup"},"examples":{"Group":{"description":"Group","value":{"name":"west","desc":"US - West coast","siteIds":[110,120,130]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete a group","operationId":"deleteResourceGroup","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/tacacs":{"get":{"tags":["Administration - User and Group"],"description":"Get tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getTacacsConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Administration - User and Group"],"description":"Update tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"updateTacacsConfig","requestBody":{"description":"tacacs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"createTacacsConfig","requestBody":{"description":"tacacs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"deleteTacacsConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/user":{"get":{"tags":["Administration - User and Group"],"description":"Get all users","operationId":"findUsers_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"User":{"description":"User","value":[]}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"},"post":{"tags":["Administration - User and Group"],"description":"Create a user","operationId":"createUser_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":"{\n \"group\":[\n \"demogrp\"\n ],\n \"description\":\"Demo User\",\n \"userName\":\"demouser\",\n \"password\":\"password\"\n \"locale\":\"en_US\"\n \"resGroupName\":\"global\"\n}"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/activeSessions":{"get":{"tags":["Administration - User and Group"],"description":"Get active sessions","operationId":"getActiveSessions_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"All active sessions for this tenant (except for the requesting session)":{"description":"All active sessions for this tenant (except for the requesting session)","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read"}},"/admin/user/admin/password":{"post":{"tags":["Administration - User and Group"],"description":"Update admin default password","operationId":"updateAdminPassword_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/user/lockUser/{userName}":{"put":{"tags":["Administration - User and Group"],"description":"Lock a user account","operationId":"lockUser","parameters":[{"name":"userName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Lock user account":{"description":"Lock user account","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/password/validate":{"post":{"tags":["Administration - User and Group"],"description":"Validate user password","operationId":"validatePassword_1","requestBody":{"description":"User password","content":{"application/json":{"schema":{"type":"object"},"examples":{"User password":{"description":"User password","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read"}},"/admin/user/password/{userName}":{"put":{"tags":["Administration - User and Group"],"description":"Update user password","operationId":"updatePassword_1","parameters":[{"name":"userName","in":"path","description":"User name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/profile/locale":{"put":{"tags":["Administration - User and Group"],"description":"Update profile locale","operationId":"updateProfileLocale_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/profile/password":{"put":{"tags":["Administration - User and Group"],"description":"Update profile password","operationId":"updateProfilePassword_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/removeSessions":{"delete":{"tags":["Administration - User and Group"],"description":"Remove sessions","operationId":"removeSessions_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"List of sessions":{"description":"List of sessions","value":[]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/reset":{"post":{"tags":["Administration - User and Group"],"description":"Unlock a user","operationId":"resetUser_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/resourceGroupName":{"get":{"tags":["Administration - User and Group"],"description":"Get the name of the resource group associated with the current logged in user","operationId":"resourceGroupName_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"resourceGroupDetails":{"description":"resourceGroupDetails","value":{"resourceGroupName":"global","effectiveResourceGroupName":"west"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage LI Users-read,Device Monitoring-read,System-read"}},"/admin/user/role":{"get":{"tags":["Administration - User and Group"],"description":"Check whether a user has admin role","operationId":"findUserRole_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"User has admin role":{"description":"User has admin role","value":"{isAdmin: true}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write,Device Monitoring-read,Device Monitoring-write,System-read,System-write"}},"/admin/user/userAuthType":{"get":{"tags":["Administration - User and Group"],"description":"Find user authentication type, whether it is SAML enabled","operationId":"findUserAuthType_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"User authentication type":{"description":"User authentication type","value":"{userAuthType: SAML}"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Device Monitoring-read,System-read"}},"/admin/user/{userName}":{"put":{"tags":["Administration - User and Group"],"description":"Update user","operationId":"updateUser_1","parameters":[{"name":"userName","in":"path","description":"User name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{"userName":"demouser","password":"newpasswd"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete user","operationId":"deleteUser_1","parameters":[{"name":"userName","in":"path","description":"User name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/usergroup":{"get":{"tags":["Administration - User and Group"],"description":"Get all user groups","operationId":"findUserGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"User groups":{"description":"User groups","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"},"post":{"tags":["Administration - User and Group"],"description":"Create user group","operationId":"createUserGroup","requestBody":{"description":"User group","content":{"application/json":{"schema":{"type":"object"},"examples":{"User group":{"description":"User group","value":{"groupName":"demogrp","tasks":[{"feature":"Interface","read":true,"enabled":true,"write":true},{"feature":"Routing","read":true,"enabled":true,"write":true},{"feature":"Security","read":true,"enabled":true,"write":true},{"feature":"System","read":true,"enabled":true,"write":true},{"feature":"Policy","read":true,"enabled":true,"write":true},{"feature":"Alarms","read":true,"enabled":true,"write":true},{"feature":"Audit Log","read":true,"enabled":true,"write":true},{"feature":"Device Monitoring","read":true,"enabled":true,"write":true},{"feature":"RBAC VPN","read":true,"enabled":true,"write":true},{"feature":"Certificates","read":true,"enabled":true,"write":true},{"feature":"Device Inventory","read":true,"enabled":true,"write":true},{"feature":"Template Configuration","read":true,"enabled":true,"write":true},{"feature":"Template Deploy","read":true,"enabled":true,"write":true},{"feature":"Policy Configuration","read":true,"enabled":true,"write":true},{"feature":"Security Policy Configuration","read":true,"enabled":true,"write":true},{"feature":"Policy Deploy","read":true,"enabled":true,"write":true},{"feature":"Cloud OnRamp","read":true,"enabled":true,"write":true},{"feature":"Software Upgrade","read":true,"enabled":true,"write":true},{"feature":"Device Reboot","read":true,"enabled":true,"write":true},{"feature":"Manage Users","read":true,"enabled":true,"write":true},{"feature":"Tools","read":true,"enabled":true,"write":true},{"feature":"Settings","read":true,"enabled":true,"write":true},{"feature":"Cluster","read":true,"enabled":true,"write":true},{"feature":"Colocation","read":true,"enabled":true,"write":true},{"feature":"vAnalytics","read":true,"enabled":true,"write":true},{"feature":"Events","read":true,"enabled":true,"write":true}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/usergroup/definition":{"get":{"tags":["Administration - User and Group"],"description":"Get user groups in a grid table","operationId":"createGroupGridColumns","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"User group in grid table":{"description":"User group in grid table","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"}},"/admin/usergroup/keyvalue":{"get":{"tags":["Administration - User and Group"],"description":"Get user groups as key value map","operationId":"findUserGroupsAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Map of user groups":{"description":"Map of user groups","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"}},"/admin/usergroup/{userGroupId}":{"put":{"tags":["Administration - User and Group"],"description":"Update user group","operationId":"updateUserGroup","parameters":[{"name":"userGroupId","in":"path","description":"User group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User group","content":{"application/json":{"schema":{"type":"object"},"examples":{"User group":{"description":"User group","value":{"groupName":"demogrp","tasks":[{"feature":"Policy","enabled":true,"read":true,"write":false},{"feature":"Routing","enabled":true,"read":true,"write":false},{"feature":"Security","enabled":true,"read":true,"write":false},{"feature":"Interface","enabled":true,"read":true,"write":false},{"feature":"System","enabled":true,"read":true,"write":false},{"feature":"Alarms","enabled":true,"read":true,"write":false},{"feature":"Audit Log","enabled":true,"read":true,"write":false},{"feature":"Certificates","enabled":true,"read":true,"write":false},{"feature":"Cloud OnRamp","enabled":true,"read":true,"write":false},{"feature":"Cluster","enabled":true,"read":true,"write":false},{"feature":"Colocation","enabled":true,"read":true,"write":false},{"feature":"Device Inventory","enabled":true,"read":true,"write":false},{"feature":"Device Monitoring","enabled":true,"read":true,"write":false},{"feature":"Device Reboot","enabled":true,"read":true,"write":false},{"feature":"Events","enabled":true,"read":true,"write":false},{"feature":"Manage Users","enabled":true,"read":true,"write":false},{"feature":"Policy Configuration","enabled":true,"read":true,"write":false},{"feature":"Policy Deploy","enabled":true,"read":true,"write":false},{"feature":"RBAC VPN","enabled":true,"read":true,"write":false},{"feature":"Security Policy Configuration","enabled":true,"read":true,"write":false},{"feature":"Settings","enabled":true,"read":true,"write":false},{"feature":"Software Upgrade","enabled":true,"read":true,"write":false},{"feature":"Template Configuration","enabled":true,"read":true,"write":false},{"feature":"Template Deploy","enabled":true,"read":true,"write":false},{"feature":"Tools","enabled":true,"read":true,"write":false},{"feature":"vAnalytics","enabled":true,"read":true,"write":false}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete user group","operationId":"deleteUserGroup","parameters":[{"name":"userGroupId","in":"path","description":"User group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/vpngroup":{"get":{"tags":["Administration - User and Group"],"description":"Get VPN groups","operationId":"getVpnGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN groups":{"description":"VPN groups","value":{"data":[{"name":"VPNGroup","vpnGroupId":"34bb9532-60bd-464b-bb35-393f7bac5e56","description":"Sample","owner":"admin","lastUpdated":1590190679126,"segments":["c952c18b-30b3-4f0b-b985-494693d7adfb"],"hasRbacGroup":true,"userGroupName":"demo"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-read,RBAC VPN-write"},"post":{"tags":["Administration - User and Group"],"description":"Add VPN group","operationId":"createVpnGroup","requestBody":{"description":"VPN group","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPN group":{"description":"VPN group","value":{"rbacRequired":true,"userGroupName":"demo","name":"VPNGroup","description":"Sample","segments":["c952c18b-30b3-4f0b-b985-494693d7adfb"]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-write"}},"/admin/vpngroup/{id}":{"put":{"tags":["Administration - User and Group"],"description":"Update VPN group","operationId":"editVpnGroup","parameters":[{"name":"id","in":"path","description":"VPN group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN group","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPN group":{"description":"VPN group","value":{"rbacRequired":true,"userGroupName":"demo","name":"VPNGroup","description":"Sample","vpnGroupId":"34bb9532-60bd-464b-bb35-393f7bac5e56","segments":["c952c18b-30b3-4f0b-b985-494693d7adfb","64b30b74-08e2-4b4b-81ca-d019c7e452d5"]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete VPN group","operationId":"deleteVpnGroup","parameters":[{"name":"id","in":"path","description":"VPN group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-write"}},"/alarms":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarms for last 30min if vManage query is not specified","operationId":"getAlarms","parameters":[{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Gets lists of alarms along with the raw alarm data of each.","operationId":"getRawAlarmData","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"site-id","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Alarm query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Alarm query string":{"description":"Alarm query string","value":{"query":{"condition":"AND","rules":[{"field":"active","type":"boolean","value":["true"],"operator":"equal"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/aggregation":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Gets aggregated list of alarms along with the raw alarm data of each aggregation","operationId":"getAlarmAggregationData","parameters":[{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Gets aggregated list of alarms along with the raw alarm data of each aggregation","operationId":"getPostAlarmAggregationData","requestBody":{"description":"Input query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Input query":{"description":"Input query","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["24"],"operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"severity","order":"asc","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/clear":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Clears specific stale alarm","operationId":"clearStaleAlarm","requestBody":{"description":"alarm_uuid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmsClearBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmClearResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/count":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get count of the alarms which are active and acknowledged by the user","operationId":"getNonViewedActiveAlarmsCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmCountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get count of the alarms as per query passed","operationId":"getCount_1","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Alarm query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Alarm query string":{"description":"Alarm query string","value":{"query":{"condition":"AND","rules":[{"field":"active","type":"boolean","value":["true"],"operator":"equal"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmCountPostResponse"}}}}},"x-roles-required":"Alarms-read"}},"/alarms/disabled":{"get":{"tags":["Monitoring - Alarms Details"],"description":"List all disabled alarms","operationId":"listDisabledAlarm","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisabledAlarmDetails"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Enable/Disable a specific alarm","operationId":"disableEnableAlarm","parameters":[{"name":"eventName","in":"query","required":true,"schema":{"type":"string"}},{"name":"disable","in":"query","required":true,"schema":{"type":"boolean"}},{"name":"time","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"alarm config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmDisableRequestBody"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/doccount":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get response count of a query","operationId":"getCount_2","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get response count of a query","operationId":"getCountPost_1","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/dump":{"post":{"tags":["Monitoring - Alarms Details"],"description":"dump correlation engine server data","operationId":"dumpCorrelationEngineData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/fields":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get fields and type","operationId":"getStatDataFields_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/link-state-alarm":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get configuration for link-state alarm","operationId":"getLinkStateAlarmConfig","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Enable/Disable a specific link-state alarm","operationId":"enableDisableLinkStateAlarm","parameters":[{"name":"linkName","in":"query","required":true,"schema":{"type":"string"}},{"name":"enable","in":"query","required":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"alarm config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkStateAlarmRequestBody"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/markallasviewed":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Mark all larms as acknowledged by the user","operationId":"markAllAlarmsAsViewed","requestBody":{"description":"Alarm query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Alarm query string":{"description":"Alarm query string","value":{"query":{"condition":"AND","rules":[{"field":"active","type":"boolean","value":["true"],"operator":"equal"}]}}},"Alarm empty query string":{"description":"Alarm empty query string","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/markviewed":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Mark alarms as acknowledged by the user","operationId":"markAlarmsAsViewed","requestBody":{"description":"List of alarms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmsMarkviewedBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmCountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/master":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get master manager state","operationId":"getMasterManagerState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/notviewed":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarms which are active and acknowledged by the user","operationId":"getNonViewedAlarms","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/page":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get paginated alarm raw data","operationId":"getStatBulkAlarmRawData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"scrollId","in":"query","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get paginated alarm raw data","operationId":"getPostStatBulkAlarmRawData","parameters":[{"name":"scrollId","in":"query","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Alarm query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Alarm query string":{"description":"Alarm query string","value":{"query":{"field":"active","type":"boolean","value":["true"],"operator":"equal"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/purgefrequency":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Set alarm purge timer","operationId":"setPeriodicPurgeTimer","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurgeFrequency"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/query/fields":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get query fields","operationId":"getStatQueryFields_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/query/input":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get query configuration","operationId":"createAlarmQueryConfig","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmQueryInputResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/reset":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Reset correlation engine data","operationId":"correlAntiEntropy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/alarms/restart":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Restart correlation engine","operationId":"restartCorrelationEngine","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/alarms/rulenamedisplay/keyvalue":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Gets alarm type as key value pair","operationId":"getAlarmTypesAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/severity":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm by severity","operationId":"getAlarmsBySeverity","parameters":[{"name":"severity-level","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"deviceId","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/severity/summary":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm severity histogram","operationId":"getAlarmSeverityCustomHistogram","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeveritySummary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/severitymappings":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Gets alarm severity mappings","operationId":"getAlarmSeverityMappings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmSeverityMappingResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/starttracking/{testName}":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Start tracking events","operationId":"startTracking","parameters":[{"name":"testName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/stats":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm statistics","operationId":"getStats","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmStatsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/stoptracking/{testName}":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Stop tracking events","operationId":"stopTracking","parameters":[{"name":"testName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/topic":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get device topic state","operationId":"getDeviceTopic","parameters":[{"name":"ip","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmTopic"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/topn":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Returns top-n alarm count based on given query","operationId":"getTopN","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Input query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Input query":{"description":"Input query","value":{"query":{"field":"type","condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}],"size":2}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated alarms with its raw data":{"description":"Aggregated alarms with its raw data","value":{"data":[{"count":281,"devices":[{"host_name":"vm16","system_ip":"172.16.255.26","count":100},{"host_name":"vm12","system_ip":"172.16.255.22","count":181}],"type":"cpu-usage"},{"count":3,"devices":[{"host_name":"vm5","system_ip":"172.16.255.15","count":3}],"type":"node_down"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/uuid/{alarm_uuid}":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm detail","operationId":"getAlarmDetails","parameters":[{"name":"alarm_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/app-registry/applications":{"get":{"tags":["Configuration - Policy App Registry"],"description":"Get All the App for the given conditions","operationId":"getAppList","parameters":[{"name":"trafficClass","in":"query","schema":{"type":"string","enum":["bulk-data","transactional-data","ops-admin-mgmt","multimedia-conferencing","multimedia-streaming","voip-telephony","network-control","broadcast-video","real-time-interactive","signaling"]}},{"name":"businessRelevance","in":"query","schema":{"type":"string","enum":["business-relevant","business-irrelevant","default"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Policy App Registry"],"description":"Edit App Details","operationId":"editAppDetails","requestBody":{"content":{"*/*":{"schema":{"type":"array","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"items":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/applications/{appId}":{"put":{"tags":["Configuration - Policy App Registry"],"description":"Edit App Details","operationId":"editAppDetailsWithUUID","parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadItems"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log","description":"Get stat raw data","operationId":"getStatDataRawAuditLogData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log with post action","description":"Get raw property data with post action","operationId":"getRawPropertyData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogQueryString"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/aggregation":{"get":{"tags":["Administration - Audit Log"],"summary":"Get raw property data aggregated","description":"Get raw property data aggregated","operationId":"getPropertyAggregationData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogAggregation"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get raw property data aggregated with post action","description":"Get raw property data aggregated with post action","operationId":"getPostPropertyAggregationData","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditlogAggregationBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogAggregation"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/doccount":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log Doc count","description":"Get response count of a query","operationId":"getCount","parameters":[{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogDoccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log Doc count","description":"Get response count of a query","operationId":"getCountPost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditlogDoccountBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogDoccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/fields":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log fields","description":"Get fields and type","operationId":"getStatDataFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatDataFieldArray"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/page":{"get":{"tags":["Administration - Audit Log"],"summary":"Get raw property data in bulk","description":"Get raw property data in bulk","operationId":"getStatBulkRawPropertyData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get raw property data in bulk with post action","description":"Get raw property data in bulk with post action","operationId":"getPostStatBulkRawPropertyData","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogQueryString"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/query/fields":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log query fields","description":"Get query fields","operationId":"getStatQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatQueryFieldArray"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/severity":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log","description":"Get audit logs for last 3 hours","operationId":"generateAuditLog","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string"}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogBySeverity"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/severity/summary":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log Histogram","description":"Get audit log severity histogram","operationId":"getAuditSeverityCustomHistogram","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/backupinfo":{"delete":{"tags":["Scheduled Backup Restore"],"summary":"Deletes a local database operation","description":"Delete all or a specific backup file stored in vManage","operationId":"deleteSchduledBackup","parameters":[{"name":"taskId","in":"query","schema":{"type":"string"}},{"name":"backupInfoId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/backupinfo/{localBackupInfoId}":{"get":{"tags":["Scheduled Backup Restore"],"summary":"Get details of database backup task for given localBackupInfo object","description":"Get a localBackupInfo record by localBackupInfoId","operationId":"getLocalBackupInfo","parameters":[{"name":"localBackupInfoId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalBackupInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}}},"/backup/download/{path}":{"get":{"tags":["Scheduled Backup Restore"],"summary":"Download the database backup file for the given backup file path","description":"Download a Backup File that is already stored in vManage","operationId":"downloadBackupFile","parameters":[{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/export":{"post":{"tags":["Scheduled Backup Restore"],"summary":"Issues database backup request","description":"Trigger a backup of configuration database and statstics database and store it in vManage","operationId":"exportBackup","requestBody":{"description":"backup request information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalBackupInfo"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/list":{"get":{"tags":["Scheduled Backup Restore"],"summary":"Get list of all database backup requests","description":"List all backup files of a tenant stored in vManage","operationId":"listBackup","parameters":[{"name":"size","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalBackupListResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/cdna/sense/{tag}":{"get":{"tags":["System - Cloud Service CDNA"],"description":"Get Sense Service","operationId":"getCdnaSenseService","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnaSenseResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/cdna/server":{"get":{"tags":["System - Cloud Service CDNA"],"description":"Get CDNA Server Details","operationId":"getCdnaServer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollOTPResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["System - Cloud Service CDNA"],"description":"Enroll CDNA Server with OTP","operationId":"enrollCdnaServer","requestBody":{"description":"CDNA OTP Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollOTPSettings"}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollOTPResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["System - Cloud Service CDNA"],"description":"Delete CDNA Server Details","operationId":"deleteCdnaServer","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/certdetails":{"post":{"tags":["Certificate Management - Device"],"summary":"get certificaate details","description":"get certificaate details","operationId":"getCertDetails","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/controller/bulkcsr":{"post":{"tags":["Certificate Management - Device"],"summary":"Generate CSR for all controller","description":"Generate CSR for all controller","operationId":"generateCSRforAllController","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/controller/certstatus":{"get":{"tags":["Certificate Management - Device"],"summary":"invalidate the device","description":"invalidate the device","operationId":"getControllerCertStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/csr/details":{"get":{"tags":["Certificate Management - Device"],"summary":"Get CSR detail view","description":"Get CSR detail view","operationId":"getCSRViewRightMenus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/device/details":{"get":{"tags":["Certificate Management - Device"],"summary":"Get device detail view","description":"Get device detail view","operationId":"getDeviceViewRightMenus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/device/invalidate":{"post":{"tags":["Certificate Management - Device"],"summary":"invalidate the device","description":"invalidate the device","operationId":"invalidateDevice","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/device/list":{"get":{"tags":["Certificate Management - Device"],"summary":"get device list","description":"get device list","operationId":"getDevicesList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/device/stage":{"post":{"tags":["Certificate Management - Device"],"summary":"Stop data traffic to device","description":"Stop data traffic to device","operationId":"stageDevice","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/forcesync/rootCert":{"post":{"tags":["Certificate Management - Device"],"summary":"force Sync RootCert to all devices","description":"force Sync RootCert to all devices","operationId":"forceSyncRootCert","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/generate/csr":{"post":{"tags":["Certificate Management - Device"],"summary":"generate CSR on target device","description":"get certificaate details","operationId":"generateCSR","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/generate/enterprise/csr/vedge":{"post":{"tags":["Certificate Management - Device"],"summary":"generate CSR on hardware WAN edge device","description":"generate CSR on hardware WAN edge device","operationId":"generateEnterpriseCSR","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/generate/wanedge/csr":{"post":{"tags":["Certificate Management - Device"],"summary":"generate CSR on WAN edge device","description":"generate CSR on WAN edge device","operationId":"generateEdgeDeviceCSR","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/install/signedCert":{"post":{"tags":["Certificate Management - Device"],"summary":"install Certificate","description":"install Certificate","operationId":"installCertificate","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/jks":{"put":{"tags":["Certificate Management - Device"],"summary":"update JKS","description":"update JKS","operationId":"updateJks","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/list/status":{"get":{"tags":["Certificate Management - Device"],"summary":"get certificate data","description":"get certificate data","operationId":"getListStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/mthub/list":{"get":{"tags":["Certificate Management - Device"],"summary":"vSmart Mthub list","description":"vSmart Mthub list","operationId":"setvSmartMtHubList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/record":{"get":{"tags":["Certificate Management - Device"],"summary":"get device certificate data","description":"get device certificate data","operationId":"getCertificateData","parameters":[{"name":"requestID","in":"query","schema":{"type":"string"}},{"name":"dataObject","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/reset/rsa":{"post":{"tags":["Certificate Management - Device"],"summary":"resetRSA for controllers","description":"resetRSA for controllers","operationId":"resetRSA","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/revoke/enterprise/certificate":{"post":{"tags":["Certificate Management - Device"],"summary":"Revoking enterprise CSR for hardware vEdge","description":"Revoking enterprise CSR for hardware vEdge","operationId":"decommissionEnterpriseCSRForVedge","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/rootcertchains":{"get":{"tags":["Certificate Management - Device"],"summary":"get root cert chain","description":"get root cert chain in the system","operationId":"getRootCertChains","parameters":[{"name":"action","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Certificate Management - Device"],"summary":"update root cert chain","description":"save root cert chain in the system","operationId":"saveRootCertChain","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/rootcertificate":{"get":{"tags":["Certificate Management - Device"],"summary":"Get device root certificate detail view","description":"Get device root certificate detail view","operationId":"getRootCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/save/vedge/list":{"post":{"tags":["Certificate Management - Device"],"summary":"change VedgeList Validity","description":"change VedgeList Validity","operationId":"saveVEdgeList","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/stats/detail":{"get":{"tags":["Certificate Management - Device"],"summary":"Get certificate details","description":"Get certificate details","operationId":"getCertificateDetail","parameters":[{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/stats/summary":{"get":{"tags":["Certificate Management - Device"],"summary":"Get certificate expiration status","description":"Get certificate expiration status","operationId":"getCertificateStats","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/syncvbond":{"get":{"tags":["Certificate Management - Device"],"summary":"sync vManage UUID to all vBond","description":"sync vManage UUID to all vBond","operationId":"syncvBond","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/tokengeneratedlist":{"get":{"tags":["Certificate Management - Device"],"summary":"get token generated list","description":"get token generated list","operationId":"getTokenList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vedge":{"get":{"tags":["Certificate Management - Device"],"summary":"get device installed cert","description":"get device installed cert","operationId":"getInstalledCert","parameters":[{"name":"uuid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstalledCerts"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vedge/csr":{"get":{"tags":["Certificate Management - Device"],"summary":"get device CSR","description":"get device CSR","operationId":"getvEdgeCSR","parameters":[{"name":"uuid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vedge/list":{"get":{"tags":["Certificate Management - Device"],"summary":"get vEdge list","description":"get vEdge list","operationId":"getvEdgeList","parameters":[{"name":"model","in":"query","schema":{"type":"string"}},{"name":"state","in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Certificate Management - Device"],"summary":"Save vEdge list (send to controller)","description":"Save vEdge list (send to controller)","operationId":"setvEdgeList","parameters":[{"name":"action","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/view":{"get":{"tags":["Certificate Management - Device"],"summary":"Get certificate UI view","description":"Get certificate UI view","operationId":"getView","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vmanage/selfsignedcert":{"get":{"tags":["Certificate Management - Device"],"summary":"get vManage self signed cert","description":"get vManage self signed cert","operationId":"getSelfSignedCert","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vsmart/list":{"get":{"tags":["Certificate Management - Device"],"summary":"get vSmart list","description":"get vSmart list","operationId":"getvSmartList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Certificate Management - Device"],"summary":"save vSmart List(handleSendToVbond)","description":"save vSmart List(handleSendToVbond)","operationId":"setvSmartList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/{uuid}":{"delete":{"tags":["Certificate Management - Device"],"summary":"invalid device","description":"invalid device","operationId":"deleteConfiguration","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"replaceController","in":"query","schema":{"type":"boolean"}},{"name":"deviceId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/cloudservices/accesstoken":{"get":{"tags":["System - Cloud Service"],"operationId":"getAccessTokenforDevice","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cloudservices/app/webex":{"put":{"tags":["Configuration - CloudExpress"],"description":"Day N- Update Webex App","operationId":"enableWebex_1","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"},"post":{"tags":["Configuration - CloudExpress"],"description":"Add Webex App","operationId":"enableWebex","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"},"delete":{"tags":["Configuration - CloudExpress"],"description":"deleteWebexPrefixLists","operationId":"deleteWebexPrefixLists","requestBody":{"description":"TMP-Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"}},"/cloudservices/authtoken":{"post":{"tags":["System - Cloud Service"],"description":"Get Azure token","operationId":"getAzureToken","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry state":{"description":"Telemetry state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,default"}},"/cloudservices/connect":{"get":{"tags":["System - Cloud Service"],"description":"Telemetry Opt In","operationId":"connect","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry Opt In":{"description":"Telemetry Opt In","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,default"}},"/cloudservices/credentials":{"get":{"tags":["System - Cloud Service"],"description":"Get cloud service credentials","operationId":"getCloudCredentials","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service credentials":{"description":"Cloud service credentials","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,default"},"post":{"tags":["System - Cloud Service"],"description":"Get cloud service settings","operationId":"addCloudCredentials","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service setting":{"description":"Cloud service setting","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca,CXP-write,default"}},"/cloudservices/devicecode":{"post":{"tags":["System - Cloud Service"],"description":"Get Azure device code","operationId":"getDeviceCode","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry state":{"description":"Telemetry state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,default"}},"/cloudservices/m365/preferredpath":{"post":{"tags":["System - Cloud Service"],"description":"Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getO365PreferredPathFromVAnalytics","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cloudservices/staging":{"get":{"tags":["System - Cloud Service"],"description":"Check if testbed or production","operationId":"isStaging","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Environment":{"description":"Environment","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/cloudservices/telemetry":{"get":{"tags":["System - Cloud Service"],"description":"Get Telemetry state","operationId":"getTelemetryState","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry state":{"description":"Telemetry state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,default"}},"/cloudservices/telemetry/optin":{"put":{"tags":["System - Cloud Service"],"description":"Telemetry Opt In","operationId":"optIn","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry Opt In":{"description":"Telemetry Opt In","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,default"}},"/cloudservices/telemetry/optout":{"delete":{"tags":["System - Cloud Service"],"description":"Telemetry Opt Out","operationId":"optOut","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry Opt Out":{"description":"Telemetry Opt Out","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,CXP-read,CXP-write,default,"}},"/clusterManagement/clusterLocked":{"get":{"tags":["Cluster Management"],"description":"Check whether cluster is locked
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"checkIfClusterLocked","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster lock":{"description":"Cluster lock","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/clusterworkflow/version":{"get":{"tags":["Cluster Management"],"description":"List vManages in the cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getClusterWorkflowVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"clusterV2Enabled":{"description":"clusterV2Enabled","value":"True"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/configure":{"post":{"tags":["Cluster Management"],"description":"Configure vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"configureVmanage","requestBody":{"description":"vManage server config","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage server config":{"description":"vManage server config","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/connectedDevices/{vmanageIP}":{"get":{"tags":["Cluster Management"],"description":"Get connected device for vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getConnectedDevices","parameters":[{"name":"vmanageIP","in":"path","description":"vManage IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/health/details":{"get":{"tags":["Cluster Management"],"description":"Get cluster health check details
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"healthDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster health check detail":{"description":"Cluster health check detail","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/health/status":{"get":{"tags":["Cluster Management"],"description":"Get cluster health check details
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"healthStatusInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster health status info":{"description":"Cluster health status info","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/health/summary":{"get":{"tags":["Cluster Management"],"description":"Get cluster health check summary
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"healthSummary","parameters":[{"name":"isCached","in":"query","description":"Flag to enable cached result","schema":{"type":"boolean","default":false}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster health check summary":{"description":"Cluster health check summary","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/iplist/{vmanageID}":{"get":{"tags":["Cluster Management"],"description":"Get configured IP addresses
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getConfiguredIPList","parameters":[{"name":"vmanageID","in":"path","description":"vManage Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vManage IP list":{"description":"vManage IP list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/isready":{"get":{"tags":["Cluster Management"],"description":"Is cluster ready
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"isClusterReady","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster state":{"description":"Cluster state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/list":{"get":{"tags":["Cluster Management"],"description":"List vManages in the cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"listVmanages","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vManage server":{"description":"vManage server","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/nodeProperties":{"get":{"tags":["Cluster Management"],"description":"Get properties of vManage being added to cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"nodeProperties","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster properties":{"description":"vManage cluster properties","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/remove":{"post":{"tags":["Cluster Management"],"description":"Remove vManage from cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"removeVmanage","requestBody":{"description":"vManage server info","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage server info":{"description":"vManage server info","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/replicateAndRebalance":{"put":{"tags":["Cluster Management"],"description":"Initiate replication and rebalance of kafka topics
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"performReplicationAndRebalanceOfKafkaPartitions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Kafka topics rebalance status":{"description":"Kafka topics rebalance status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/setup":{"put":{"tags":["Cluster Management"],"description":"Update vManage cluster info
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editVmanage","requestBody":{"description":"vManage cluster config","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster config":{"description":"vManage cluster config","value":"{\n \"vmanageID\":\"0\",\n \"deviceIP\u201d:\u201d10.0.1.38\u201d,\n \"username\":\"admin\",\n \"password\u201d:\u201dpassword\u201d,\n \"persona\":\"COMPUTE_AND_DATA\",\n \"services\":{\n \"container-manager\":{\n \"server\":false\n }\n }\n}"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Cluster Management"],"description":"Add vManage to cluster","operationId":"addVmanage","requestBody":{"description":"vManage cluster config","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster config":{"description":"vManage cluster config","value":{"deviceIP":"10.0.1.200","username":"admin","password":"password","genCSR":false,"persona":"COMPUTE_AND_DATA","services":{"container-manager":{"server":false}}}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/tenancy/mode":{"get":{"tags":["Cluster Management"],"description":"Get vManage tenancy mode
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenancyMode","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage tenancy mode":{"description":"vManage tenancy mode","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Cluster Management"],"description":"Update vManage tenancy mode","operationId":"setTenancyMode","requestBody":{"description":"Tenancy mode setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenancy mode":{"description":"Tenancy mode","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/tenantList":{"get":{"tags":["Cluster Management"],"description":"Get tenant list
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantsList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Tenant":{"description":"Tenant","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/userCreds":{"post":{"tags":["Cluster Management"],"description":"Add or update user credentials for cluster operations
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"addOrUpdateUserCredentials","requestBody":{"description":"User credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"User credential":{"description":"User credential","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/vManage/details/{vmanageIP}":{"get":{"tags":["Cluster Management"],"description":"Get vManage detail
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getVManageDetails","parameters":[{"name":"vmanageIP","in":"path","description":"vManage IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage detail":{"description":"vManage detail","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/{tenantId}/connectedDevices/{vmanageIP}":{"get":{"tags":["Cluster Management"],"description":"Get connected device for vManage for a tenant
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getConnectedDevicesPerTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}},{"name":"vmanageIP","in":"path","description":"vManage IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/colocation/cluster":{"get":{"tags":["Colocation"],"description":"Get details of all existing Clusters","operationId":"getCloudDockClusterDetail","parameters":[{"name":"clusterName","in":"query","description":"Cluster name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Clouddock cluster":{"description":"Clouddock cluster","value":{"data":[{"managementMask":"31","ccmIpAddress":"1.1.1.1/31","ccmdeviceName":"ccm-Cluster1","activeState":"INCOMPLETE","maxHaNetNumber":1,"description":"Description for Cluster1","serviceChainVlanPool":"100","clusterId":"b1201e77-3987-480e-b0d3-a2c972e59a33","ipPoolName":"Cluster1_ResourcePool","lastUpdated":1590354925245,"@rid":3268,"systemIpPool":"1.1.1.1","vnfNetworkPool":"1.1.1.1","clusterName":"Cluster1","clusterState":"INACTIVE","updatedBy":"admin","IpPoolDescription":"Description for Cluster1_ResourcePool","activeStateInternal":"INCOMPLETE","ccmdeviceTemplateId":"037a8893-3f35-4305-90a1-da9a30159586","vnfMgmtPool":"1.1.1.1","subnetMask":"255.255.255.254","managementGateway":"1.1.1.1","serviceChainCount":"0","designStatus":"IN_PROGRESS","siteId":"100","cspQueue":",,","location":"us-west-1","csp":[{"name":"CSP_Cluster13","isCCMHosted":false,"type":"csp","uuid":"","deviceStatus":"DOWN"},{"name":"CSP_Cluster11","isCCMHosted":false,"type":"csp","uuid":"","deviceStatus":"DOWN"},{"name":"CSP_Cluster12","isCCMHosted":false,"type":"csp","uuid":"","deviceStatus":"DOWN"}],"switch":[{"name":"Switch1","type":"switch","uuid":"","deviceStatus":"--"},{"name":"Switch2","type":"switch","uuid":"","deviceStatus":"--"}],"template":[{"templateType":"clouddock_aaa","templateMinVersion":"15.0.0","deviceType":["vedge-nfvis-CSP2100"],"lastUpdatedBy":"admin","editedTemplateDefinition":"{\"authentication\":{\"users\":{\"user\":{\"vipType\":\"constant\",\"vipValue\":[{\"name\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"admin\"},\"password\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81\"},\"password-scrypt\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c\"},\"role\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"administrators\"}}],\"vipObjectType\":\"tree\",\"vipPrimaryKey\":[\"name\"]}}}}","templateDefinition":"{\"authentication\":{\"users\":{\"user\":{\"vipType\":\"constant\",\"vipValue\":[{\"name\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"admin\"},\"password\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81\"},\"password-scrypt\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c\"},\"role\":{\"vipObjectType\":\"object\",\"vipType\":\"constant\",\"vipValue\":\"administrators\"}}],\"vipObjectType\":\"tree\",\"vipPrimaryKey\":[\"name\"]}}}}","attachedMastersCount":0,"templateId":"30be9f2a-6188-4657-9286-fa993eb87cf2","configType":"xml","createdOn":1590354925752,"feature":"cloud-dock","factoryDefault":false,"templateName":"Cluster1_Credentials","createdBy":"admin","devicesAttached":0,"templateDescription":"Description for Cluster1_Credentials","lastUpdatedOn":1590354925752}],"device_up":"0","device_down":"0","vnf_up":"0","vnf_down":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write"},"put":{"tags":["Colocation"],"description":"Update a existing cluster","operationId":"updateCloudDockCluster","requestBody":{"description":"Cluster config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster config":{"description":"Cluster config","value":{"cloudDockCluster":{"clusterName":"Cluster1","ccmIpAddress":"1.1.1.1/31","siteId":"100","description":"Description for Cluster1","location":"us-west-1","isActiveCSPAdd":false,"csp":[{"name":"CSP_Cluster13","isCCMHosted":false,"type":"csp","uuid":"","deviceStatus":"DOWN"},{"name":"CSP_Cluster11","isCCMHosted":false,"type":"csp","uuid":"","deviceStatus":"DOWN"},{"name":"CSP_Cluster12","isCCMHosted":false,"type":"csp","uuid":"","deviceStatus":"DOWN"}],"switch":[{"name":"Switch1","type":"switch","uuid":"","deviceStatus":"--"},{"name":"Switch2","type":"switch","uuid":"","deviceStatus":"--"}],"setting":[{"templateName":"Cluster1_Credentials","templateDescription":"Description for Cluster1_Credentials","templateType":"clouddock_aaa","templateMinVersion":"15.0.0","templateDefinition":{"authentication":{"users":{"user":{"vipType":"constant","vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"admin"},"password":{"vipObjectType":"object","vipType":"constant","vipValue":"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81"},"password-scrypt":{"vipObjectType":"object","vipType":"constant","vipValue":"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c"},"role":{"vipObjectType":"object","vipType":"constant","vipValue":"administrators"}}],"vipObjectType":"tree","vipPrimaryKey":["name"]}}}},"transitionInProgress":false,"deviceType":["vedge-nfvis-CSP2100"],"deviceModels":[{"name":"vedge-nfvis-CSP2100","displayName":"vedge-nfvis-CSP2100-X1","deviceType":"vedge","isCliSupported":false,"isCiscoDeviceModel":true}],"feature":"cloud-dock","lastUpdatedBy":"admin","editedTemplateDefinition":{"authentication":{"users":{"user":{"vipType":"constant","vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"admin"},"password":{"vipObjectType":"object","vipType":"constant","vipValue":"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81"},"password-scrypt":{"vipObjectType":"object","vipType":"constant","vipValue":"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c"},"role":{"vipObjectType":"object","vipType":"constant","vipValue":"administrators"}}],"vipObjectType":"tree","vipPrimaryKey":["name"]}}}},"attachedMastersCount":0,"templateId":"30be9f2a-6188-4657-9286-fa993eb87cf2","configType":"xml","createdOn":1590354925752,"factoryDefault":false,"createdBy":"admin","devicesAttached":0,"lastUpdatedOn":1590354925752}],"resourcePool":{"ipPoolName":"Cluster1_ResourcePool","IpPoolDescription":"Description for Cluster1_ResourcePool","serviceChainVlanPool":"200","vnfMgmtPool":"1.1.1.1","vnfNetworkPool":"1.1.1.1","managementGateway":"1.1.1.1","managementMask":"31","systemIpPool":"1.1.1.1","ccmIpAddress":"1.1.1.1/31"},"clusterId":"b1201e77-3987-480e-b0d3-a2c972e59a33"}}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"},"post":{"tags":["Colocation"],"description":"Add a new cluster","operationId":"createCloudDockCluster","requestBody":{"description":"Cluster config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster config":{"description":"Cluster config","value":{"cloudDockCluster":{"clusterName":"Cluster1","siteId":"100","description":"Description for Cluster1","location":"us-west-1","isActiveCSPAdd":false,"csp":[{"name":"CSP_Cluster11","uuid":""},{"name":"CSP_Cluster12","uuid":""},{"name":"CSP_Cluster13","uuid":""}],"switch":[{"name":"Switch1","uuid":""},{"name":"Switch2","uuid":""}],"setting":[{"templateName":"Cluster1_Credentials","templateDescription":"Description for Cluster1_Credentials","templateType":"clouddock_aaa","templateMinVersion":"15.0.0","templateDefinition":{"authentication":{"users":{"user":{"vipType":"constant","vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"admin"},"password":{"vipObjectType":"object","vipType":"constant","vipValue":"$6$0Cp+qQ==$ql8pMkIpYZX4EN1LwBLK8Xs2TpiFWID3ZKsO4ashukENuuJGHyTFIQ/KUpXyQ93sV8WJjFLLmLmrNMz.Gptx81"},"password-scrypt":{"vipObjectType":"object","vipType":"constant","vipValue":"$9$4/IL3l2H2F.L3k$eDba4CuxtvlqbZFsTUMiveCz/xRjfZKtAhiFUaD4r5c"},"role":{"vipObjectType":"object","vipType":"constant","vipValue":"administrators"}}],"vipObjectType":"tree","vipPrimaryKey":["name"]}}}},"transitionInProgress":true,"deviceType":["vedge-nfvis-CSP2100"],"deviceModels":[{"name":"vedge-nfvis-CSP2100","displayName":"vedge-nfvis-CSP2100-X1","deviceType":"vedge","isCliSupported":false,"isCiscoDeviceModel":true}],"feature":"cloudDock","factoryDefault":false}],"resourcePool":{"ipPoolName":"Cluster1_ResourcePool","IpPoolDescription":"Description for Cluster1_ResourcePool","serviceChainVlanPool":"100","vnfMgmtPool":"1.1.1.1","vnfNetworkPool":"1.1.1.1","managementGateway":"1.1.1.1","managementMask":"31","systemIpPool":"1.1.1.1","ccmIpAddress":"1.1.1.1/31"}}}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/cluster/activate":{"post":{"tags":["Colocation"],"description":"Activate a cluster","operationId":"acitvateCloudDockCluster","parameters":[{"name":"clusterName","in":"query","description":"Cluster name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster detail":{"description":"Cluster detail","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/cluster/activateClusterDummy":{"get":{"tags":["Colocation"],"description":"Activate dummp cluster","operationId":"dummyccm","parameters":[{"name":"clusterName","in":"query","description":"Cluster name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write"}},"/colocation/cluster/activateClusterDummyState":{"get":{"tags":["Colocation"],"description":"Activate cluster in a state","operationId":"dummycspState","parameters":[{"name":"clusterName","in":"query","description":"Cluster name","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Cluster state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write"}},"/colocation/cluster/attached/csp":{"put":{"tags":["Colocation"],"description":"Update attached csp to cluster","operationId":"updateCspToCluster","requestBody":{"description":"CSP config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSP config":{"description":"CSP config","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/cluster/config":{"get":{"tags":["Colocation"],"description":"Clouddock cluster preview","operationId":"CloudDockClusterPreview","parameters":[{"name":"serialNumber","in":"query","description":"Serial number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Cluster detail":{"description":"Cluster detail"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/cluster/deactivate":{"post":{"tags":["Colocation"],"description":"Deactivate clouddock cluster","operationId":"deAcitvateCloudDockCluster","parameters":[{"name":"clusterId","in":"query","description":"Cluster Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/cluster/id":{"get":{"tags":["Colocation"],"description":"Get cluster by Id","operationId":"getCloudDockClusterDetailById","parameters":[{"name":"clusterId","in":"query","description":"Cluster Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Clouddock cluster detail":{"description":"Clouddock cluster detail","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write"}},"/colocation/cluster/rma":{"post":{"tags":["Colocation"],"description":"RMA operation for CSP device","operationId":"rmaCloudDockCsp","parameters":[{"name":"clusterName","in":"query","description":"Cluster name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSP info":{"description":"CSP info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/cluster/{clustername}":{"delete":{"tags":["Colocation"],"description":"Delete cluster by name","operationId":"deleteCloudDockClusterByName","parameters":[{"name":"clustername","in":"path","description":"Cluster name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write"}},"/colocation/monitor/cluster":{"get":{"tags":["Colocation"],"description":"Provide details of ids of existing clusters","operationId":"getClusterDetailsByClusterId","parameters":[{"name":"clusterId","in":"query","schema":{"$ref":"#/components/schemas/DeviceUuid"}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/cluster/config":{"get":{"tags":["Colocation"],"description":"Provide details of devices of clusters","operationId":"getClusterConfigByClusterId","parameters":[{"name":"clusterId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/cluster/portView":{"get":{"tags":["Colocation"],"description":"Provide details of port mappings in the cluster","operationId":"getClusterPortMappingByClusterId","parameters":[{"name":"clusterId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/device":{"get":{"tags":["Colocation"],"description":"List details for Device","operationId":"getDeviceDetailByDeviceId","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/device/system":{"get":{"tags":["Colocation"],"description":"List all connected VNF to a device","operationId":"getSystemStatusByDeviceId","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/device/vnf":{"get":{"tags":["Colocation"],"description":"List all VNF attached with Device","operationId":"getvnfByDeviceId","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/networkfunction/listmap":{"get":{"tags":["Colocation"],"description":"Retrieve network function listing","operationId":"listNetworkFunctionMap","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/pnf":{"get":{"tags":["Colocation"],"description":"List all PNF by cluster Id","operationId":"getpnfDetails","parameters":[{"name":"clusterId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/pnf/configuration":{"get":{"tags":["Colocation"],"description":"List configuration of PNF","operationId":"getPNFConfig","parameters":[{"name":"clusterId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}},{"name":"pnfSerialNumber","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/servicechain":{"get":{"tags":["Colocation"],"description":"List all service chain or service chains by Id","operationId":"getServiceChainDetails","parameters":[{"name":"clusterId","in":"query","schema":{"$ref":"#/components/schemas/DeviceUuid"}},{"name":"userGroupName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/servicegroup":{"get":{"tags":["Colocation"],"description":"List all attached serviceGroups to cluster","operationId":"getServiceGroupByClusterId","parameters":[{"name":"clusterId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf":{"get":{"tags":["Colocation"],"description":"Provide details of all existing VNF","operationId":"getvnfDetails","parameters":[{"name":"clusterId","in":"query","schema":{"$ref":"#/components/schemas/DeviceUuid"}},{"name":"userGroupName","in":"query","schema":{"type":"string"}},{"name":"vnfName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/action":{"post":{"tags":["Colocation"],"description":"To do VNF actions such as start, stop and restart","operationId":"vnfActions","parameters":[{"name":"vmName","in":"query","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/alarms":{"get":{"tags":["Colocation"],"description":"Get event detail of VNF","operationId":"getVNFEventsCountDetail","parameters":[{"name":"user_group","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/alarms/count":{"get":{"tags":["Colocation"],"description":"Get alarm count of VNF","operationId":"getVNFAlarmCount","parameters":[{"name":"user_group","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/events":{"get":{"tags":["Colocation"],"description":"Get event detail of VNF","operationId":"getVNFEventsDetail","parameters":[{"name":"vnfName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/interface":{"get":{"tags":["Colocation"],"description":"Get interface detail of VNF","operationId":"getVNFInterfaceDetail","parameters":[{"name":"vnfName","in":"query","required":true,"schema":{"type":"string"}},{"name":"deviceIp","in":"query","schema":{"$ref":"#/components/schemas/DeviceIP"}},{"name":"deviceClass","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/servicechain/attach":{"post":{"tags":["Colocation"],"description":"Attach service chain to cluster","operationId":"attachServiceChain","requestBody":{"description":"Attach service chain request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attach service chain request":{"description":"Attach service chain request"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/servicechain/autoattach":{"post":{"tags":["Colocation"],"description":"Attach service chain to cluster","operationId":"attachServiceChain_1","requestBody":{"description":"Attach service chain request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attach service chain request":{"description":"Attach service chain request"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/servicechain/cancel":{"post":{"tags":["Colocation"],"description":"Cancel button to cancel configuring devices","operationId":"cancelButton","requestBody":{"description":"Cancel configuring devices","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attach service chain request":{"description":"Attach service chain request"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/servicechain/detach":{"put":{"tags":["Colocation"],"description":"Detach service chain","operationId":"detachServiceChain","requestBody":{"description":"Detach service chain request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Detach service chain request":{"description":"Detach service chain request"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/servicechain/edge/devices":{"get":{"tags":["Colocation"],"description":"Get edge devices","operationId":"getEdgeDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices list":{"description":"Devices list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write,default"}},"/colocation/servicechain/edge/pnfdevices":{"get":{"tags":["Colocation"],"description":"Get PNF edge devices","operationId":"getpnfDevices","parameters":[{"name":"pnfDeviceType","in":"query","description":"PNF device type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PNF devices list":{"description":"PNF devices list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation-write,default"}},"/colocation/servicegroup":{"get":{"tags":["Colocation - Service Group"],"description":"Get service chain by name","operationId":"getServiceChain","parameters":[{"name":"serviceGroupName","in":"query","description":"Service group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service chain":{"description":"Service chain","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation User Service Group-read"},"put":{"tags":["Colocation - Service Group"],"description":"Update service group","operationId":"updateServiceGroupCluster","requestBody":{"description":"Service group","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service group":{"description":"Service group"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"},"post":{"tags":["Colocation - Service Group"],"description":"Add new service group","operationId":"createServiceGroupCluster","requestBody":{"description":"Service group","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service group":{"description":"Service group"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-write"}},"/colocation/servicegroup/attached":{"get":{"tags":["Colocation - Service Group"],"description":"Get service chains in cluster","operationId":"getServiceGroupInCluster","parameters":[{"name":"ClusterId","in":"query","description":"Cluster Id","schema":{"type":"string"}},{"name":"UserGroupName","in":"query","description":"UserGroup Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service chain":{"description":"Service chain","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read,Colocation User Service Group-read"}},"/colocation/servicegroup/servicechain/default":{"get":{"tags":["Colocation - Service Group"],"description":"Get default service chains","operationId":"getDefaultChain","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service chain":{"description":"Service chain","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read"}},"/colocation/servicegroup/servicechains":{"get":{"tags":["Colocation - Service Group"],"description":"Get all service chains","operationId":"getAvailableChains","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Service chains":{"description":"Service chains","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Colocation-read"}},"/colocation/servicegroup/{name}":{"delete":{"tags":["Colocation - Service Group"],"description":"Delete service group","operationId":"deleteServiceGroupCluster","parameters":[{"name":"name","in":"path","description":"Service group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Settings-write,Colocation-write"}},"/container-manager/activate/{containerName}":{"post":{"tags":["System - Container"],"description":"Activate container on remote host","operationId":"activateContainerOnRemoteHost","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"url","in":"query","description":"Container image URL","schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}},{"name":"checksum","in":"query","description":"Container image checksum","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/container-manager/deactivate/{containerName}":{"post":{"tags":["System - Container"],"description":"Deactivate container on remote host","operationId":"deActivateContainer","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/container-manager/doesValidImageExist/{containerName}":{"get":{"tags":["System - Container"],"description":"Get container image checksum","operationId":"doesValidImageExist","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Container image checksum":{"description":"Container image checksum","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin"}},"/container-manager/inspect/{containerName}":{"get":{"tags":["System - Container"],"description":"Get container inspect data","operationId":"getContainerInspectData","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Container inspect data":{"description":"Container inspect data"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/container-manager/settings/{containerName}":{"get":{"tags":["System - Container"],"description":"Get container settings","operationId":"getContainerSettings","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Container settings":{"description":"Container settings","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/data/device/state/{state_data_type}":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device state data","operationId":"generateDeviceStateData","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}},{"name":"startId","in":"query","description":"Start Id","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Count","schema":{"type":"string","default":"1000"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"State data":{"description":"State data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/data/device/state/{state_data_type}/fields":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device state data fileds","operationId":"generateDeviceStateDataFields","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"State data fileds":{"description":"State data fileds","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/data/device/state/{state_data_type}/query":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device state data fileds","operationId":"generateDeviceStateDataWithQueryString","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"State data":{"description":"State data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/data/device/statistics":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get statistics types","operationId":"getStatisticsType","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":["interfacestatistics","eioltestatistics","sulstatistics","qosstatistics","devicesystemstatusstatistics","bridgemacstatistics","dpistatistics","approutestatsstatistics","wlanclientinfostatistics","flowlogstatistics","urlf","fwall","vnfstatistics","umbrella","apphostingstatistics","utddaqioxstatistics","ipsalert","aggregatedappsdpistatistics","bridgeinterfacestatistics","artstatistics","trackerstatistics","cloudxstatistics","deviceevents","sleofflinereport","alarm","auditlog","deviceconfiguration","nwpi","nwpiflowraw","speedtest"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/data/device/statistics/alarm/active":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get active alarms","operationId":"getActiveAlarms","parameters":[{"name":"scrollId","in":"query","description":"SrollId","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date","schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date","schema":{"type":"string"}},{"name":"count","in":"query","description":"count","schema":{"type":"integer","format":"int64"}},{"name":"timeZone","in":"query","description":"Time zone","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Active alarms":{"description":"Active alarms","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/data/device/statistics/{state_data_type}":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get device statistics data","operationId":"generateDeviceStatisticsData","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}},{"name":"scrollId","in":"query","description":"Scroll Id","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date","schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"timeZone","in":"query","description":"Time zone","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Statistics data":{"description":"Statistics data","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/data/device/statistics/{state_data_type}/doccount":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get response count of a query","operationId":"getCountWithStateDataType","parameters":[{"name":"state_data_type","in":"path","description":"State data type(example:object)","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date (example:2021-1-1T00:00:00)","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date (example:2021-12-1T00:00:00)","required":true,"schema":{"type":"string"}},{"name":"timeZone","in":"query","description":"Time zone (example:UTC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Response count":{"description":"Response count","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/data/device/statistics/{state_data_type}/fields":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get statistics fields and types","operationId":"getStatDataFieldsByStateDataType","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Statistics field and type":{"description":"Statistics field and type","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/dca/analytics":{"put":{"tags":["Data Collection Agent"],"description":"Get statistics data","operationId":"createStats","requestBody":{"description":"Stats query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query":{"description":"Stats query","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats data":{"description":"Stats data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/analytics/all":{"post":{"tags":["Data Collection Agent"],"description":"Get all statistics setting data","operationId":"getAllStatsDataDCA","requestBody":{"description":"Stats setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats setting":{"description":"Stats setting","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats index status":{"description":"Stats index status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices":{"get":{"tags":["System - Cloud Service"],"description":"Get cloud service settings","operationId":"getCloudSettings","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service setting":{"description":"Cloud service setting","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca"}},"/dca/cloudservices/accesstoken":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA access token","operationId":"getAccessToken","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA access token":{"description":"DCA access token","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Data Collection Agent"],"description":"Set DCA access token","operationId":"storeAccessToken","requestBody":{"description":"DCA access token","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA access token":{"description":"DCA access token","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/alarm":{"post":{"tags":["Data Collection Agent"],"description":"Generate DCA alarms","operationId":"generateAlarm","requestBody":{"description":"DCA alarm message","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA alarm message":{"description":"DCA alarm message","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/idtoken":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA Id token","operationId":"getIdToken","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA Id token":{"description":"DCA Id token","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Data Collection Agent"],"description":"Set DCA Id token","operationId":"storeIdToken","requestBody":{"description":"DCA Id token","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA Id token":{"description":"DCA Id token","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/otp":{"get":{"tags":["System - Cloud Service"],"description":"Get cloud service OTP value","operationId":"getOTP","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service OTP value":{"description":"Cloud service OTP value","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca"},"put":{"tags":["System - Cloud Service"],"description":"Update cloud service OTP value","operationId":"updatetOTP","requestBody":{"description":"Cloud service OTP value","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service OTP value":{"description":"Cloud service OTP value","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca"}},"/dca/cloudservices/telemetry":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA telemetry settings","operationId":"getTelemetrySettings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA telemetry settings":{"description":"DCA telemetry settings","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/vanalytics":{"post":{"tags":["System - Cloud Service"],"description":"Get session from DCS for vAnalytics","operationId":"getvAnalytics","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service OTP value":{"description":"Cloud service OTP value","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"vAnalytics-readvAnalytics-writedca"}},"/dca/data/device/state/{state_data_type}":{"post":{"tags":["Data Collection Agent"],"description":"Get device state data","operationId":"generateDCADeviceStateData","parameters":[{"name":"state_data_type","in":"path","description":"Device state data","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device state":{"description":"Device state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/data/device/statistics/{stats_data_type}":{"post":{"tags":["Data Collection Agent"],"description":"Get device statistics data","operationId":"generateDCADeviceStatisticsData","parameters":[{"name":"stats_data_type","in":"path","description":"Device statistics data","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device statistics":{"description":"Device statistics","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/dcatenantowners":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA tenant owners","operationId":"getDCATenantOwners","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA service owner":{"description":"DCA service owner","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/device":{"post":{"tags":["Data Collection Agent"],"description":"Get all devices","operationId":"listAllDevicesDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device lists":{"description":"Device lists","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/device/crashlog/details":{"post":{"tags":["Data Collection Agent"],"description":"Get crash log","operationId":"getCrashLogs","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crash logs":{"description":"Crash logs","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/device/crashlog/synced":{"get":{"tags":["Data Collection Agent"],"description":"Get device crash log","operationId":"getCrashLogsSynced","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crash logs":{"description":"Crash logs","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/settings/configuration/cloudservices/dca":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA cloud service configuration","operationId":"getCloudServicesConfigurationDCA","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA cloud service configuration":{"description":"DCA cloud service configuration","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/settings/configuration/{type}/dca":{"post":{"tags":["Data Collection Agent"],"description":"Create analytics config data","operationId":"createDCAAnalyticsDataFile","parameters":[{"name":"type","in":"path","description":"Data type","required":true,"schema":{"type":"string","enum":["analytics","callHome"]}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Analytics config data":{"description":"Analytics config data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/statistics/settings/status":{"post":{"tags":["Data Collection Agent"],"description":"Get statistics setting status","operationId":"getStatsDBIndexStatus","requestBody":{"description":"Stats setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats setting":{"description":"Stats setting","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats index status":{"description":"Stats index status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/system/device":{"post":{"tags":["Data Collection Agent"],"description":"Get device details","operationId":"getDevicesDetailsDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device details":{"description":"Device details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/device/config/attachedconfig":{"post":{"tags":["Data Collection Agent"],"description":"Get attached config to device","operationId":"getDCAAttachedConfigToDevice","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attached config to device":{"description":"Attached config to device","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/definition/approute":{"post":{"tags":["Data Collection Agent"],"description":"Get template policy definitions","operationId":"getTemplatePolicyDefinitionsDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template policy definition":{"description":"Template policy definition","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/list/vpn":{"post":{"tags":["Data Collection Agent"],"description":"Get VPN details","operationId":"getVPNListsDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN":{"description":"VPN","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/vedge":{"post":{"tags":["Data Collection Agent"],"description":"Get vEdge template list","operationId":"getVedgeTemplateListDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vEdge template":{"description":"vEdge template","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/vsmart":{"post":{"tags":["Data Collection Agent"],"description":"Get vSmart template list","operationId":"getVsmartTemplateListDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart template":{"description":"vSmart template","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device":{"get":{"tags":["Monitoring - Device Details"],"description":"List all devices","operationId":"listAllDevices","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceData"},"examples":{"Devices List":{"description":"Devices List","value":[{"deviceId":"169.254.10.1","system-ip":"169.254.10.1","host-name":"vm200","reachability":"reachable","status":"normal","personality":"vmanage","device-type":"vmanage","timezone":"UTC","device-groups":["No groups"],"lastupdated":1634627015139,"domain-id":"0","board-serial":"12345704","certificate-validity":"Valid","max-controllers":"0","uuid":"96af574a-eadd-4b6a-97bf-d5c1e98f40f2","controlConnections":"9","device-model":"vmanage","version":"20.8.999-1397","connectedVManages":["169.254.10.1"],"site-id":"200","latitude":"37.666684","longitude":-122.777023,"isDeviceGeoData":false,"platform":"x86_64","uptime-date":1634626320000,"statusOrder":4,"device-os":"next","validity":"valid","state":"green","state_description":"All daemons up","model_sku":"None","local-system-ip":"172.16.255.200","total_cpu_count":"8","testbed_mode":true,"layoutLevel":1}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/aaa/servers":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get AAA servers from device (Real Time)","operationId":"getAAAservers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"AAA servers":{"description":"AAA servers","value":{"data":[{"authen-retried-access-requests":"0","vdevice-name":"169.254.10.13","author-errors-received":"0","author-retried-access-requests":"0","connection-failures":"0","acct-messages-sent":"0","acct-errors-received":"0","author-timeout-access-requests":"0","author-messages-sent":"0","auth-port":"1812","acct-port":"1813","authen-access-accepts":"0","author-access-accepts":"0","connection-timeouts":"0","author-access-rejects":"0","authen-timeout-access-requests":"0","authen-messages-received":"0","stats-time":"2022-06-06T06:55:52+00:00","authen-errors-received":"0","author-messages-received":"0","vdevice-host-name":"vm6","vdevice-dataKey":"169.254.10.13-vm6-radius-0-10.10.10.10-1812-1813","group-name":"radius-0","authen-access-rejects":"0","lastupdated":1654498624166,"connection-aborts":"0","radius-server-ip":"10.10.10.10","authen-messages-sent":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/aaa/users":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get AAA users from device (Real Time)","operationId":"getAAAUsers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"AAA users":{"description":"AAA users","value":{"data":[{"protocol":"aaa-sess-proto-type-none","ip-addr":"0.0.0.0","vdevice-dataKey":"169.254.10.13-admin-4157","vdevice-name":"169.254.10.13","login-time":"2022-06-06T08:54:01+00:00","lastupdated":1654505707413,"aaa-uid":"4157","vdevice-host-name":"vm6","username":"admin","session-id":"4145"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/acl/matchcounter":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get ACL match counters from device (Real Time)","operationId":"getACLMatchCounterUsers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL match counters":{"description":"ACL match counters","value":{"data":[{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-100","vdevice-name":"10.0.0.121","rule-name":"100","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-101","vdevice-name":"10.0.0.121","rule-name":"101","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-102","vdevice-name":"10.0.0.121","rule-name":"102","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-103","vdevice-name":"10.0.0.121","rule-name":"103","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-104","vdevice-name":"10.0.0.121","rule-name":"104","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-105","vdevice-name":"10.0.0.121","rule-name":"105","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/action/cancel":{"post":{"tags":["Configuration - Device Actions"],"description":"Cancel tasks","operationId":"processCancelTask","requestBody":{"description":"Cancel task payload","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/changepartition":{"get":{"tags":["Configuration - Device Actions"],"description":"Get change partition information","operationId":"generateChangePartitionInfo","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process change partition operation","operationId":"processChangePartition","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/deactivate":{"get":{"tags":["Configuration - Device Actions"],"description":"Get deactivate partition information","operationId":"generateDeactivateInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"},"post":{"tags":["Configuration - Device Actions"],"description":"Process deactivate operation for smu image","operationId":"processDeactivateSmu","requestBody":{"description":"Device smu image deactivate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device deactivate request":{"description":"Device deactivate request","value":{"action":"deactivate","devices":[{"version":"20.3.0","deviceIP":"172.16.51.1","deviceId":"52fe5cd3-ec3d-4141-92e4-0c31d0e0347a"},{"version":"20.3.0","deviceIP":"172.16.51.2","deviceId":"4d4507df-29b4-4f68-9129-36cfa4528847"}],"deviceType":"vedge"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"deactivate-01232017T154359940"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/defaultpartition":{"post":{"tags":["Configuration - Device Actions"],"description":"Process marking default partition operation","operationId":"processDefaultPartition","requestBody":{"description":"Marking default partition request","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/filter/vpn":{"get":{"tags":["Configuration - Device Actions"],"description":"Get filter VPN list","operationId":"createFilterVPNList","parameters":[{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Filter VPN list":{"description":"Filter VPN list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,RBAC VPN-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"}},"/device/action/firmware":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"Get list of firmware images in the repository","operationId":"getFirmwareImages","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"},"post":{"tags":["Configuration - Device Firmware Update"],"description":"Upload firmware image package","operationId":"processFirmwareImage","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware-upgrade":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Eemote firmware on device","operationId":"remoteFirmwareImageUpgrade","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgrade"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/devices":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"firmware supported devices","operationId":"getFirmwareDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/remote":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"firmware remote image package","operationId":"getFirmwareRemoteImage","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Firmware Update"],"description":"firmware remote image package","operationId":"processFirmwareRemoteImage","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/remote/{versionId}":{"put":{"tags":["Configuration - Device Software Update"],"description":"Download software package file","operationId":"editFirmwareUpgardeRemoteImage","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/{versionId}":{"delete":{"tags":["Configuration - Device Software Update"],"description":"Download software package file","operationId":"deleteFirmwareUpgardeRemoteImage","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware/activate":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Activate firmware on device","operationId":"activateFirmwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware/devices":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"Get list of devices that support firmware upgrade","operationId":"getDevicesFWUpgrade","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"}},"/device/action/firmware/install":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Install firmware on device","operationId":"installFirmwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware/remove":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Remove firmware on device","operationId":"removeFirmwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware/{versionId}":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"Get firmware image details for a given version","operationId":"getFirmwareImageDetails","parameters":[{"name":"versionId","in":"path","description":"Firmware image version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"},"delete":{"tags":["Configuration - Device Firmware Update"],"description":"Delete firmware image package","operationId":"deleteFirmwareImage","parameters":[{"name":"versionId","in":"path","description":"Firmware image version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/image-download":{"post":{"tags":["Configuration - Device Actions"],"description":"Intitate image download on the given device.","operationId":"initiateImageDownload","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/image-remove":{"post":{"tags":["Configuration - Device Actions"],"description":"Process remove software image operation","operationId":"processRemoveSoftwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/install":{"get":{"tags":["Configuration - Device Actions"],"description":"Generate install info","operationId":"generateInstallInfo","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process an installation operation","operationId":"processInstall","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/install/devices/{deviceType}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get list of installed devices","operationId":"generateDeviceList","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"$ref":"#/components/schemas/DeviceType"}},{"name":"groupId","in":"query","description":"Group Id","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,vmanage-http-stream,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/list":{"get":{"tags":["Configuration - Device Actions"],"description":"Get device action list","operationId":"generateDeviceActionList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device action list":{"description":"Device action list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/lxcactivate":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an activation operation","operationId":"processLxcActivate","requestBody":{"description":"Activation request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Activation Operation":{"description":"Activation Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcdelete":{"post":{"tags":["Configuration - Device Actions"],"description":"Process a delete operation","operationId":"processLxcDelete","requestBody":{"description":"Delete request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Delete Operation":{"description":"Delete Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcinstall":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an installation operation","operationId":"processLxcInstall","requestBody":{"description":"Installation request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Installation Operation":{"description":"Installation Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcreload":{"post":{"tags":["Configuration - Device Actions"],"description":"Process a reload operation","operationId":"processLxcReload","requestBody":{"description":"Reload request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reload Operation":{"description":"Reload Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcreset":{"post":{"tags":["Configuration - Device Actions"],"description":"Process a reset operation","operationId":"processLxcReset","requestBody":{"description":"Reset request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reset Operation":{"description":"Reset Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcupgrade":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an upgrade operation","operationId":"processLxcUpgrade","requestBody":{"description":"Upgrade request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Upgrade Operation":{"description":"Upgrade Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/reboot":{"get":{"tags":["Configuration - Device Actions"],"description":"Get device reboot information","operationId":"generateRebootInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Reboot-read,Device Reboot-write,Device Reboot > Edge-read,Device Reboot > Edge-write,Device Reboot > Controller-read"},"post":{"tags":["Configuration - Device Actions"],"description":"Process a reboot operation","operationId":"processReboot","requestBody":{"description":"Device reboot request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reboot request":{"description":"Device reboot request","value":{"action":"reboot","deviceType":"vedge","devices":[{"deviceIP":"172.16.255.11","deviceId":"6ace13f8-fded-4669-994a-a100b84b14dd"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskId"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Reboot-write,Device Reboot > Edge-write,Device Reboot > Controller-write"}},"/device/action/reboot/devices/{deviceType}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get list of rebooted devices","operationId":"generateRebootDeviceList","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"$ref":"#/components/schemas/DeviceType"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Reboot-read,Device Reboot-write,Device Reboot > Edge-read,Device Reboot > Edge-write,Device Reboot > Controller-read"}},"/device/action/rediscover":{"get":{"tags":["Configuration - Device Actions"],"description":"Get rediscover operation information","operationId":"generateRediscoverInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read,Tools-write"},"post":{"tags":["Configuration - Device Actions"],"description":"Rediscover device","operationId":"reDiscoverDevices","requestBody":{"description":"Rediscover device request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Rediscover device request":{"description":"Rediscover device request","value":{"action":"rediscover","devices":[{"deviceId":"CSR-940ad679-a16a-48ea-9920-16278597d98e","deviceIP":"10.3.0.1"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write,Tools-write"}},"/device/action/rediscoverall":{"post":{"tags":["Configuration - Device Actions"],"description":"Rediscover all devices","operationId":"reDiscoverAllDevice","requestBody":{"description":"Rediscover device request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Rediscover device request":{"description":"Rediscover device request","value":{"action":"rediscover","devices":[{"deviceId":"CSR-940ad679-a16a-48ea-9920-16278597d98e","deviceIP":"10.3.0.1"},{"deviceId":"CSR-04ed104b-86bb-4cb3-bd2b-a0d0991f6872","deviceIP":"10.3.0.2"},{"deviceId":"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de","deviceIP":"10.1.0.1"},{"deviceId":"f21dbb35-30b3-47f4-93bb-d2b2fe092d35","deviceIP":"10.1.0.2"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write,Tools-write"}},"/device/action/remote-server":{"get":{"tags":["Configuration - Software Actions"],"description":"Get list of remote servers","operationId":"getRemoteServerList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Software Actions"],"description":"Add a new remote server entry.","operationId":"addRemoteServer","requestBody":{"description":"Request payload for a new remote server entry.","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/remote-server/{id}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get remote server for the specified ID","operationId":"getRemoteServerById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Software Actions"],"description":"Update remote server for the specified ID","operationId":"updateRemoteServer","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Software Actions"],"description":"Delete remote server for the specified ID","operationId":"deleteRemoteServer","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/removepartition":{"get":{"tags":["Configuration - Device Actions"],"description":"Get remove partition information","operationId":"generateRemovePartitionInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"},"post":{"tags":["Configuration - Device Actions"],"description":"Process remove partition operation","operationId":"processRemovePartition","requestBody":{"description":"Device remove partition request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device remove partition request":{"description":"Device remove partition request","value":{"action":"removepartition","devices":[{"deviceIP":"172.16.255.11","deviceId":"6ace13f8-fded-4669-994a-a100b84b14dd","version":["20.1.1","20.3.1"]},{"deviceIP":"172.16.255.21","deviceId":"bedf3db0-c9c9-439d-b5fe-0edf09c2f33f","version":["20.1.1"]}],"deviceType":"vedge"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/security/amp/apikey/{uuid}":{"delete":{"tags":["Configuration - Device Actions"],"description":"Process amp api key deletion operation","operationId":"processDeleteAmpApiKey","parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"AMP API key deletion request":{"description":"AMP API key deletion request","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/security/amp/rekey":{"post":{"tags":["Configuration - Device Actions"],"description":"Process amp api re-key operation","operationId":"processAmpApiReKey","requestBody":{"description":"AMP API re-key request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"AMP API re-key request":{"description":"AMP API re-key request","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/security/apikey/{uuid}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get API key from device","operationId":"testApiKey","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"API key":{"description":"API key","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/security/devices/{policyType}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get list of devices by security policy type","operationId":"generateSecurityDevicesList","parameters":[{"name":"policyType","in":"path","description":"Policy type","required":true,"schema":{"type":"string","enum":["zoneBasedFW","intrusionPrevention","urlFiltering","advancedMalwareProtection","dnsSecurity","sslDecryption"]}},{"name":"groupId","in":"query","description":"Group Id","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,Security-read,Security-read,Security-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/software":{"get":{"tags":["Configuration - Software Actions"],"description":"Get software images","operationId":"findSoftwareImages","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Software Actions"],"description":"Create software image URL","operationId":"createImageURL","requestBody":{"description":"Create software image request payload","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/imageProperties/{versionId}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get Image Properties","operationId":"getImageProperties","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Image properties":{"description":"Image properties","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/images":{"get":{"tags":["Configuration - Software Actions"],"description":"Get software images","operationId":"findSoftwareImagesWithFilters","parameters":[{"name":"imageType","in":"query","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Image"}}},{"name":"vnfType","in":"query","schema":{"$ref":"#/components/schemas/VnfType"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package":{"post":{"tags":["Configuration - Device Software Update"],"description":"Install software package","operationId":"installPkg","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/custom/file/{uuid}":{"get":{"tags":["Configuration - Device Software Package"],"description":"Get bootstrap file contents","operationId":"getFileContents","parameters":[{"name":"uuid","in":"path","description":"File uuid","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"File content":{"description":"File content","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"},"put":{"tags":["Configuration - Device Software Package"],"description":"Edit bootstrap file","operationId":"editConfigFile","parameters":[{"name":"uuid","in":"path","description":"File uuid","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Bootstrap file","content":{"application/json":{"schema":{"type":"object"},"examples":{"Bootstrap file":{"description":"Bootstrap file","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Bootstrap file":{"description":"Bootstrap file","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/package/custom/uploads/{type}":{"post":{"tags":["Configuration - Device Software Package"],"description":"Upload virtual image/bootstrap file","operationId":"uploadImageFile","parameters":[{"name":"type","in":"path","description":"Upload file type","required":true,"schema":{"type":"string","enum":["image","file"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"File content":{"description":"File content","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Device Reboot > Edge-write,Device Reboot > Controller-write"}},"/device/action/software/package/custom/vnfPackage":{"post":{"tags":["Configuration - Device Software Package"],"description":"Create VNF custom package","operationId":"createVnfPackage","requestBody":{"description":"Custom package","content":{"application/json":{"schema":{"type":"object"},"examples":{"Custom package":{"description":"Custom package","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"File content":{"description":"File content","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/package/imageCount":{"get":{"tags":["Configuration - Device Software Update"],"description":"Number of software image presented in vManage repository","operationId":"getUploadImagesCount","parameters":[{"name":"imageType","in":"query","schema":{"type":"array","items":{"type":"string","default":"software"}}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/signature/{type}":{"get":{"tags":["Configuration - Device Software Update"],"summary":"Get list of Utd images","description":"Get list of Utd images ","operationId":"generateUtdImageData","parameters":[{"name":"utdsignature","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Get list of Utd images","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageData"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/utdsignature/{type}/mode/auto":{"post":{"tags":["Configuration - Device Software Update"],"summary":"add Utd remote image","description":"add Utd remote image ","operationId":"addUtdRemoteImage","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/utdsignature/{type}/mode/manual":{"post":{"tags":["Configuration - Device Software Update"],"summary":"upload Utd image","description":"upload Utd image","operationId":"uploadUtdImage","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/{fileName}":{"get":{"tags":["Configuration - Device Software Update"],"description":"Download software package file","operationId":"downloadPackageFile","parameters":[{"name":"fileName","in":"path","required":true,"schema":{"type":"string"}},{"name":"imageType","in":"query","schema":{"type":"string","default":"software"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/{imageType}":{"post":{"tags":["Configuration - Device Software Update"],"description":"Install software image package","operationId":"processSoftwareImage","parameters":[{"name":"imageType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/{versionId}/metadata":{"get":{"tags":["Configuration - Device Software Update"],"description":"Update Package Metadata","operationId":"getImageMetadata","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Device Software Update"],"description":"Update Package Metadata","operationId":"editImageMetadata","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/pnfproperties/{pnfType}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get PNF Properties","operationId":"getPnfProperties","parameters":[{"name":"pnfType","in":"path","description":"PNF type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PNF properties":{"description":"PNF properties","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/remoteserver/{versionId}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get Image Remote Server Details","operationId":"getImageRemoteServer","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Remote Server Details":{"description":"Remote Server Details","value":{"remoteServers":[{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e03","ImageRelativePath":"/images"},{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e14","ImageRelativePath":"/images/virtualImages"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"},"put":{"tags":["Configuration - Software Actions"],"description":"Update Image Remote Server Details","operationId":"editImageRemoteServer","parameters":[{"name":"versionId","in":"path","description":"Image ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update image remote server details","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update image remote server details":{"description":"Update image remote server details","value":{"remoteServers":[{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e03","ImageRelativePath":"/images"},{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e14","ImageRelativePath":"/images/virtualImages"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/vedge/version":{"get":{"tags":["Configuration - Software Actions"],"description":"Get vEdge software version","operationId":"findVEdgeSoftwareVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vEdge software version":{"description":"vEdge software version","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/software/version":{"get":{"tags":["Configuration - Software Actions"],"description":"Get software version","operationId":"findSoftwareVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Software version":{"description":"Software version","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/software/vnfproperties/{versionId}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get VNF Properties","operationId":"getVnfProperties","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VNF properties":{"description":"VNF properties","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/ztp/version":{"get":{"tags":["Configuration - Software Actions"],"description":"Get ZTP software version","operationId":"findZtpSoftwareVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/{versionId}":{"put":{"tags":["Configuration - Software Actions"],"description":"Update software image URL","operationId":"updateImageURL","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update software image request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update software image request":{"description":"Update software image request","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"},"delete":{"tags":["Configuration - Software Actions"],"description":"Delete software image URL","operationId":"deleteImageURL","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/startmonitor":{"get":{"tags":["Configuration - Device Actions"],"description":"Triggers global monitoring thread","operationId":"triggerPendingTasksMonitoring","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/status":{"put":{"tags":["Configuration - Dashboard Status"],"description":"Update device action status","operationId":"updateDeviceActionTaskStatus","requestBody":{"description":"Update device action status","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update device action status":{"description":"Update device action status","value":"{ \n \"transactionId\":\"software_install-2dfee040-d927-4d32-8a74-242a6d6d7916%C8K-30c039e8-415d-4e4f-8f70-a537aa71708a\",\n \"status\":\"in_progress\",\n \"statusMessage\": [ \n { \n \"type\":\"download-complete\",\n \"detail\":\"Image download complete.\"\n }\n }"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/cancel/{processId}":{"post":{"tags":["Configuration - Dashboard Status"],"description":"Bulk cancel task status","operationId":"cancelPendingTasks","parameters":[{"name":"processId","in":"path","description":"Process Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/clean":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Delete task and status vertex","operationId":"cleanStatus","parameters":[{"name":"cleanStatus","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/device/action/status/clear":{"delete":{"tags":["Configuration - Dashboard Status"],"description":"Delete status of action","operationId":"deleteStatus","parameters":[{"name":"processId","in":"query","description":"Process Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/preupgrade/check":{"put":{"tags":["Configuration - Pre upgrade check status"],"description":"Update pre upgrade check status","operationId":"updatePreUpgradeCheckStatus","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/tasks":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Find running tasks","operationId":"findRunningTasks","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/tasks/activeCount":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Get active task count","operationId":"getActiveTaskCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTaskStatus"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/tasks/clean":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Delete task and status vertex","operationId":"getCleanStatus","parameters":[{"name":"processId","in":"query","description":"Process Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTaskStatus"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/{actionName}":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Find status of action","operationId":"findStatus","parameters":[{"name":"actionName","in":"path","description":"Action name","required":true,"schema":{"type":"string"},"example":"push_feature_template_configuration-01232017T154359940"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTaskStatus"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/test/ioxconfig/{deviceIP}":{"get":{"tags":["Configuration - Device Actions"],"description":"testIoxConfig","operationId":"testIoxConfig","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/uniquevpnlist":{"post":{"tags":["Configuration - Device Actions"],"description":"Create unique VPN list","operationId":"createUniqueVPNList","requestBody":{"description":"Device IPs","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device IPs":{"description":"Device IPs","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Unique VPN list":{"description":"Unique VPN list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"}},"/device/action/vnfinstall":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an installation operation","operationId":"processVnfInstall","requestBody":{"description":"Installation request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Installation Operation":{"description":"Installation Operation","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/vpn":{"get":{"tags":["Configuration - Device Actions"],"description":"Create VPN list","operationId":"createVPNList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN list":{"description":"VPN list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/action/ztp/upgrade":{"get":{"tags":["Configuration - Device Actions"],"description":"Get ZTP upgrade configuration","operationId":"getZTPUpgradeConfig","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process ZTP upgrade configuration setting","operationId":"postprocessZTPUpgradeConfigSetting","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/ztp/upgrade/setting":{"get":{"tags":["Configuration - Device Actions"],"description":"Get ZTP upgrade configuration setting","operationId":"getZTPUpgradeConfigSetting","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process ZTP upgrade configuration setting","operationId":"processZTPUpgradeConfigSetting","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/app-hosting/attached-devices":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting attached device from device","operationId":"getAppHostingAttachedDevices","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting attached device":{"description":"App hosting attached device","value":{"data":[{"vdevice-dataKey":"172.16.255.15-utd-null","attached-device-type":"Serial/Trace","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"serial3","app-name":"utd"},{"attached-device-name":"dp_1_0","vdevice-dataKey":"172.16.255.15-utd-dp_1_0","attached-device-type":"NIC","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"net2","app-name":"utd"},{"attached-device-name":"dp_1_1","vdevice-dataKey":"172.16.255.15-utd-dp_1_1","attached-device-type":"NIC","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"net3","app-name":"utd"},{"attached-device-name":"_rootfs","vdevice-dataKey":"172.16.255.15-utd-_rootfs","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","app-name":"utd"},{"attached-device-name":"ieobc_1","vdevice-dataKey":"172.16.255.15-utd-ieobc_1","attached-device-type":"NIC","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"ieobc","app-name":"utd"},{"attached-device-name":"/opt/var","vdevice-dataKey":"172.16.255.15-utd-/opt/var","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","app-name":"utd"},{"attached-device-name":"/tmp/HTX-IOX","vdevice-dataKey":"172.16.255.15-utd-/tmp/HTX-IOX","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","app-name":"utd"},{"attached-device-name":"/opt/var/core","vdevice-dataKey":"172.16.255.15-utd-/opt/var/core","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314428,"vdevice-host-name":"vm5","app-name":"utd"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/details":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting details from device","operationId":"getAppHostingDetails","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting details":{"description":"App hosting details","value":{"data":[{"application-name":"utd","activated-profile-name":"cloud-low","application-installed-version":"1.0.6_SV2.9.18.1_XE17.9","vdevice-name":"172.16.255.15","package-info-name":"UTD-Snort-Feature","application-owner":"ioxm","vdevice-host-name":"vm5","resource-admission-cpu":"0","resource-reservation-disk":"861","package-info-path":"/bootflash/111.tar","vdevice-dataKey":"172.16.255.15-utd","resource-reservation-cpu":"0","resource-reservation-memory":"2048","name":"utd","application-description":"Unified Threat Defense","lastupdated":1659432542156,"state":"RUNNING","application-type":"LXC"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/guest-routes":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting guest routes from device","operationId":"getAppHostingGuestRoutes","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting guest routes":{"description":"App hosting guest routes","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","app-name":"utd","vdevice-dataKey":"172.16.255.15-utd","guest-route-route":"192.168.0.1","lastupdated":"1660244459596"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/network-interfaces":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting network interface from device","operationId":"getAppHostingNetworkDevices","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting network interface":{"description":"App hosting network interface","value":{"data":[{"network-interface-ipv4-address":"0.0.0.0","vdevice-dataKey":"172.16.255.15-utd-54:0e:00:0b:0c:02","vdevice-name":"172.16.255.15","network-interface-mac-address":"54:0e:00:0b:0c:02","lastupdated":1659432268936,"network-interface-attached-interface":"eth0","vdevice-host-name":"vm5","app-name":"utd"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/network-utilization":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting network utilization from device","operationId":"getAppHostingNetworkUtils","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting network utilization":{"description":"App hosting network utilization","value":{"data":[{"network-util-alias":"net2","network-util-rx-bytes":"0","vdevice-name":"172.16.255.15","network-util-name":"dp_1_0","network-util-tx-errors":"0","vdevice-host-name":"vm5","app-name":"utd","network-util-rx-packets":"0","vdevice-dataKey":"172.16.255.15-utd-dp_1_0","network-util-tx-packets":"0","lastupdated":1659432057682,"network-util-tx-bytes":"0","network-util-rx-errors":"0"},{"network-util-alias":"net3","network-util-rx-bytes":"0","vdevice-name":"172.16.255.15","network-util-name":"dp_1_1","network-util-tx-errors":"0","vdevice-host-name":"vm5","app-name":"utd","network-util-rx-packets":"0","vdevice-dataKey":"172.16.255.15-utd-dp_1_1","network-util-tx-packets":"0","lastupdated":1659432057683,"network-util-tx-bytes":"0","network-util-rx-errors":"0"},{"network-util-alias":"ieobc","network-util-rx-bytes":"11138","vdevice-name":"172.16.255.15","network-util-name":"ieobc_1","network-util-tx-errors":"0","vdevice-host-name":"vm5","app-name":"utd","network-util-rx-packets":"189","vdevice-dataKey":"172.16.255.15-utd-ieobc_1","network-util-tx-packets":"189","lastupdated":1659432057683,"network-util-tx-bytes":"12243","network-util-rx-errors":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/processes":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting processes from device","operationId":"getAppHostingProcesses","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting processes utilization":{"description":"App hosting processes utilization","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","app-name":"utd","process-name":"process01","process-status":"Running","process-pid":"10","process-uptime":"3600","process-memory":"2048","lastupdated":1660244459596,"vdevice-dataKey":"172.16.255.15-utd"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/storage-utilization":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting storage utilization from device","operationId":"getAppHostingStorageUtils","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting storage utilization":{"description":"App hosting storage utilization","value":{"data":[{"storage-util-name":"disk","storage-util-rd-bytes":"0","storage-util-wr-requests":"0","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","app-name":"utd","storage-util-capacity":"881664","storage-util-errors":"0","vdevice-dataKey":"172.16.255.15-utd-disk","storage-util-available":"35990","lastupdated":1659432204521,"storage-util-wr-bytes":"0","storage-util-rd-requests":"0","storage-util-used":"845674"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/utilization":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting utilization from device","operationId":"getAppHostingUtilization","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting utilization":{"description":"App hosting utilization","value":{"data":[{"utilization-name":"utd","memory-allocation":"0","vdevice-dataKey":"172.16.255.15-utd","actual-application-util":"0","vdevice-name":"172.16.255.15","requested-application-util":"0","name":"utd","lastupdated":1659353382195,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-route/sla-class":{"get":{"tags":["Real-Time Monitoring - Application-Aware Route"],"description":"Get SLA class list from device (Real Time)","operationId":"createAppRouteSlaClassList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SLA class":{"description":"SLA class","value":{"data":[{"app-probe-class":"None","loss":0,"fallback-best-tunnel":"None","jitter":0,"vdevice-dataKey":"169.254.10.10-0","vdevice-name":"169.254.10.10","latency":0,"name":"__all_tunnels__","index":0,"lastupdated":1642576726463,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/app-route/statistics":{"get":{"tags":["Real-Time Monitoring - Application-Aware Route"],"description":"Get application-aware routing statistics from device (Real Time)","operationId":"createAppRouteStatisticsList","parameters":[{"name":"remote-system-ip","in":"query","description":"Remote system IP","schema":{"type":"string"}},{"name":"local-color","in":"query","description":"Local color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"remote-color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Application-aware routing statistics":{"description":"Application-aware routing statistics","value":{"data":[{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","tx-data-pkts":"0","vdevice-name":"169.254.10.10","src-port":12346,"dst-port":"12426","remote-color":"default","remote-system-ip":"172.16.254.1","fallback-sla-class-index":"None","mean-latency":0,"total-packets":"600","loss":"0","mean-jitter":0,"average-latency":"0","index":"3","sla-class-index":"0","vdevice-host-name":"vm3","local-color":"default","app-probe-class":"None","mean-loss":0,"vdevice-dataKey":"169.254.10.10-3","proto":"ipsec","lastupdated":1642577794383,"average-jitter":"0","rx-data-pkts":"0"},{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","tx-data-pkts":"0","vdevice-name":"169.254.10.10","src-port":12346,"dst-port":"12426","remote-color":"default","remote-system-ip":"172.16.254.1","fallback-sla-class-index":"None","mean-latency":0,"total-packets":"600","loss":"0","mean-jitter":0,"average-latency":"0","index":"4","sla-class-index":"0","vdevice-host-name":"vm3","local-color":"default","app-probe-class":"None","mean-loss":0,"vdevice-dataKey":"169.254.10.10-4","proto":"ipsec","lastupdated":1642577794385,"average-jitter":"0","rx-data-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/app/log/flow-count":{"get":{"tags":["Real-Time Monitoring - App Logs"],"description":"Get App log flows count from device (Real Time)","operationId":"getAppLogFlowCount","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App log flows count":{"description":"App log flows count","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","count":"20","vdevice-dataKey":"172.16.254.1","lastupdated":1654066320000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/app/log/flows":{"get":{"tags":["Real-Time Monitoring - App Logs"],"description":"Get App log flows from device (Real Time)","operationId":"getAppLogFlows","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App log flows":{"description":"App log flows","value":{"data":[{"vdevice-name":"172.16.254.2","vdevice-host-name":"vm2","vpn-id":"0","src-ip":"10.0.5.19","dest-ip":"10.1.15.15","src-port":"23556","dest-port":"34576","dscp":"0","ip-proto":"6","tcp-cntrl-bits":"16","icmp-opcode":"0","nhop-ip":"10.1.15.15","total-pkts":"8531","total-bytes":"1200071","start-time":"Fri July 15 10:32:52 2022","time-to-expire":"59","egress-intf-name":"cpu","ingress-intf-name":"ge0/0","policy-name":"123NenokaKantri","policy-action":"accept","policy-direction":"inbound-acl","lastupdated":1657853484627,"vdevice-dataKey":"172.16.254.2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/appqoe/active-flow-id":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Active flow Id details from device","operationId":"createAppqoeActiveFlowIdDetails","parameters":[{"name":"flow-id","in":"query","description":"Flow Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Active FlowId details":{"description":"Appqoe Flow Active FlowId details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/appqoe/appqoe-hput-stats":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Hput Statistics from device","operationId":"getAppqoeHputStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Hput Statistics":{"description":"Appqoe Hput Statistics","value":{"data":[{"hs-sch-delay20us":"2569563","hs-time-node-dealloc":"10730115","uhs-callout-drain":"0","uhs-stop-cancel":"0","hs-exp-list-process":"237791","hs-curr-node-null":"0","hs-sch-delay200us":"4110","hs-sch-delay10000us":"6741","uhs-callout-unlock":"0","uhs-add":"1624643","uhs-rst-sbt-drain":"0","hs-timer-deleted":"0","hs-sch-delay300us":"1809","uhs-stop-del-cancel":"0","hs-sch-delay400us":"1541","uhs-add-fail":"0","hs-sch-delay1000000us":"0","hs-sch-delay1000us":"1069","uhs-stop-no-pending":"4","hs-timer-del-failed":"0","hs-expired-send-sig":"224059","uhs-stop-nodrain":"0","hs-sch-delay500us":"1444","hs-sch-delay30us":"198079","hs-timer-alloc":"10730124","hs-time-node-added":"10713486","uhs-stop":"4","uhs-callout-lock":"0","uhs-raw-add":"9105481","hs-ktimer-start":"17812503","hs-sch-delay600us":"1463","hs-ktimer-cb":"10475629","uhs-rst-sbt-del":"0","hs-expired-list-alloc":"237791","hs-sch-delay700us":"1417","hs-timer-cb":"10730115","uhs-callout":"1624635","uhs-raw-cb":"9105480","hs-timer-add-req":"10730124","vdevice-name":"169.254.10.12","uhs-rst-sbt-req":"1624643","hs-sch-delay40us":"27818","hs-timer-dealloc":"10730115","uhs-callout-done":"1624635","hs-time-node-deleted":"10713477","hs-sch-delay100000us":"2","uhs-callout-not-pending":"0","uhs-raw-add-failed":"0","hs-timer-del-req":"0","hs-pending-list-process":"224059","uhs-rst-sbt-add":"1624643","uhs-callout-cancel":"0","hs-sch-delay800us":"1334","hs-sch-delay10us":"7627736","hs-expired-list-dealloc":"237791","hs-min-sch-delay":"4330","uhs-callout-call":"1624635","uhs-callout-del":"0","uhs-rst-sbt-cancel":"0","vdevice-host-name":"vm5","hs-sch-delay900us":"1186","hs-time-node-alloc":"10730124","hs-time-node-exist":"0","hs-sch-delay50us":"13812","uhs-stop-drain":"0","uhs-stop-del":"0","hs-time-node-expired":"1642","vdevice-dataKey":"169.254.10.12","hs-curr-node-ts-not-valid":"0","hs-timer-added":"10493918","hs-sch-delay100us":"16505","uihs-nr-hpts-cpu":"0","hs-timer-add-expired":"236206","hs-max-sch-delay":"36715506","lastupdated":1644996827424,"hs-ktimer-stop":"17812503"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-nat-stats":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Nat Statistics from device","operationId":"getAppqoeNatStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Nat Statistics":{"description":"Appqoe Nat Statistics","value":{"data":[{"port-alloc-fail":"0","port-free-succ":"0","port-free-fail":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","alloc-fail":"0","lastupdated":1644997117219,"dup-entries":"0","vdevice-host-name":"vm5","port-alloc-succ":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-rm-resource":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Resource Manager resources from device","operationId":"getAppqoeRmResources","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Resource Manager resources":{"description":"Appqoe Resource Manager resources","value":{"data":[{"ssl-max-sess":"40000","avail-sys-mem":"2411556","dre-mem-per-sess":"0","ssl-used-sess":"0","vdevice-name":"169.254.10.12","rm-global-health-flag":"status-green","rm-tcp-sess-flag":"status-green","dre-used-sess":"0","tcp-max-sess":"40000","http-mem-per-sess":"0","vdevice-host-name":"vm5","rm-svc-mem-flag":"status-green","vdevice-dataKey":"169.254.10.12","per-used-serv-mem":"0","used-serv-mem":"0","http-max-sess":"0","tcp-used-sess":"0","ssl-mem-per-sess":"50","tcp-mem-per-sess":"64","lastupdated":1644997246553,"http-used-sess":"0","max-serv-mem":"1205778","dre-max-sess":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-rm-stats":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe RM Statistics from device","operationId":"getAppqoeRMStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe RM Statistics":{"description":"Appqoe RM Statistics","value":{"data":[{"port-alloc-fail":"0","port-free-succ":"0","port-free-fail":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","alloc-fail":"0","lastupdated":1644997491529,"dup-entries":"0","vdevice-host-name":"vm5","port-alloc-succ":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-services-status":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Services Status from device","operationId":"getAppqoeServicesStatus","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Services Status":{"description":"Appqoe Services Status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","service":"appqoe-service-tcpopt","load-percentage":"0","lastupdated":1644998907908,"vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","service":"appqoe-service-ssl","load-percentage":"0","lastupdated":1644998907908,"vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","load-status":"appqoe-service-status-red","vdevice-name":"169.254.10.12","service":"appqoe-service-dreopt","lastupdated":1644998907908,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-sppi-pipe-resource":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Sppi Pipe Stats from device","operationId":"getAppqoeSppiPipeStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Sppi Pipe Statistics":{"description":"Appqoe Sppi Pipe Statistics","value":{"data":[{"p-invalid-mtu":"0","p-disconnect":"0","p-in-use":"0","p-invalid-queue-id":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","channel-num":"0","lastupdated":1644997573992,"p-ifindex-error":"0","vdevice-host-name":"vm5","p-sock-error":"0"},{"p-invalid-mtu":"0","p-disconnect":"0","p-in-use":"0","p-invalid-queue-id":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","channel-num":"1","lastupdated":1644997573993,"p-ifindex-error":"0","vdevice-host-name":"vm5","p-sock-error":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-sppi-queue-resource":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Sppi Queue Stats from device","operationId":"getAppqoeSppiQueueStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Sppi Queue Statistics":{"description":"Appqoe Sppi Queue Statistics","value":{"data":[{"pkt-send-failed":"0","vdevice-name":"169.254.10.12","poll-error":"0","tpkt-version-error":"0","mmap-error":"0","truncated":"0","no-pkt-buf":"0","pkt-available":"0","invalid-ring":"0","vdevice-host-name":"vm5","in-use":"0","no-dev":"0","pkt-read-failed":"0","invalid-mode":"0","vdevice-dataKey":"169.254.10.12","nomem":"0","no-iov-buf":"0","not-init":"0","sock-error":"0","pkt":"8","channel-num":"0","lastupdated":1644998764198,"invalid-size":"0","pkt-losing":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/cluster-summary":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Cluster Summary from device","operationId":"getAppqoeClusterSummary","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Cluster Summary":{"description":"Appqoe Cluster Summary","value":{"data":[{"load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","load-percentage":"0","system-ip":"172.16.254.4","sng-name":"SNG-APPQOE","site-id":"5","vdevice-host-name":"vm5","lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.2","error-message":"-","service":"appqoe-service-tcpopt","lastupdated":1644995623537,"device-mode":"device-mode-integrated-service-node","status":"sn-status-green"},{"load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","load-percentage":"0","system-ip":"172.16.254.4","sng-name":"SNG-APPQOE","site-id":"5","vdevice-host-name":"vm5","lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.2","error-message":"-","service":"appqoe-service-ssl","lastupdated":1644995623537,"device-mode":"device-mode-integrated-service-node","status":"sn-status-green"},{"load-status":"appqoe-service-status-red","vdevice-name":"169.254.10.12","system-ip":"172.16.254.4","sng-name":"SNG-APPQOE","site-id":"5","vdevice-host-name":"vm5","lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.2","error-message":"-","service":"appqoe-service-dreopt","lastupdated":1644995623537,"device-mode":"device-mode-integrated-service-node","status":"sn-status-green"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/error-recent":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe error recent from device","operationId":"getAppqoeErrorRecent","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Error Recent":{"description":"Appqoe Error Recent","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-res-tcp-used-sess","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-res-ssl-used-sess","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-health-yellow","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-health-green","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-tcp-sess-alloc","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-tcp-sess-free","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-ssl-sess-alloc","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-ssl-sess-free","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-tcp-tot-conn","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-tcp-tot-flow-create","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/expired-flow-id":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Expired flow Id details from device","operationId":"createAppqoeFlowIdExpiredDetails","parameters":[{"name":"flow-id","in":"query","description":"Flow Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Expired flow Id details":{"description":"Appqoe Expired flow Id details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/appqoe/flow-closed-error":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe flow closed error from device","operationId":"getAppqoeFlowClosedError","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Closed Error":{"description":"Appqoe Flow Closed Error","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.2","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.3","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.4","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.5","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.6","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/flow-expired":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe expired from device","operationId":"getAppqoeExpired","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Expired List":{"description":"Appqoe Flow Expired List","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/appqoe/service-controllers":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe service controllers from device","operationId":"getAppqoeServiceControllers","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Service Controllers":{"description":"Appqoe Service Controllers","value":{"data":[{"sn-lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.1","vdevice-name":"169.254.10.12","sc-lan-ip":"192.168.2.1","system-ip":"172.16.254.4","lastupdated":1644996521181,"site-id":"5","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/status":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe status from device","operationId":"getAppqoeStatus","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Status":{"description":"Appqoe Status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-sslproxy","err-tag":"appqoe-err-ca-tp-cfg","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-yellow"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-tcpproxy","err-tag":"appqoe-err-undef","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-green"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-sc","err-tag":"appqoe-err-undef","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-green"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-rm","err-tag":"appqoe-err-undef","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-green"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/vpn-id":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Active vpn Id details from device","operationId":"createAppqoeVpnIdList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","required":true,"schema":{"type":"string"}},{"name":"client-ip","in":"query","description":"Client Ip","schema":{"type":"string"}},{"name":"server-ip","in":"query","description":"Server Ip","schema":{"type":"string"}},{"name":"server-port","in":"query","description":"Server-Port","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Active VpnId List":{"description":"Appqoe Flow Active VpnId List","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/arp":{"get":{"tags":["Real-Time Monitoring - ARP"],"description":"Get ARP interfaces from device (Real Time)","operationId":"getARPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ARP interface":{"description":"ARP interface","value":{"data":[{"if-name":"ge0/1","idle-timer":"0:00:10:36","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"10.101.254.254","lastupdated":1642578468257,"state":"dynamic","vpn-id":"0","uptime-date":1642160280000,"vdevice-host-name":"vm3","mac":"52:54:00:7a:da:f8","uptime":"4:20:09:23"},{"if-name":"eth0","vdevice-dataKey":"169.254.10.10-512-eth0","vdevice-name":"169.254.10.10","ip":"10.0.1.3","lastupdated":1642578468257,"state":"static","vpn-id":"512","uptime-date":1642154760000,"vdevice-host-name":"vm3","mac":"00:50:56:00:01:03","uptime":"4:21:41:16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/autonomousversion":{"get":{"tags":["developers"],"summary":"Get Software version from device","description":"Get Software version from device","operationId":"getAutonomousSoftwareVersion","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Software version from device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwareVersion"}}}},"400":{"description":"bad input parameter"}}}},"/device/bfd/history":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get BFD session history from device (Real Time)","operationId":"createBFDHistoryList","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD session history":{"description":"BFD session history","value":{"data":[{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"default","tx-pkts":3856,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187218000,"system-ip":"172.16.254.1","index":8,"dst-port":12386,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-8-2022-01-14T19:06:58+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:58+0000","state":"down","rx-pkts":3855},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"default","tx-pkts":6,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187218000,"system-ip":"172.16.254.1","index":9,"dst-port":12386,"del":1,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-9-2022-01-14T19:06:58+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:58+0000","state":"down","rx-pkts":6},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"biz-internet","tx-pkts":0,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187219000,"system-ip":"172.16.254.1","index":6,"dst-port":12406,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-6-2022-01-14T19:06:59+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:59+0000","state":"down","rx-pkts":0},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"biz-internet","tx-pkts":6,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187219000,"system-ip":"172.16.254.1","index":7,"dst-port":12406,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-7-2022-01-14T19:06:59+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:59+0000","state":"up","rx-pkts":6},{"dst-ip":"10.102.5.5","src-ip":"10.101.3.3","color":"default","tx-pkts":95431,"vdevice-name":"169.254.10.10","src-port":12346,"time-date":1642577832000,"system-ip":"172.16.254.4","index":8,"dst-port":12386,"del":0,"site-id":5,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-8-2022-01-19T07:37:12+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-19T07:37:12+0000","state":"down","rx-pkts":95426},{"dst-ip":"10.102.16.16","src-ip":"10.102.3.3","color":"lte","tx-pkts":0,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642163442000,"system-ip":"172.16.254.16","index":6,"dst-port":12366,"del":0,"site-id":16,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-6-2022-01-14T12:30:42+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T12:30:42+0000","state":"down","rx-pkts":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/links":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get list of BFD connections","operationId":"createBFDLinkList","parameters":[{"name":"state","in":"query","description":"Device state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD connections":{"description":"BFD connections","value":{"data":[{"linkKey":"172.16.255.14:lte - 172.16.255.16:lte","linkKeyDisplay":"172.16.255.14 (lte) - 172.16.255.16 (lte)","asystem-ip":"172.16.255.16","bhost-name":"vm4","lastupdated":"1642494861369","bsite-id":"400","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.14","ahost-name":"vm6","adeviceId":"172.16.255.16","asite-id":"600","bsystem-ip":"172.16.255.14"},{"linkKey":"172.16.255.11:lte - 172.16.255.16:lte","linkKeyDisplay":"172.16.255.11 (lte) - 172.16.255.16 (lte)","asystem-ip":"172.16.255.16","bhost-name":"vm1","lastupdated":"1642663041881","bsite-id":"100","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.11","ahost-name":"vm6","adeviceId":"172.16.255.16","asite-id":"600","bsystem-ip":"172.16.255.11"},{"linkKey":"172.16.255.16:lte - 172.16.255.21:lte","linkKeyDisplay":"172.16.255.16 (lte) - 172.16.255.21 (lte)","asystem-ip":"172.16.255.16","bhost-name":"vm11","lastupdated":"1642494861369","bsite-id":"100","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.21","ahost-name":"vm6","adeviceId":"172.16.255.16","asite-id":"600","bsystem-ip":"172.16.255.21"},{"linkKey":"172.16.255.15:lte - 172.16.255.16:lte","linkKeyDisplay":"172.16.255.15 (lte) - 172.16.255.16 (lte)","asystem-ip":"172.16.255.15","bhost-name":"vm6","lastupdated":"1642975004139","bsite-id":"600","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.16","ahost-name":"vm5","adeviceId":"172.16.255.15","asite-id":"500","bsystem-ip":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/bfd/sessions":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get list of BFD sessions from vManage (Real Time)","operationId":"createBFDSessions","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-color","in":"query","description":"Source color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"region-type","in":"query","description":"Region type","schema":{"type":"string","enum":["core","access"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD sessions":{"description":"BFD sessions","value":{"data":[{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.1","dst-port":12426,"site-id":2,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.1-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000},{"src-ip":"10.101.3.3","dst-ip":"10.101.4.4","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.3","dst-port":12386,"site-id":4,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.3-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000},{"src-ip":"10.101.3.3","dst-ip":"10.102.5.5","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.4","dst-port":12386,"site-id":5,"transitions":3,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:01:31:46","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.4-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642577820000},{"src-ip":"10.101.3.3","dst-ip":"10.102.6.6","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.5","dst-port":12386,"site-id":6,"transitions":2,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:01:36:07","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.5-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642577520000},{"src-ip":"10.101.3.3","dst-ip":"10.102.16.16","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.16","dst-port":12386,"site-id":16,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.16-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/sites/detail":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get detailed BFD site details","operationId":"getBFDSiteStateDetail","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD site detail: state=siteup":{"description":"BFD site detail: state=siteup","value":{"data":[{"bfdSessions":"5","site-id":"4","device-type":"vedge","uuid":"4125a7b2-65cd-43c5-a393-cba53ebcdc00","lastupdated":1648413952287,"reachability":"reachable","device-model":"vedge-cloud","version":"20.3.4-542","system-ip":"169.254.10.11","uptime-date":1646298000000,"controlConnections":"3","host-name":"vm4","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.3","board-serial":"12345709"},{"bfdSessions":"5","site-id":"16","device-type":"vedge","uuid":"CSR-aec2123c-f20b-4876-b9ac-ae1dba561fb5","lastupdated":1648416356665,"reachability":"reachable","device-model":"vedge-CSR-1000v","version":"17.03.06.0.6691","system-ip":"169.254.10.14","uptime-date":1647300780000,"controlConnections":"3","host-name":"vm16","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.16","board-serial":"1234570F"},{"bfdSessions":"5","site-id":"5","device-type":"vedge","uuid":"C8K-d721a892-1cc1-4a30-9d17-98387348e2d4","lastupdated":1648418760239,"reachability":"reachable","device-model":"vedge-C8000V","version":"17.06.03.0.3496","system-ip":"169.254.10.12","uptime-date":1646298240000,"controlConnections":"3","host-name":"vm5","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.4","board-serial":"1234570A"},{"bfdSessions":"5","site-id":"2","device-type":"vedge","uuid":"f713e867-4376-45f1-8ecf-7c5fbe2be2f8","lastupdated":1648453581214,"reachability":"reachable","device-model":"vedge-cloud","version":"20.8.0-218","system-ip":"169.254.10.9","uptime-date":1648060560000,"controlConnections":"3","host-name":"vm2","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.1","board-serial":"12345707"},{"bfdSessions":"5","site-id":"6","device-type":"vedge","uuid":"C8K-47924f4e-0029-4693-a3df-986cb132437f","lastupdated":1648413353813,"reachability":"reachable","device-model":"vedge-C8000V","version":"17.08.01.0.1034","system-ip":"169.254.10.13","uptime-date":1646298240000,"controlConnections":"3","host-name":"vm6","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.5","board-serial":"1234570B"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/sites/summary":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get BFD site summary","operationId":"getBFDSitesSummary","parameters":[{"name":"isCached","in":"query","description":"Flag for caching","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","description":"Filter VPN","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD site summary":{"description":"BFD site summary","value":{"data":[{"count":6,"detailsURL":"","status":"error","statusList":[{"name":"Full WAN Connectivity","status":"up","message":"6 Full WAN Connectivity","detailsURL":"/dataservice/device/bfd/sites/detail?state=siteup","count":6},{"name":"Partial WAN Connectivity","status":"warning","message":"0 Partial WAN Connectivity","detailsURL":"/dataservice/device/bfd/sites/detail?state=sitepartial","count":0},{"name":"No WAN Connectivity","status":"down","message":"0 No WAN Connectivity","detailsURL":"/dataservice/device/bfd/sites/detail?state=sitedown","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,System-read,System-write"}},"/device/bfd/state/device":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD state summary","operationId":"getDeviceBFDStateSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD state summary":{"description":"BFD state summary","value":{"data":[{"site-id":400,"color":"lte","vmanage-system-ip":"172.16.255.11","local-color":"lte","local-if-desc":"","vdevice-dataKey":"172.16.255.11-lte-172.16.255.14-lte-ipsec","tx-interval":1000,"vdevice-host-name":"vm1","transitions":0,"proto":"ipsec","lastupdated":1642663028239,"state":"up","uptime-date":1642663020000,"dst-port":12366,"system-ip":"172.16.255.14","dst-ip":"10.1.14.14","remote-if-desc":"","createTimeStamp":1642494963368,"src-port":12347,"vdevice-name":"172.16.255.11","@rid":936,"detect-multiplier":"7","src-ip":"10.0.5.11","local-remote-ifname":"ge0/2-ge0/4"},{"site-id":600,"color":"lte","vmanage-system-ip":"172.16.255.11","local-color":"lte","local-if-desc":"","vdevice-dataKey":"172.16.255.11-lte-172.16.255.16-lte-ipsec","tx-interval":1000,"vdevice-host-name":"vm1","transitions":0,"proto":"ipsec","lastupdated":1642663028239,"state":"up","uptime-date":1642663020000,"dst-port":12366,"system-ip":"172.16.255.16","dst-ip":"10.1.16.16","remote-if-desc":"","createTimeStamp":1642494971424,"src-port":12347,"vdevice-name":"172.16.255.11","@rid":947,"detect-multiplier":"7","src-ip":"10.0.5.11","local-remote-ifname":"ge0/2-GigabitEthernet1"},{"site-id":500,"color":"lte","vmanage-system-ip":"172.16.255.11","local-color":"lte","local-if-desc":"","vdevice-dataKey":"172.16.255.11-lte-172.16.255.15-lte-ipsec","tx-interval":1000,"vdevice-host-name":"vm1","transitions":0,"proto":"ipsec","lastupdated":1642663028239,"state":"up","uptime-date":1642663020000,"dst-port":12346,"system-ip":"172.16.255.15","dst-ip":"10.1.15.15","remote-if-desc":"","createTimeStamp":1642657637570,"src-port":12347,"vdevice-name":"172.16.255.11","@rid":1004,"detect-multiplier":"7","src-ip":"10.0.5.11","local-remote-ifname":"ge0/2-GigabitEthernet1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write,LI Monitoring-read"}},"/device/bfd/state/device/tloc":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD state summary with tloc color","operationId":"getDeviceBFDStateSummaryTloc","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD state summary with tloc":{"description":"BFD state summary with tloc","value":{"data":[{"local-color":["lte","dia"],"color":["lte","dia"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/state/device/tlocInterfaceMap":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device tloc color to Intf Mapping Relationship","operationId":"getDeviceTlocToIntfList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device tloc to intf mapping relationships":{"description":"Device tloc to intf mapping relationships","value":{"intfList":{"private1":"GigabitEthernet1","mpls":"GigabitEthernet2"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/status":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD status","operationId":"getDeviceBFDStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD status":{"description":"BFD status","value":{"data":[{"count":0,"statusList":[{"status":"up","count":0,"name":"up","color":"b0e276","detailsURL":"/dataservice/device/bfd/links?state=up","detailView":"dialog","icon":"images/connection/connection-network-up.png"},{"status":"down","count":0,"name":"down","color":"fa7c7d","detailsURL":"/dataservice/device/bfd/links?state=down","detailView":"dialog","icon":"images/connection/connection-network-down.png"}],"name":"BFD","image":"images/bfd.png","detailsURL":"/dataservice/device/bfd/links","type":"bfd","detailView":"dialog"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/bfd/summary":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get BFD summary from device (Real Time)","operationId":"createBFDSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD summary":{"description":"BFD summary","value":{"data":[{"bfd-sessions-max":"22","vdevice-dataKey":"169.254.10.10","bfd-sessions-flap":"111","vdevice-name":"169.254.10.10","bfd-sessions-up":"5","lastupdated":1642641879344,"bfd-sessions-total":"5","poll-interval":"600000","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/summary/device":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD status summary","operationId":"getDeviceBFDStatusSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD status summary":{"description":"BFD status summary","value":{"header":{"generatedOn":1646894919672,"title":"DataConnections"},"data":[{"name":"DataConnection","count":3,"detailsURL":"","status":"error","statusList":[{"name":"up","message":"3up","detailsURL":"/dataservice/device/bfd/sessions?deviceId=172.16.255.11&state=up","count":3}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/bfd/synced/sessions":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get list of BFD sessions from vManage synchronously","operationId":"createSyncedBFDSession","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-color","in":"query","description":"Source color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD sessions":{"description":"BFD sessions","value":{"data":[{"src-ip":"10.0.5.11","dst-ip":"10.1.14.14","color":"lte","vdevice-name":"172.16.255.11","src-port":12347,"createTimeStamp":1646804370042,"system-ip":"172.16.255.14","dst-port":12366,"site-id":400,"transitions":0,"vdevice-host-name":"vm1","local-color":"lte","detect-multiplier":"7","vdevice-dataKey":"172.16.255.11-lte-172.16.255.14-lte-ipsec","@rid":1050,"vmanage-system-ip":"172.16.255.11","proto":"ipsec","lastupdated":1646893777827,"tx-interval":1000,"state":"up","uptime-date":1646893680000},{"src-ip":"10.0.5.11","dst-ip":"10.1.15.15","color":"lte","vdevice-name":"172.16.255.11","src-port":12347,"createTimeStamp":1646804372038,"system-ip":"172.16.255.15","dst-port":12366,"site-id":500,"transitions":0,"vdevice-host-name":"vm1","local-color":"lte","detect-multiplier":"7","vdevice-dataKey":"172.16.255.11-lte-172.16.255.15-lte-ipsec","@rid":1057,"vmanage-system-ip":"172.16.255.11","proto":"ipsec","lastupdated":1646893777827,"tx-interval":1000,"state":"up","uptime-date":1646893680000},{"src-ip":"10.0.5.11","dst-ip":"10.1.16.16","color":"lte","vdevice-name":"172.16.255.11","src-port":12347,"createTimeStamp":1646804374521,"system-ip":"172.16.255.16","dst-port":12366,"site-id":600,"transitions":0,"vdevice-host-name":"vm1","local-color":"lte","detect-multiplier":"7","vdevice-dataKey":"172.16.255.11-lte-172.16.255.16-lte-ipsec","@rid":1060,"vmanage-system-ip":"172.16.255.11","proto":"ipsec","lastupdated":1646893777827,"tx-interval":1000,"state":"up","uptime-date":1646893680000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/tloc":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get TLOC summary from device (Real Time)","operationId":"createTLOCSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TLOC summary":{"description":"TLOC summary","value":{"data":[{"sessions-flap":90,"if-name":"ge0/1","sessions-total":5,"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","lastupdated":1642641739756,"encap":"ipsec","sessions-up":5,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bgp/neighbors":{"get":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP neighbors list (Real Time)","operationId":"createBGPNeighborsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"peer-addr","in":"query","description":"Peer address","schema":{"type":"string"}},{"name":"as","in":"query","description":"AS number","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BGP neighbors list":{"description":"BGP neighbors list","value":{"data":[{"vdevice-name":"169.254.10.10","afi":"ipv4-unicast","vpn-id":10,"vdevice-host-name":"vm3","peer-addr":"20.20.20.20","as":200,"vdevice-dataKey":"169.254.10.10-10-20.20.20.20","msg-rcvd":0,"outQ":0,"afi-id":0,"lastupdated":1642657118366,"msg-sent":0,"state":"active"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/bgp/routes":{"get":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP routes list (Real Time)","operationId":"createBGPRoutesList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"nexthop","in":"query","description":"Next hop","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BGP routes list":{"description":"BGP routes list","value":{"data":[{"vdevice-name":"172.16.255.15","prefix":"10.20.24.0/24","origin":"origin-incomplete","as-path":"10007","weight":"0","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"10.20.24.17","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-10.20.24.0/24","metric":"0","local-pref":"100","lastupdated":1646989331657,"path-status":"valid"},{"vdevice-name":"172.16.255.15","prefix":"10.20.24.0/24","origin":"origin-incomplete","weight":"32768","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"0.0.0.0","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-10.20.24.0/24","metric":"0","local-pref":"100","lastupdated":1646989331694,"path-status":"bestpathvalid"},{"vdevice-name":"172.16.255.15","prefix":"172.16.255.117/32","origin":"origin-incomplete","as-path":"10007","weight":"0","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"10.20.24.17","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-172.16.255.117/32","metric":"0","local-pref":"100","lastupdated":1646989331735,"path-status":"bestpathvalid"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/bgp/summary":{"get":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP summary (Real Time)","operationId":"createBGPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BGP summary":{"description":"BGP summary","value":{"data":[{"local-site-of-origin":"SoO:0:3","vdevice-dataKey":"169.254.10.10-10","bgp-router-identifier":"172.16.254.2","peer-memory":"4816","vdevice-name":"169.254.10.10","rib-memory":"0","lastupdated":1642657523957,"total-peers":"1","vpn-id":10,"vdevice-host-name":"vm3","rib-entries":"0","local-as":"100"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/blockSync":{"post":{"tags":["Monitoring - Device Details"],"description":"Set collection manager block set flag","operationId":"setBlockSync","parameters":[{"name":"blockSync","in":"query","description":"Block sync flag","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/bridge/interface":{"get":{"tags":["Real-Time Monitoring - Bridge"],"description":"Get device bridge interface list (Real Time)","operationId":"getBridgeInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bridge interface":{"description":"Device bridge interface","value":{"data":[{"ifindex":"13","vdevice-name":"10.0.0.121","oper-status":"up","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/0","admin-status":"up","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/0","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"14","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/1","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/1","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"15","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/2","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/2","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"16","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/3","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/3","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"17","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/4","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/4","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/bridge/mac":{"get":{"tags":["Real-Time Monitoring - Bridge"],"description":"Get device bridge interface MAC (Real Time)","operationId":"getBridgeInterfaceMac","parameters":[{"name":"bridge-id","in":"query","description":"Bridge ID","schema":{"type":"string"}},{"name":"if-name","in":"query","description":"Interface name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"mac-address","in":"query","description":"MAC address","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bridge interface MAC":{"description":"Device bridge interface MAC","value":{"data":[{"if-name":"Ethernet-Internal2/0/0","mac-address":"58:bc:27:6d:c3:09","vdevice-dataKey":"10.0.0.121-1-Ethernet-Internal2/0/0-58:bc:27:6d:c3:09","vlan":"1","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1","interface":"GigabitEthernet0/3/0","type":"bridge-mac-type-dynamic","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","mac-address":"a4:4c:11:9e:03:d7","vdevice-dataKey":"10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:03:d7","vlan":"1","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1","interface":"GigabitEthernet0/3/0","type":"bridge-mac-type-dynamic","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","mac-address":"a4:4c:11:9e:1d:cc","vdevice-dataKey":"10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:1d:cc","vlan":"1","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1","type":"bridge-mac-type-static","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","vdevice-dataKey":"10.0.0.121-1002-Ethernet-Internal2/0/0-","vlan":"1002","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1002","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","vdevice-dataKey":"10.0.0.121-1003-Ethernet-Internal2/0/0-","vlan":"1003","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1003","vdevice-host-name":"ISR4451-X"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/bridge/table":{"get":{"tags":["Real-Time Monitoring - Bridge"],"description":"Get device bridge interface table (Real Time)","operationId":"getBridgeInterfaceTable","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bridge interface":{"description":"Device bridge interface","value":{"data":[{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":4,"routing-interface":"Vlan1","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1","vlan":"1","tx-octets":"0","tx-packets":"0","name":"default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1002","vlan":"1002","tx-octets":"0","tx-packets":"0","name":"fddi-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1002","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1003","vlan":"1003","tx-octets":"0","tx-packets":"0","name":"token-ring-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1003","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1004","vlan":"1004","tx-octets":"0","tx-packets":"0","name":"fddinet-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1004","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1005","vlan":"1005","tx-octets":"0","tx-packets":"0","name":"trnet-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1005","flood-octets":"0","tx-routed-packets":"0","age":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cedgecflowd/app-fwd-cflowd-flows":{"get":{"tags":["Monitoring - Cedge Cflowd"],"description":"Get list of app fwd cflowd flows from device","operationId":"createAppFwdCflowdFlowsList","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"vpn-id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"src-addr","in":"query","schema":{"type":"string"}},{"name":"dst-addr","in":"query","schema":{"type":"string"}},{"name":"app","in":"query","schema":{"type":"string"}},{"name":"family","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/cedgecflowd/app-fwd-cflowd-v6-flows":{"get":{"tags":["Monitoring - Cedge Cflowd"],"description":"Get list of app fwd cflowd v6 flows from device","operationId":"createAppFwdCflowdV6FlowsList","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"vpn-id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"src-addr","in":"query","schema":{"type":"string"}},{"name":"dst-addr","in":"query","schema":{"type":"string"}},{"name":"app","in":"query","schema":{"type":"string"}},{"name":"family","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/cellular/connection":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular connection list from device","operationId":"createCellularConnectionList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular connection list":{"description":"Cellular connection list","value":[{"lastupdated":1649242617635,"cellular-interface":"Cellular0/1/0","active-profile":"1","cellular-packet-status":"packet-session-status-active","rx-packets":"20905","rx-bytes":"10301","tx-packets":"20905","tx-bytes":"10301","ipv4-addr":"29.29.29.105","ipv4-dns-pri":"8.0.0.8","ipv4-dns-sec":"4.4.4.4","ipv6-addr":"2001:a0:c::1a","ipv6-dns-pri":"2400:da00::6666","ipv6-dns-sec":"2400:da00::6666","scope":"scope","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/hardware":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular hardware list from device","operationId":"createHardwareList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular hardware list":{"description":"Cellular hardware list","value":[{"lastupdated":1649242617635,"cellular-interface":"Cellular0/1/0","cellular-firmware-build-time":"1649242617635","cellular-firmware-version":"1.0","cellular-hardware-version":"1.0","cellular-device-model":"HMOD1","cellular-imsi":"HUID1","cellular-imei":"imei","cellular-iccid":"iccid","cellular-msisdn":"msisdn","cellular-fsn":"fsn","cellular-modem-status":"active","cellular-modem-temperature":"16c","cellular-pri-skuid":"skuid","cellular-pri-version":"2.0","cellular-carrier":"carrier","cellular-oem-pri-version":"2.0","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/modem":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular modem list from device","operationId":"createModemList","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular modem list":{"description":"Cellular modem list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","model":"model","fw-version":"1.0","fw-date":"2022-04-18","fw-time":"1649242617635","fw-pkg-ver":"1.2","fw-pkg-carrier":"carrier","fw-pkg-pri":"pri","fw-pkg-subver":"subver","hw-version":"1.5","modem-status":"active","temperature":"16c","imsi":"imsi","imei":"imei","iccid":"iccid","msisdn":"msisdn","esn":"esn","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/network":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular network list from device","operationId":"createNetworkList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular network list":{"description":"Cellular network list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","reg-status":"status","roam-status":"status","domain-status":"status","mcc":"mcc","mnc":"mnc","nw-name":"name","emm-state":"state","emm-substate":"good","emm-connstate":"good","cellid":"cellid","tac":"tac","sid":"sid","nid":"nid","bid":"bid","lac":"lac","psc":"psc","bsic":"bsic","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/profiles":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular profile list from device","operationId":"createProfileList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular profile list":{"description":"Cellular profile list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","profile-id":"123","pdn-type":"type","apn":"apn","name":"name","auth":"auth","ip-addr":"172.16.255.15","primary-dns":"8.8.8.8","secondary-dns":"4.4.4.4","user-name":"uname","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/radio":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular radio list from device","operationId":"createRadioList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular radio list":{"description":"Cellular radio list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","band":123,"bandwidth":1000.2,"tx-channel":1,"rx-channel":2,"rssi":1,"rsrp":2,"rsrp-comment":"comment","rsrq":4,"rsrq-comment":"comment","snr":3.4,"snr-comment":"comment","ecio":"ecio","sinr":"sinr","io":"io","mode":"mode","band-class":"band class","channel":"unam123e","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/sessions":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular session list from device","operationId":"createSessionsList","parameters":[{"name":"if-name","in":"query","description":"Interface name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"ipv4-dns-pri","in":"query","description":"DNS primary IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular session list":{"description":"Cellular session list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","session-id":"123","data-bearer":"bearer","dormancy-state":"state","active-profile":1,"rx-packets":18,"rx-drops":15,"rx-errors":888,"rx-overflows":444,"rx-octets":235,"tx-packets":234,"tx-drops":234,"tx-errors":123,"tx-overflows":123,"tx-octets":123,"ipv4-addr":"172.16.255.15","ipv4-mask":"255.255.255.0","ipv4-gw":"192.168.0.1","ipv4-dns-pri":"8.8.8.8","ipv4-dns-sec":"4.4.4.4","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/status":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular status list from device","operationId":"getCellularStatusList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular status list":{"description":"Cellular status list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","modem-status":"status","sim-status":"status","signal-strength":"12","network-status":"health","last-seen-error":"last error","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellularEiolte/connections":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Connection Service"],"description":"Get cellular connection info from device","operationId":"getEiolteConnectionInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular connection info":{"description":"cellular connection info","value":[{"vdevice-name":"172.16.255.111","rx-errors":0,"cellular-interface-name":"Cellular 1/0","tx-errors":0,"sec-dns-ipv4-addr":"0.0.0.0","pri-dns-ipv4-addr":"8.8.8.8","tx-ofl":0,"connectivity":"Attach and Data","ipv4-address":"192.168.3.2","rx-ofl":0,"rx-pkts":42067,"apn":"internet","ipv6-prefix-length":"0","tx-pkts":36604,"ipv4-gateway-addr":"192.168.3.1","session-status":"Connected","pri-dns-ipv6-addr":"::","sec-dns-ipv6-addr":"::","vdevice-host-name":"CellularGateway","tx-drops":0,"rx-drops":0,"vdevice-dataKey":"172.16.255.111-1-1-","profile-id":1,"modem-index":"1","tx-bytes":10145490,"lastupdated":1649249750021,"ipv6-gw-prefix-length":"0","ipv6-gw-prefix":"::","rx-bytes":8887213,"ipv6-prefix":"::"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/hardware":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Hardware Service "],"description":"Get cellular hardware info from device","operationId":"getEiolteHardwareInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular hardware info":{"description":"cellular hardware info","value":[{"ICCID":"8952530306500032705","FSN":"4H0222009903AG","host-manufacturer":"Cisco Systems, Inc.","vdevice-name":"172.16.255.111","PRI-SKU-ID":"1104567","Modem-Status":"MODEM_STATE_DNS_ACQUIRED","cellular-interface-name":"Cellular 1/0","Firmware-Version":"SWIX55C_03.07.00.00 fef145 jenkins","host-software-version":"N/A","IMEI":"351735110100118","Model-ID":"EM9190","vdevice-host-name":"CellularGateway","vdevice-dataKey":"172.16.255.111-1-","Modem-Temperature":33,"PRI-Version":"030.018_000","IMSI":"001010123456063","OEM-PRI-Version":"001.021","modem-index":"1","Host-Firmware-Version":"SWIX55C_03.07.00.00 fef145 jenkins","lastupdated":1649250029516,"Carrier":"GENERIC","host-id":"N/A","host-model":"N/A"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/ipsec/interface/counters":{"get":{"tags":["Real-Time Monitoring - Cellular AON Ipsec Interface "],"description":"Get cellular ipsec interface info from device","operationId":"getAONIpsecInterfaceCountersInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular info":{"description":"cellular info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/ipsec/interface/session":{"get":{"tags":["Real-Time Monitoring - Cellular AON Ipsec Interface "],"description":"Get cellular ipsec interface info from device","operationId":"getAONIpsecInterfaceSessionnfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular info":{"description":"cellular info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/network":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Network Service"],"description":"Get cellular network info from device","operationId":"getEiolteNetworkInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular network info":{"description":"cellular network info","value":[{"Network-Selection-Mode":"Automatic","MNC":1,"vdevice-name":"172.16.255.111","cellular-interface-name":"Cellular 1/0","MCC":1,"vdevice-host-name":"CellularGateway","MTU":1500,"System-Time":"Thu Mar 24 3:6:0 2022","PS-State":"Attached","Roaming-Status":"Home","RRC-Connection-State":"RRC Connected","vdevice-dataKey":"172.16.255.111-1-","Network":"Test PLMN 1-1","EMM-State":"Registered","TAC":1,"Cell-ID":27447297,"modem-index":"1","lastupdated":1649250149676,"Current-Service":"Packet switched","Current-Service-status":"Normal","EMM-Sub-State":"Normal-Service"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/radio":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Connection Service"],"description":"Get cellular radio info from device","operationId":"getEiolteRadioInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular radio info":{"description":"cellular radio info","value":[{"Current-ENDC-RSRQ":"-11 dB","Current-ENDC-RSRP":"-71 dBm","vdevice-name":"172.16.255.111","LTE-Bandwidth":"20 MHz","cellular-interface-name":"Cellular 1/0","Offline-Reason":"Unknown","LTE-Rx-Channel-Number":18300,"Measured-ENDC-SINR":"36.0 dB","ENDC-active-downlink-channel":"632628","Low-Power-Reason":"Unknown","ENDC-active-band":"78","SNR":"30.0 dB","ENDC-Physical-CellId":"500","LTE-Band":1,"RSRP":"-60 dBm","Radio-Status":"online","ENDC-active-uplink-channel":"632628","RSRQ":"-7 dB","LTE-Tx-Channel-Number":300,"vdevice-host-name":"CellularGateway","RSSI":"-33 dBm","vdevice-dataKey":"172.16.255.111-1-","PCI":1,"ENDC-bandwidth":"50 MHz","modem-index":"1","lastupdated":1649250251234,"RAT-Selected":"LTE"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/sim":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Sim Service"],"description":"Get cellular sim info from device","operationId":"getEiolteSimInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular sim info":{"description":"cellular sim info","value":[{"active-sim":0,"vdevice-dataKey":"172.16.255.111-1-","vdevice-name":"172.16.255.111","cellular-interface-name":"Cellular 1/0","sim-status-slot-0":"Present","modem-index":"1","sim-status-slot-1":"Not Present","lastupdated":1649250373414,"vdevice-host-name":"CellularGateway"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cflowd/application/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get Cflowd DPI query field JSON","operationId":"getCflowdDPIDeviceFieldJSON","parameters":[{"name":"isDeviceDashBoard","in":"query","description":"Flag whether it is device dashboard request","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI query field in JSON":{"description":"DPI query field in JSON","value":{"header":{},"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false}]},{"property":"vpn_id","name":"VPN","isRequired":true,"multiSelect":false,"dataType":"int","fieldData":{"type":"url","url":"dataservice/device/action/vpn"}},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"isHidden":true,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/collector":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd collector list from device","operationId":"createCflowdCollectorList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cflowd collector list":{"description":"Cflowd collector list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/device/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get CflowdvDPI query field JSON","operationId":"getCflowdDPIFieldJSON","parameters":[{"name":"isDeviceDashBoard","in":"query","description":"Flag whether it is device dashboard request","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI query field in JSON":{"description":"DPI query field in JSON","value":[{"name":"Event Time","dataType":"date","isRequired":true,"property":"entry_time","options":[{"enableDateFields":false,"value":"Last 24 hours","key":"last_24_hours","number":"24"},{"enableDateFields":false,"value":"Last 12 hours","key":"last_12_hours","number":"12"},{"enableDateFields":false,"value":"Last 6 hours","key":"last_6_hours","number":"6"},{"enableDateFields":false,"value":"Last 3 hours","key":"last_3_hours","number":"3"},{"enableDateFields":false,"value":"Last 1 hour","key":"last_1_hour","number":"1"},{"enableDateFields":false,"value":"Last 7 days","key":"last_168_hours","number":"168"}],"fieldData":{"type":"dateList"}},{"dataType":"string","isRequired":true,"property":"dest_ip","multiSelect":false,"name":"Destination Ip"},{"dataType":"long","isRequired":true,"property":"dest_port","multiSelect":false,"name":"Destination port"},{"name":"Device name","dataType":"string","isRequired":true,"multiSelect":false,"property":"vdevice_name","isHidden":true}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/flows":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get list of cflowd flows from device","operationId":"createCflowCollectorList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"src-ip","in":"query","description":"Source IP","schema":{"type":"string"}},{"name":"dest-ip","in":"query","description":"Destination IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cflowd flows list":{"description":"Cflowd flows list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/flows-count":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd flow count from device","operationId":"createCflowdFlowsCountList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"src-ip","in":"query","description":"Source IP","schema":{"type":"string"}},{"name":"dest-ip","in":"query","description":"Destination IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cflowd flow count":{"description":"Cflowd flow count","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/cache-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF cache stats from device","operationId":"getFnFCacheStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF cache stats":{"description":"FnF cache stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/export-client-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF export client stats from device","operationId":"getFnFExportClientStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF export client stats":{"description":"FnF export client stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/export-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF export stats from device","operationId":"getFnFExportStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF export stats":{"description":"FnF export stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/flow-monitor":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF from device","operationId":"getFnf","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF":{"description":"FnF","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/monitor-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF monitor stats from device","operationId":"getFnFMonitorStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF monitor stats":{"description":"FnF monitor stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/statistics":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd statistics from device","operationId":"createCflowdStatistics","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cflowd statistics":{"description":"Cflowd statistics","value":[{"model_sk":"None","state_description":"All daemons up","site-id":"200","version":"20.7.999-1133","local-system-ip":"172.16.255.22","timezone":"UTC","controlConnections":"7","domain-id":"0","total_cpu_count":"2","device-groups":["No groups"],"device-type":"vmanage","uuid":"b9944bb0-b10b-427a-8fb4-5d3b51eec679","lastupdated":1639105319291,"platform":"x86_64","state":"green","host-name":"vm12","uptime-date":1638953400000,"latitude":"37.666684","system-ip":"172.16.255.22","personality":"vmanage","status":"normal","board-serial":"12345963","validity":"valid","certificate-validity":"Valid","max-controllers":"0","device-model":"vmanage","deviceId":"172.16.255.22","layoutLevel":1,"testbed_mode":true,"device-os":"next","isDeviceGeoData":false,"connectedVManages":["172.16.255.22"],"longitude":"-122.777023","reachability":"reachable","statusOrder":4}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/template":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd template from device","operationId":"createCflowdTemplate","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cflowd template":{"description":"Cflowd template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cfm/mp/database":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp database from device","operationId":"getMpDatabase","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp database":{"description":"Mp database","value":{"data":[{"defect":"defect-none","flag":"rmep-flag-none","vdevice-dataKey":"172.16.255.11","vdevice-name":"172.16.255.11","level":"7","service":"UNINET_VERLEANDROVALLE-17_5005","domain":"UNINET","local-mep-id":"1562","lastupdated":1648692601592,"remote-mep-id":"1561","vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cfm/mp/local/mep":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp local mep from device","operationId":"getMpLocalMep","parameters":[{"name":"domain","in":"query","description":"Domain Name","schema":{"type":"string"}},{"name":"service","in":"query","description":"Service Name","schema":{"type":"string"}},{"name":"mep-id","in":"query","description":"MEP ID","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp local mep":{"description":"Mp local mep","value":{"data":[{"svc-type":"cfm-svc-bd-vlan","offload-success":"false","vdevice-name":"172.16.255.11","level":"7","offload":"false","ccm-mode":"ccm-mode-multicast","dir":"mep-direction-down","vdevice-host-name":"vm1","svc-inst":"0","mep-id":"1562","vdevice-dataKey":"172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562","vlan":"112","port":"GigabitEthernet3","evc-name":"UNINET_VERLEANDROVALLE-17_5005","service":"UNINET_VERLEANDROVALLE-17_5005","ccm-state":"ccm-enabled","domain":"UNINET","lastupdated":1648692897652,"mac-addr":"52:54:00:fb:57:42"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cfm/mp/local/mip":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp local mip from device","operationId":"getMpLocalMip","parameters":[{"name":"level","in":"query","description":"Level","schema":{"type":"number"}},{"name":"port","in":"query","description":"Port","schema":{"type":"string"}},{"name":"svc-inst","in":"query","description":"Service Instance","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp local mip":{"description":"Mp local mip","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","level":"7","port":"GigabitEthernet3","svc-inst":"0","mac-addr":"52:54:00:fb:57:42","bd-id":"1562","svc-type":"cfm-svc-bd-vlan","source-static":"Dynamic","manual":"*","vdevice-dataKey":"172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562","lastupdated":1648692897652}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cfm/mp/remotemep":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp remote mep from device","operationId":"getMpRemoteMep","parameters":[{"name":"domain","in":"query","description":"Domain Name","schema":{"type":"string"}},{"name":"service","in":"query","description":"Service Name","schema":{"type":"string"}},{"name":"local-mep-id","in":"query","description":"Local MEP ID","schema":{"type":"number"}},{"name":"remote-mep-id","in":"query","description":"Remote MEP ID","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp remote mep":{"description":"Mp remote mep","value":{"data":[{"svc-type":"cfm-svc-bd-vlan","vdevice-name":"172.16.255.11","level":"7","remote-mep-id":"1561","if-status":"if-status-up","vdevice-host-name":"vm1","port-status":"port-status-up","svc-inst":"0","vdevice-dataKey":"172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562-1561","vlan":"112","evc-name":"UNINET_VERLEANDROVALLE-17_5005","service":"UNINET_VERLEANDROVALLE-17_5005","rdi":"false","domain":"UNINET","up-time":"2022-03-31T02:24:16.459+00:00","local-mep-id":"1562","lastupdated":1648693001718,"mac-addr":"52:54:00:aa:65:ba","ingress-if":"GigabitEthernet3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cloudx/application/detail":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress applications from device (Real Time)","operationId":"createApplicationsDetailList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress applications detail":{"description":"Cloudexpress applications detail","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"office365","app-name":"Exchange","exit-type":"local","gateway-system-ip":"10.1.15.13","interface":"GigabitEthernet1","latency":1,"loss":5,"local-color":"lte","remote-color":"lte","vanalytics-score":11,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/applications":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress applications from device (Real Time)","operationId":"createApplicationsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress applications":{"description":"Cloudexpress applications","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"amazon_aws","exit-type":"gateway","gateway-system-ip":"10.1.15.13","interface":"GigabitEthernet1","latency":1,"loss":40,"local-color":"lte","remote-color":"lte","lastupdated":660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/gatewayexits":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress gateway exits from device (Real Time)","operationId":"createGatewayExitsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress gateway exits":{"description":"Cloudexpress gateway exits","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"amazon_aws","gateway-ip":"10.1.15.13","latency":1,"loss":0,"local-color":"lte","remote-color":"lte","lastupdated":660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/loadbalance":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress load balance applications from device (Real Time)","operationId":"createLbApplicationsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress load-balance applications-lb":{"description":"Cloudexpress load-balance applications-lb","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":10,"application":"office365","interface":"GigabitEthernet1","exit-type":"local","gateway-system-ip":"10.0.1.2","latency":1,"loss":5,"local-color":"lte","remote-color":"lte","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/localexits":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress local exits from device (Real Time)","operationId":"createLocalExitsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress local exits":{"description":"Cloudexpress local exits","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"office365 ","interface":"GigabitEthernet1","latency":1,"loss":43,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/config":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device running configuration","operationId":"getDeviceRunningConfig","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Device running configuration":{"description":"Device running configuration"}}},"text/xml":{"schema":{"type":"string"},"examples":{"Device running configuration":{"description":"Device running configuration"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/config/html":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device running configuration in HTML format","operationId":"getDeviceRunningConfigHTML","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"text/html":{"schema":{"type":"string"},"examples":{"Device running configuration":{"description":"Device running configuration"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/device/configuration/commit-list":{"get":{"tags":["Real-Time Monitoring - Commit List"],"description":"Get device commit list","operationId":"getDeviceConfigurationCommitList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device commit list":{"description":"Device commit list","value":{"data":[{"time-stamp":"2022-03-1006:53:10","vdevice-dataKey":"172.16.255.11-0-10032","vdevice-name":"172.16.255.11","client":"system","lastupdated":1646900329409,"sn":"0","id":"10032","user":"system-vdaemon","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:48:02","vdevice-dataKey":"172.16.255.11-1-10031","vdevice-name":"172.16.255.11","client":"netconf","lastupdated":1646900329409,"sn":"1","id":"10031","user":"vmanage-admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:47:42","vdevice-dataKey":"172.16.255.11-2-10030","vdevice-name":"172.16.255.11","client":"cli","lastupdated":1646900329409,"sn":"2","id":"10030","user":"admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:28:31","vdevice-dataKey":"172.16.255.11-3-10026","vdevice-name":"172.16.255.11","client":"system","lastupdated":1646900329409,"sn":"3","id":"10026","user":"system-vdaemon","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:23:22","vdevice-dataKey":"172.16.255.11-4-10025","vdevice-name":"172.16.255.11","client":"netconf","lastupdated":1646900329409,"sn":"4","id":"10025","user":"vmanage-admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:02:22","vdevice-dataKey":"172.16.255.11-5-10024","vdevice-name":"172.16.255.11","client":"netconf","lastupdated":1646900329409,"sn":"5","id":"10024","user":"vmanage-admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1005:56:46","vdevice-dataKey":"172.16.255.11-6-10023","vdevice-name":"172.16.255.11","client":"system","lastupdated":1646900329409,"sn":"6","id":"10023","user":"system-vdaemon","vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/control/affinity/config":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get affinity config from device (Real Time)","operationId":"getAffinityConfig","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Affinity config":{"description":"Affinity config","value":{"data":[{"vdevice-dataKey":"169.254.10.10--0","vdevice-name":"169.254.10.10","affc-ccl":"0(2)Y","affc-equil":"Yes","affc-ecl":"0(2)","affc-index":"0","lastupdated":1642746599493,"affc-interface":"ge0/1","affc-last-resort":"No","vdevice-host-name":"vm3","affc-ervc":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/affinity/status":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get affinity status from device (Real Time)","operationId":"getAffinityStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Affinity status":{"description":"Affinity status","value":{"data":[{"affs-acc":"172.16.253.129(0),172.16.255.130(0)","vdevice-dataKey":"169.254.10.10--0","vdevice-name":"169.254.10.10","affs-index":"0","lastupdated":1642746754330,"vdevice-host-name":"vm3","affs-interface":"ge0/1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/connections":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from device (Real Time)","operationId":"createRealTimeConnectionList_1","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"domain-id":1,"instance":0,"vdevice-name":"169.254.10.10","behind-proxy":"No","system-ip":"172.16.253.129","remote-color":"default","site-id":129,"private-port":12346,"controller-group-id":0,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:05:55:35","peer-type":"vsmart","v-org-name":"vIPtela Inc Regression","protocol":"dtls","vdevice-dataKey":"169.254.10.10-0-default-172.16.253.129-default","public-ip":"10.103.129.129","public-port":12346,"lastupdated":1642727162594,"state":"up","private-ip":"10.103.129.129","uptime-date":1642705800000},{"domain-id":1,"instance":0,"vdevice-name":"169.254.10.10","behind-proxy":"No","system-ip":"172.16.255.130","remote-color":"default","site-id":130,"private-port":12346,"controller-group-id":0,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:05:55:35","peer-type":"vsmart","v-org-name":"vIPtela Inc Regression","protocol":"dtls","vdevice-dataKey":"169.254.10.10-0-default-172.16.255.130-default","public-ip":"10.103.130.130","public-port":12346,"lastupdated":1642727162594,"state":"up","private-ip":"10.103.130.130","uptime-date":1642705800000},{"domain-id":0,"instance":0,"vdevice-name":"169.254.10.10","behind-proxy":"No","system-ip":"169.254.10.3","remote-color":"default","site-id":202,"private-port":12346,"controller-group-id":0,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:05:55:35","peer-type":"vmanage","v-org-name":"vIPtela Inc Regression","protocol":"dtls","vdevice-dataKey":"169.254.10.10-0-default-169.254.10.3-default","public-ip":"10.103.202.202","public-port":12346,"lastupdated":1642727162594,"state":"up","private-ip":"10.103.202.202","uptime-date":1642705800000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/connectionshistory":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections history list from device (Real Time)","operationId":"createConnectionHistoryListRealTime","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"0.0.0.0","remote-color":"default","site-id":0,"uuid":"d7e88eac-250c-4189-bc66-747615452ad9","peer-type":"vbond","protocol":"dtls","state":"tear_down","private-ip":"10.103.135.135","local_enum-desc":"Disconnect vBond after register reply.","domain-id":0,"rep-count":0,"index":0,"private-port":12346,"vdevice-host-name":"vm3","local-color":"default","downtime":"2022-01-20T19:10:43+0000","vdevice-dataKey":"169.254.10.10-0-0-2022-01-20T19:10:43+0000","public-ip":"10.103.135.135","downtime-date":1642705843000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISCVBD"},{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"169.254.10.3","remote-color":"default","site-id":202,"uuid":"387d8bf3-5306-41fe-9090-7ee61c91d9c3","peer-type":"vmanage","protocol":"dtls","state":"tear_down","private-ip":"10.103.202.202","local_enum-desc":"TLOC Disabled.","domain-id":0,"rep-count":0,"index":1,"private-port":12346,"vdevice-host-name":"vm3","local-color":"biz-internet","downtime":"2022-01-20T19:10:24+0000","vdevice-dataKey":"169.254.10.10-0-1-2022-01-20T19:10:24+0000","public-ip":"10.103.202.202","downtime-date":1642705824000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISTLOC"},{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"172.16.255.130","remote-color":"default","site-id":130,"uuid":"fca7532b-9366-466a-a8f9-79922392917b","peer-type":"vsmart","protocol":"dtls","state":"tear_down","private-ip":"10.103.130.130","local_enum-desc":"TLOC Disabled.","domain-id":1,"rep-count":0,"index":2,"private-port":12346,"vdevice-host-name":"vm3","local-color":"biz-internet","downtime":"2022-01-20T19:10:24+0000","vdevice-dataKey":"169.254.10.10-0-2-2022-01-20T19:10:24+0000","public-ip":"10.103.130.130","downtime-date":1642705824000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISTLOC"},{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"169.254.10.3","remote-color":"default","site-id":202,"uuid":"387d8bf3-5306-41fe-9090-7ee61c91d9c3","peer-type":"vmanage","protocol":"dtls","state":"tear_down","private-ip":"10.103.202.202","local_enum-desc":"TLOC Disabled.","domain-id":0,"rep-count":0,"index":5,"private-port":12346,"vdevice-host-name":"vm3","local-color":"default","downtime":"2022-01-20T19:09:22+0000","vdevice-dataKey":"169.254.10.10-0-5-2022-01-20T19:09:22+0000","public-ip":"10.103.202.202","downtime-date":1642705762000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISTLOC"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/connectionsinfo":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from device (Real Time)","operationId":"createRealTimeConnectionList","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"vdevice-dataKey":"172.16.255.11---","vdevice-name":"172.16.255.11","rate":"Per-Control Connection Rate: 300 pps","lastupdated":1646962973344,"vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/count":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get number of vedges and vsmart device in different control states","operationId":"getTotalCountForDeviceStates","parameters":[{"name":"isCached","in":"query","description":"Device State cached","schema":{"type":"boolean","default":false}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device state count":{"description":"Device state count","value":{"data":[{"name":"ControlStatus","count":7,"detailsURL":"","status":"error","statusList":[{"name":"Controlup","status":"up","message":"devicesup","detailsURL":"/dataservice/device/control/networksummary?state=up","count":7},{"name":"Partial","status":"warning","message":"devicesdown","detailsURL":"/dataservice/device/control/networksummary?state=partial","count":0},{"name":"Controldown","status":"error","message":"devicesdown","detailsURL":"/dataservice/device/control/networksummary?state=down","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/links":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list","operationId":"createLinkList","parameters":[{"name":"state","in":"query","description":"Device State","required":true,"schema":{"type":"string","example":"up"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"state":"up","color1":"default","color2":"default","lastupdated":"1646912547015","linkKey":"172.16.255.19:default-172.16.255.26:default","linkKeyDisplay":"172.16.255.19(default)-172.16.255.26(default)","adeviceId":"172.16.255.26","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.26","bsystem-ip":"172.16.255.19","asite-id":"--","bsite-id":"100","ahost-name":"vm16","bhost-name":"vm9","apersonality":"vbond","bpersonality":"vsmart"},{"state":"up","color1":"default","color2":"default","lastupdated":"1646912512113","linkKey":"172.16.255.20:default-172.16.255.26:default","linkKeyDisplay":"172.16.255.20(default)-172.16.255.26(default)","adeviceId":"172.16.255.26","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.26","bsystem-ip":"172.16.255.20","asite-id":"--","bsite-id":"200","ahost-name":"vm16","bhost-name":"vm10","apersonality":"vbond","bpersonality":"vsmart"},{"state":"up","color1":"default","color2":"default","lastupdated":"1646912347752","linkKey":"172.16.255.22:default-172.16.255.26:default","linkKeyDisplay":"172.16.255.22(default)-172.16.255.26(default)","adeviceId":"172.16.255.26","bdeviceId":"172.16.255.22","asystem-ip":"172.16.255.26","bsystem-ip":"172.16.255.22","asite-id":"--","bsite-id":"200","ahost-name":"vm16","bhost-name":"vm12","apersonality":"vbond","bpersonality":"vmanage"},{"state":"up","color1":"lte","color2":"default","lastupdated":"1646912547013","linkKey":"172.16.255.14:lte-172.16.255.19:default","linkKeyDisplay":"172.16.255.14(lte)-172.16.255.19(default)","adeviceId":"172.16.255.14","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.14","bsystem-ip":"172.16.255.19","asite-id":"400","bsite-id":"100","ahost-name":"vm4","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","color1":"lte","color2":"default","lastupdated":"1646912512112","linkKey":"172.16.255.14:lte-172.16.255.20:default","linkKeyDisplay":"172.16.255.14(lte)-172.16.255.20(default)","adeviceId":"172.16.255.14","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.14","bsystem-ip":"172.16.255.20","asite-id":"400","bsite-id":"200","ahost-name":"vm4","bhost-name":"vm10","apersonality":"vedge","bpersonality":"vsmart"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/localproperties":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get local properties list (Real Time)","operationId":"createLocalPropertiesListListRealTIme","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Local properties list":{"description":"Local properties list","value":{"data":[{"certificate-not-valid-before":"Jan 26 07:37:47 2022 GMT","site-id":"100","protocol":"dtls","root-ca-chain-status":"Installed","certificate-not-valid-after":"Jan 26 07:37:47 2023 GMT","dns-name":"vbond","vdevice-host-name":"vm1","port-hopped":"TRUE","device-role":"edge-router","certificate-status":"Installed","device-type":"vedge","uuid":"a555e577-d513-4768-a695-93574a15f5cc","sp-organization-name":"vIPtela Inc Regression","lastupdated":1643348428058,"region-id-set":"N/A","keygen-interval":"1:00:00:00","domain-id":"1","time-since-port-hop":"1:21:43:52","system-ip":"172.16.255.11","board-serial":"12346580","certificate-validity":"Valid","max-controllers":"0","tls-port":"0","organization-name":"vIPtela Inc Regression","vdevice-name":"172.16.255.11","vsmart-list-version":"0","number-vbond-peers":"0","vdevice-dataKey":"172.16.255.11","token":"Invalid","number-active-wan-interfaces":"1","register-interval":"0:00:00:30","retry-interval":"0:00:00:15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/networksummary":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get list of unreachable devices","operationId":"networkSummary","parameters":[{"name":"state","in":"query","description":"Device State","schema":{"type":"string","example":"up"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"list of unreachable devices":{"description":"list of unreachable devices","value":{"data":[{"device-model":"vedge-cloud","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.21","system-ip":"172.16.255.21","host-name":"vm11","site-id":"100","version":"20.9.999-1766","uuid":"2b57ef1a-5eb2-4d8d-8676-cce19b56b26b","board-serial":"12345962","bfdSessions":"3","device-type":"vedge","lastupdated":1646917368708,"reachability":"reachable","controlConnections":"3","uptime-date":1646908860000,"controlConnectionsToVsmarts":"2"},{"device-model":"vedge-cloud","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.11","system-ip":"172.16.255.11","host-name":"vm1","site-id":"100","version":"20.9.999-1766","uuid":"84d1ab4e-0cbf-4369-a290-08fafeb80f95","board-serial":"12345974","bfdSessions":"3","device-type":"vedge","lastupdated":1646967284462,"reachability":"reachable","controlConnections":"3","uptime-date":1646909100000,"controlConnectionsToVsmarts":"2"},{"device-model":"vsmart","ompPeers":"6","number-vsmart-peers":1,"local-system-ip":"172.16.255.19","system-ip":"172.16.255.19","host-name":"vm9","site-id":"100","version":"20.9.999-1766","uuid":"9abd3af9-9087-497d-8b99-8fd0a7baa3f2","board-serial":"12345967","device-type":"vsmart","lastupdated":1646967277159,"reachability":"reachable","controlConnections":"9","uptime-date":1646908920000,"controlConnectionsToVsmarts":"1"},{"device-model":"vsmart","ompPeers":"6","number-vsmart-peers":1,"local-system-ip":"172.16.255.20","system-ip":"172.16.255.20","host-name":"vm10","site-id":"200","version":"20.9.999-1766","uuid":"43ba3223-9df7-4cc9-a059-a12e5382d79d","board-serial":"12345961","device-type":"vsmart","lastupdated":1646967275863,"reachability":"reachable","controlConnections":"9","uptime-date":1646908860000,"controlConnectionsToVsmarts":"1"},{"device-model":"vedge-cloud","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.14","system-ip":"172.16.255.14","host-name":"vm4","site-id":"400","version":"20.9.999-1766","uuid":"a66335c5-451f-4b93-a752-4116d688f347","board-serial":"12345970","bfdSessions":"4","device-type":"vedge","lastupdated":1646967282559,"reachability":"reachable","controlConnections":"3","uptime-date":1646908980000,"controlConnectionsToVsmarts":"2"},{"device-model":"vedge-C8000V","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.15","system-ip":"172.16.255.15","host-name":"vm5","site-id":"500","version":"17.09.01.0.154453","uuid":"C8K-8bda7a5d-6b75-47ec-a658-b30ca54e30eb","board-serial":"12345703","bfdSessions":"4","device-type":"vedge","lastupdated":1646967275462,"reachability":"reachable","controlConnections":"3","uptime-date":1646909400000,"controlConnectionsToVsmarts":"2"},{"device-model":"vedge-C8000V","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.16","system-ip":"172.16.255.16","host-name":"vm6","site-id":"600","version":"17.09.01.0.154453","uuid":"C8K-46aa4ddc-7468-45c2-9144-2d60c2f553f3","board-serial":"12345702","bfdSessions":"4","device-type":"vedge","lastupdated":1646967277103,"reachability":"reachable","controlConnections":"3","uptime-date":1646909400000,"controlConnectionsToVsmarts":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/regionconnections":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from device (Real Time)","operationId":"createRealTimeRegionConnectionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Region Connections list":{"description":"Region Connections list","value":"{\t\"data\":[\t\t{\t\t\t\"instance\":0,\t\t\t\"site-id\":129,\t\t\t\"domain-id\":1,\t\t\t\"vdevice-name\":\"169.254.10.10\",\t\t\t\"vdevice-host-name\":\"vm3\",\t\t\t\"local-private-ip\":\"10.103.129.129\",\t\t\t\"local-private-port\":12346,\t\t\t\"public-ip\":\"10.103.129.129\",\t\t\t\"public-port\":12346,\t\t\t\"region-idx\":1,\t\t\t\"peer-system-ip\":\"172.16.253.129\",\t\t\t\"color\":\"default\",\t\t\t\"lastupdated\":1642727162594,\t\t}\t]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/statistics":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connection statistics from device (Real Time)","operationId":"getConnectionStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection statistics":{"description":"Connection statistics","value":{"data":[{"rx_challenge":"14","challenge_failures":"0","vdevice-name":"169.254.10.10","tx_dtls_handshake":"21","tx_register_replies":"0","rx_challenge_ack":"14","tx_octets":"24918292","rx_registers":"0","tx_dtls_handshake_failures":"7","tx_vmanage_to_peer":"0","tx_pkts":"330231","tx_blocked":"0","tx_dtls_handshake_done":"14","rx_octets":"50924456","tx_error":"0","bid_failures_needing_reset":"0","rx_error":"0","rx_dtls_handshake_done":"0","tx_challenge_ack_error":"0","rx_challenge_resp":"0","tx_challenge_error":"0","tx_challenge_resp_error":"0","tx_register_to_vmanage":"4","tx_challenge":"0","rx_connects":"0","tx_registers":"15","rx_pkts":"347847","tx_connects":"0","tx_challenge_gen_error":"0","rx_register_to_vmanage":"0","vdevice-host-name":"vm3","tx_hello":"212412","tx_challenge_ack":"0","rx_hello":"212399","tx_challenge_resp":"14","rx_dtls_handshake":"0","vdevice-dataKey":"169.254.10.10","lastupdated":1642730071268,"rx_dtls_handshake_failures":"0","rx_register_replies":"15","rx_vmanage_to_peer":"4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/status":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get local device status","operationId":"getLocalDeviceStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Local device status":{"description":"Local device status","value":{"data":[{"type":"control","name":"Control","image":"images/control.png","count":0,"detailView":"dialog","detailsURL":"/dataservice/device/control/links","statusList":[{"status":"up","icon":"images/connection/connection-network-up.png","color":"b0e276","name":"up","detailView":"dialog","detailsURL":"/dataservice/device/control/links?state=up","count":0},{"status":"down","icon":"images/connection/connection-network-down.png","color":"fa7c7d","name":"down","detailView":"dialog","detailsURL":"/dataservice/device/control/links?state=down","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/summary":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections summary from device (Real Time)","operationId":"createConnectionsSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections summary":{"description":"Connections summary","value":{"data":[{"instance":0,"vdevice-dataKey":"172.16.255.14-0","vdevice-name":"172.16.255.14","vmanage_counts":1,"lastupdated":1588603863504,"vsmart_counts":2,"vbond_counts":0,"vdevice-host-name":"vm4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/summary/device":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get device control status summary","operationId":"getDeviceControlStatusSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device control status summary":{"description":"Device control status summary","value":{"data":[{"name":"ControlConnection","count":3,"detailsURL":"","status":"error","statusList":[{"name":"up","message":"3up","detailsURL":"/dataservice/device/control/connection?deviceId=172.16.255.11&state=up","count":3}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/synced/connections":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from vManage","operationId":"createSyncedConnectionList","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"instance":0,"vdevice-name":"172.16.255.11","system-ip":"172.16.255.19","remote-color":"default","site-id":100,"controller-group-id":0,"peer-type":"vsmart","shared-region-id-set":"N/A","protocol":"dtls","@rid":1060,"state":"up","private-ip":"10.0.5.19","domain-id":1,"behind-proxy":"No","createTimeStamp":1646912557634,"private-port":12455,"vdevice-host-name":"vm1","local-color":"lte","v-org-name":"vIPtelaIncRegression","vdevice-dataKey":"172.16.255.11-0-lte-172.16.255.19-default","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.5.19","public-port":12455,"lastupdated":1646967283468,"uptime-date":1646967180000},{"instance":0,"vdevice-name":"172.16.255.11","system-ip":"172.16.255.20","remote-color":"default","site-id":200,"controller-group-id":0,"peer-type":"vsmart","shared-region-id-set":"N/A","protocol":"dtls","@rid":1063,"state":"up","private-ip":"10.0.12.20","domain-id":1,"behind-proxy":"No","createTimeStamp":1646912560801,"private-port":12456,"vdevice-host-name":"vm1","local-color":"lte","v-org-name":"vIPtelaIncRegression","vdevice-dataKey":"172.16.255.11-0-lte-172.16.255.20-default","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.12.20","public-port":12456,"lastupdated":1646967283468,"uptime-date":1646967180000},{"instance":0,"vdevice-name":"172.16.255.11","system-ip":"172.16.255.22","remote-color":"default","site-id":200,"controller-group-id":0,"peer-type":"vmanage","protocol":"dtls","@rid":1068,"state":"up","private-ip":"10.0.12.22","domain-id":0,"behind-proxy":"No","createTimeStamp":1646912562214,"private-port":12446,"vdevice-host-name":"vm1","local-color":"lte","v-org-name":"vIPtelaIncRegression","vdevice-dataKey":"172.16.255.11-0-lte-172.16.255.22-default","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.12.22","public-port":12446,"lastupdated":1646967283468,"uptime-date":1646967180000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/synced/localproperties":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get local properties list","operationId":"createLocalPropertiesSyncedList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Local properties list":{"description":"Local properties list","value":{"data":[{"retry-interval":"0:00:00:16","vdevice-name":"172.16.255.11","device-role":"edge-router","tls-port":"0","max-controllers":"0","system-ip":"172.16.255.11","certificate-not-valid-before":"Mar1011:16:192022GMT","site-id":"100","certificate-not-valid-after":"Mar1011:16:192023GMT","uuid":"84d1ab4e-0cbf-4369-a290-08fafeb80f95","number-active-wan-interfaces":"1","protocol":"dtls","board-serial":"12345974","vsmart-list-version":"0","@rid":1071,"certificate-status":"Installed","device-type":"vedge","port-hopped":"TRUE","organization-name":"vIPtelaIncRegression","domain-id":"1","root-ca-chain-status":"Installed","dns-name":"vbond","createTimeStamp":1646912563392,"sp-organization-name":"vIPtelaIncRegression","vdevice-host-name":"vm1","register-interval":"0:00:00:30","token":"Invalid","keygen-interval":"1:00:00:00","vdevice-dataKey":"172.16.255.11","certificate-validity":"Valid","vmanage-system-ip":"172.16.255.11","lastupdated":1646963388706,"number-vbond-peers":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/synced/waninterface":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get WAN interface list","operationId":"createWanInterfaceSyncedList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"WAN interface list":{"description":"WAN interface list","value":{"data":[{"instance":0,"low-bandwidth-link":"No","color":"lte","vdevice-name":"172.16.255.11","nat-type":"N","admin-state":"up","interface":"ge0/2","restrict-str":"no","@rid":1077,"private-ipv6":"::","private-ip":"10.0.5.11","per-wan-max-controllers":2,"num-vsmarts":2,"num-vmanages":1,"preference":"0","createTimeStamp":1646912567192,"weight":1,"index":0,"private-port":12407,"vdevice-host-name":"vm1","vbond-as-stun-server":"no","control-str":"yes","carrier":"default","last-resort":"No","vdevice-dataKey":"172.16.255.11-0-0","vmanage-connection-preference":"5","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.5.11","operation-state":"up","public-port":12407,"region-id":"Default","lastupdated":1646967283812,"wan-port-hopped":"TRUE"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/validdevices":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get vmanage valid device list (Real Time)","operationId":"createValidDevicesListRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":{"data":[{"chassis-number":"00D132A6-F3D2-40BA-862B-A6D1A83EFAEA","vdevice-dataKey":"172.16.255.22-00D132A6-F3D2-40BA-862B-A6D1A83EFAEA-12346574","vdevice-name":"172.16.255.22","serial-number":"12346574","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F","vdevice-dataKey":"172.16.255.22-C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F-12345703","vdevice-name":"172.16.255.22","serial-number":"12345703","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7","vdevice-dataKey":"172.16.255.22-C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7-12345705","vdevice-name":"172.16.255.22","serial-number":"12345705","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-A9DF16AA-14C2-4B60-8D65-05957111879E","vdevice-dataKey":"172.16.255.22-C8K-A9DF16AA-14C2-4B60-8D65-05957111879E-12345967","vdevice-name":"172.16.255.22","serial-number":"12345967","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A","vdevice-dataKey":"172.16.255.22-C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A-12345707","vdevice-name":"172.16.255.22","serial-number":"12345707","lastupdated":1649645323938,"vdevice-host-name":"vm12"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/validvmanageid":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get valid vManage from device (Real Time)","operationId":"getValidVManageIdRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage":{"description":"vManage","value":{"data":[{"chassis-number":"387d8bf3-5306-41fe-9090-7ee61c91d9c3","vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1642746085123,"vdevice-host-name":"vm3"},{"chassis-number":"59ddeeef-24ad-4bd3-9e55-f9760b640970","vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1642746085123,"vdevice-host-name":"vm3"},{"chassis-number":"c0fd955c-7e0d-4b90-9626-55684f69a899","vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1642746085123,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/validvsmarts":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get valid vSmart list from device (Real Time)","operationId":"createValidVSmartsListRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart list":{"description":"vSmart list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-12345701","vdevice-name":"169.254.10.10","serial-number":"12345701","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345702","vdevice-name":"169.254.10.10","serial-number":"12345702","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345703","vdevice-name":"169.254.10.10","serial-number":"12345703","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345704","vdevice-name":"169.254.10.10","serial-number":"12345704","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345705","vdevice-name":"169.254.10.10","serial-number":"12345705","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345706","vdevice-name":"169.254.10.10","serial-number":"12345706","lastupdated":1642743541771,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/waninterface":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get WAN interface list (Real Time)","operationId":"createWanInterfaceListList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"WAN interface list":{"description":"WAN interface list","value":{"data":[{"instance":0,"low-bandwidth-link":"No","color":"default","vdevice-name":"169.254.10.10","nat-type":"N","admin-state":"up","interface":"ge0/1","restrict-str":"no","private-ipv6":"::","private-ip":"10.101.3.3","per-wan-max-controllers":2,"num-vsmarts":2,"num-vmanages":1,"preference":"0","wan-time-since-port-hop":"0:11:14:02","spi-change":"0:00:45:59","index":0,"weight":1,"private-port":12386,"last-conn-time":"0:11:13:42","vbond-as-stun-server":"no","vdevice-host-name":"vm3","control-str":"yes","carrier":"default","vmanage-connection-preference":"5","last-resort":"No","vdevice-dataKey":"169.254.10.10-0-0","public-ip":"10.101.3.3","operation-state":"up","public-port":12386,"lastupdated":1642746267569,"last-conn-time-date":1642705800000,"wan-port-hopped":"TRUE"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/waninterface/color":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get port hop colors","operationId":"getPortHopColor","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device port hop colors":{"description":"Device port hop colors","value":{"data":[{"color":"lte"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/counters":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device counters","operationId":"getDeviceCounters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCountersResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/crashlog":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash logs from device","operationId":"getDeviceCrashLogs","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device crash logs":{"description":"Device crash logs","value":{"data":[{"core-time":"Tue Feb 15 04:14:38 UTC 2022","vdevice-dataKey":"169.254.10.12-0","vdevice-name":"169.254.10.12","index":0,"lastupdated":1645064726542,"core-filename":"vm5_htx_19219_20220215-041430-UTC.core.gz","core-time-date":1644898478000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 04:15:24 UTC 2022","vdevice-dataKey":"169.254.10.12-1","vdevice-name":"169.254.10.12","index":1,"lastupdated":1645064726542,"core-filename":"vm5_htx_19539_20220215-041515-UTC.core.gz","core-time-date":1644898524000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 05:55:04 UTC 2022","vdevice-dataKey":"169.254.10.12-2","vdevice-name":"169.254.10.12","index":2,"lastupdated":1645064726542,"core-filename":"vm5_htx_30530_20220215-055452-UTC.core.gz","core-time-date":1644904504000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 05:55:50 UTC 2022","vdevice-dataKey":"169.254.10.12-3","vdevice-name":"169.254.10.12","index":3,"lastupdated":1645064726542,"core-filename":"vm5_htx_31380_20220215-055542-UTC.core.gz","core-time-date":1644904550000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 06:21:52 UTC 2022","vdevice-dataKey":"169.254.10.12-4","vdevice-name":"169.254.10.12","index":4,"lastupdated":1645064726542,"core-filename":"vm5_htx_26426_20220215-062140-UTC.core.gz","core-time-date":1644906112000,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write"}},"/device/crashlog/details":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash logs for all device","operationId":"getAllDeviceCrashLogs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device crash logs":{"description":"Device crash logs","value":{"data":[{"core-time":"MonMay908:25:21UTC2022","vdevice-name":"172.16.255.11","index":8,"lastupdated":1652085255804,"core-filename":"vm1-system-report_20220509-082507-UTC.tar.gz","core-time-date":1652084721000,"vdevice-host-name":"vm1"},{"core-time":"MonMay910:36:57UTC2022","vdevice-name":"172.16.255.15","index":7,"lastupdated":1652093038703,"core-filename":"vm5-system-report_20220509-103645-UTC.tar.gz","core-time-date":1652092617000,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write"}},"/device/crashlog/log":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash info from device","operationId":"getDeviceCrashInformation","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}},{"name":"filename","in":"query","description":"Crash file name","required":true,"schema":{"type":"string","example":"vm1-system-report_20220509-082507-UTC.tar.gz"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Device crash info":{"description":"Device crash info","value":"/bootflash/.prst_sync/reload_info\r\n/bootflash/pd_info/\r\n/bootflash/pd_info/system_report_trigger.log\r\n/bootflash/pd_info/free_mb_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_cpuinfo-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_stat-20220509-082405-UTC.log\r\n/bootflash/pd_info/topnmemuse_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/smap_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_interrupts-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_timer_list-20220509-082405-UTC.log\r\n/bootflash/pd_info/dmesg_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/df_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_sched_debug-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_meminfo-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_loadavg-20220509-082405-UTC.log\r\n/bootflash/pd_info/top_output-20220509-082405-UTC.log\r\n/tmp/vm1-bootuplog-20220509-082507-UTC.log\r\n/tmp/cyan/cyan.log\r\n/tmp/tdlresolve/epoch_dir/\r\n/tmp/tdlresolve/epoch_dir/active\r\n/tmp/tdlresolve/epoch_dir/rp1current\r\n/tmp/tdlresolve/epoch_dir/rp0current\r\n/tmp/tdlresolve/epoch_dir/2022_05_09_05_04_5173.epoch\r\n/tmp/fp/trace/fman_fp_image_pman_F0-0.16083_2.20220509082503.bin\r\n/tmp/fp/trace/cpp_cp_svr_pman_F0-0.17117_2.20220509082454.bin\r\n/tmp/fp/trace/cpp_sp_svr_pman_F0-0.16525_2.20220509082431.bin\r\n/tmp/fp/trace/btman_F0-0.17522_1.20220509081731.bin\r\n/tmp/fp/trace/fman_fp_F0-0.16106_1.20220509070441.bin\r\n/tmp/fp/trace/cpp_cp_F0-0.17128_0.20220509050616.bin\r\n/tmp/fp/trace/btman_pman_F0-0.17512_1.20220509050615.bin\r\n/tmp/fp/trace/cman_fp_F0-0.17317_0.20220509050615.bin\r\n/tmp/fp/trace/cman_fp_pman_F0-0.17307_1.20220509050615.bin\r\n/tmp/fp/trace/cpp_cp_svr_pman_F0-0.17117_1.20220509050614.bin\r\n/tmp/fp/trace/cpp_driver_F0-0.16917_0.20220509050613.bin\r\n/tmp/fp/trace/cpp_driver_pman_F0-0.16904_1.20220509050612.bin\r\n/tmp/fp/trace/cpp_ha_F0-0.16736_0.20220509050612.bin\r\n/tmp/fp/trace/cpp_ha_top_level_server_pman_F0-0.16727_1.20220509050612.bin\r\n/tmp/fp/trace/cpp_sp_F0-0.16538_0.20220509050611.bin\r\n/tmp/fp/trace/cpp_sp_svr_pman_F0-0.16525_1.20220509050611.bin\r\n/tmp/fp/trace/qfpxucodexcxkv_F0-0.16334_0.20220509050611.bin\r\n/tmp/fp/trace/qfp_ucode_cxkv_pman_F0-0.16321_1.20220509050610.bin\r\n/tmp/fp/trace/fman_fp_image_pman_F0-0.16083_1.20220509050609.bin\r\n/tmp/fp/trace/pvp_F0-0.15610_0.20220509050607.bin\r\n/tmp/rp/trace/flashutil_R0-0.9480_0.20220509082506.bin\r\n/tmp/rp/trace/ndbmand_R0-0.20343_2.20220509082506.bin\r\n/tmp/rp/trace/ndbmand_R0-0.20343_1.20220509082506.bin\r\n/tmp/rp/trace/dmiauthd_pman_R0-0.20704_2.20220509082441.bin\r\n/tmp/rp/trace/dmiauthd_R0-0.20711_1.20220509082440.bin\r\n/tmp/rp/trace/cxpd_pman_R0-0.26162_2.20220509082431.bin\r\n/tmp/rp/trace/cfgmgr_pman_R0-0.23017_2.20220509082431.bin\r\n/tmp/rp/trace/ftmd_pman_R0-0.26542_2.20220509082431.bin\r\n/tmp/rp/trace/dbgd_pman_R0-0.26285_12.20220509082430.bin\r\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_19.20220509082427.bin\r\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_18.20220509082427.bin\r\n/tmp/rp/trace/plogd_R0-0.6454_15.20220509082427.bin\r\n/tmp/rp/trace/nginx_pman_R0-0.23917_3.20220509082420.bin\r\n/tmp/rp/trace/nginx_pman_R0-0.23917_2.20220509082420.bin\r\n/tmp/rp/trace/ofa_pman_R0-0.6786_1.20220509082414.bin\r\n/tmp/rp/trace/sessmgrd_pman_R0-0.14700_1.20220509082413.bin\r\n/tmp/rp/trace/install_mgr_pman_R0-0.16776_1.20220509082413.bin\r\n/tmp/rp/trace/flashutil_R0-0.6969_0.20220509082357.bin\r\n/tmp/rp/trace/brelay_R0-0.5073_0.20220509082312.bin\r\n/tmp/rp/trace/droputil_R0-0.7228_41.20220509082309.bin\r\n/tmp/rp/trace/vdaemon_pman_R0-0.23139_27.20220509082256.bin\r\n/tmp/rp/trace/brelay_R0-0.32610_0.20220509082120.bin\r\n/tmp/rp/trace/flashutil_R0-0.31555_0.20220509082116.bin\r\n/tmp/rp/trace/brelay_R0-0.28844_0.20220509082045.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.28714_0.20220509082044.bin\r\n/tmp/rp/trace/plogd_R0-0.6454_14.20220509081556.bin\r\n/tmp/rp/trace/utd_R0-0.21164_0.20220509081511.bin\r\n/tmp/rp/trace/brelay_R0-0.17059_0.20220509081122.bin\r\n/tmp/rp/trace/IOSRP_R0-0.5718_7.20220509080821.bin\r\n/tmp/rp/trace/brelay_R0-0.12315_0.20220509080810.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.12179_0.20220509080808.bin\r\n/tmp/rp/trace/brelay_R0-0.9102_0.20220509080557.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.8987_0.20220509080557.bin\r\n/tmp/rp/trace/dbgd_pman_R0-0.26285_11.20220509080429.bin\r\n/tmp/rp/trace/utd_R0-0.5943_0.20220509080401.bin\r\n/tmp/rp/trace/brelay_R0-0.5873_0.20220509080400.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.5740_0.20220509080359.bin\r\n/tmp/rp/trace/brelay_R0-0.4593_0.20220509080339.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.4475_0.20220509080338.bin\r\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_17.20220509080331.bin\r\n/tmp/rp/trace/netconfxsubsys_R0-0.25635_0.20220509075716.bin\r\n/tmp/rp/trace/ncsshd_R0-0.25630_0.20220509075714.bin\r\n/tmp/rp/trace/ncsshd_R0-0.23604_0.20220509075527.bin\r\n/tmp/rp/trace/ncsshd_R0-0.20871_0.20220509075321.bin\r\n/tmp/rp/trace/utd_R0-0.20557_0.20220509075306.bin\r\n/tmp/rp/trace/utf_R0-0.9196_1.20220509074907.bin\r\n/tmp/rp/trace/IOSRP_R0-0.5718_6.20220509074231.bin\r\n/tmp/rp/trace/btman_R0-0.9196_1.20220509072434.bin\r\n/tmp/rp/trace/vdaemon_R0-0.23144_1.20220509070058.bin\r\n/tmp/rp/trace/fman_rp_R0-0.7340_1.20220509065929.bin\r\n/tmp/rp/trace/ttm_R0-0.26803_0.20220509050940.bin\r\n/tmp/rp/trace/ttmd_pman_R0-0.26797_1.20220509050939.bin\r\n/tmp/rp/trace/ompd_R0-0.26673_0.20220509050939.bin\r\n/tmp/rp/trace/ompd_pman_R0-0.26667_1.20220509050938.bin\r\n/tmp/rp/trace/ftmd_R0-0.26547_0.20220509050937.bin\r\n/tmp/rp/trace/ftmd_pman_R0-0.26542_1.20220509050937.bin\r\n/tmp/rp/trace/fpmd_R0-0.26411_0.20220509050937.bin\r\n/tmp/rp/trace/fpmd_pman_R0-0.26405_1.20220509050936.bin\r\n/tmp/rp/trace/dbgd_R0-0.26292_0.20220509050936.bin\r\n/tmp/rp/trace/cxpd_R0-0.26200_0.20220509050936.bin\r\n/tmp/rp/trace/cxpd_pman_R0-0.26162_1.20220509050933.bin\r\n/tmp/rp/trace/nginx_pman_R0-0.23917_1.20220509050911.bin\r\n/tmp/rp/trace/cfgmgr_R0-0.23065_0.20220509050811.bin\r\n/tmp/rp/trace/cfgmgr_pman_R0-0.23017_1.20220509050809.bin\r\n/tmp/rp/trace/linux_iosd_image_pman_R0-0.5705_2.20220509050747.bin\r\n/tmp/rp/trace/vip_confd_startup_sh_pman_R0-0.21463_0.20220509050629.bin\r\n/tmp/rp/trace/ncsshd_R0-0.21219_0.20220509050628.bin\r\n/tmp/rp/trace/ncsshd_pman_R0-0.21213_0.20220509050628.bin\r\n/tmp/rp/trace/pubd_R0-0.20002_0.20220509050628.bin\r\n/tmp/rp/trace/pvp_R0-0.5111_1.20220509050628.bin\r\n/tmp/rp/trace/ndbmand_R0-0.20343_0.20220509050627.bin\r\n/tmp/rp/trace/ncsshd_bp_pman_R0-0.20969_0.20220509050627.bin\r\n/tmp/rp/trace/dmiauthd_pman_R0-0.20704_1.20220509050626.bin\r\n/tmp/rp/trace/dmiauthd_R0-0.20711_0.20220509050626.bin\r\n/tmp/rp/trace/inter_fru_1_255-F0-0.0.20220509050626.bin\r\n/tmp/rp/trace/ndbmand_pman_R0-0.20333_0.20220509050625.bin\r\n/tmp/rp/trace/pubd_pman_R0-0.19984_0.20220509050624.bin\r\n/tmp/rp/trace/pttcd_R0-0.19704_0.20220509050624.bin\r\n/tmp/rp/trace/pttcd_pman_R0-0.19672_0.20220509050624.bin\r\n/tmp/rp/trace/periodic_sh_pman_R0-0.19258_0.20220509050621.bin\r\n/tmp/rp/trace/sort_files_by_inode_sh_pman_R0-0.18984_0.20220509050620.bin\r\n/tmp/rp/trace/cedge_tanman_sh_pman_R0-0.18381_0.20220509050619.bin\r\n/tmp/rp/trace/reflector_R0-0.7564_1.20220509050619.bin\r\n/tmp/rp/trace/cli_agent_R0-0.8908_0.20220509050618.bin\r\n/tmp/rp/trace/cmand_R0-0.8532_0.20220509050618.bin\r\n/tmp/rp/trace/dbm_R0-0.8111_0.20220509050617.bin\r\n/tmp/rp/trace/smand_R0-0.6034_1.20220509050616.bin\r\n/tmp/rp/trace/emd_R0-0.7821_0.20220509050616.bin\r\n/tmp/rp/trace/hman_R0-0.7098_0.20220509050614.bin\r\n/tmp/rp/trace/install_mgr_R0-0.16783_0.20220509050612.bin\r\n/tmp/rp/trace/install_mgr_pman_R0-0.16776_0.20220509050612.bin\r\n/tmp/rp/trace/sec_key_agent_R0-0.6957_0.20220509050610.bin\r\n/tmp/rp/trace/lman_R0-0.16040_0.20220509050609.bin\r\n/tmp/rp/trace/lman_pman_R0-0.16028_1.20220509050608.bin\r\n/tmp/rp/trace/ofa_R0-0.6790_0.20220509050608.bin\r\n/tmp/rp/trace/smd_R0-0.14706_0.20220509050607.bin\r\n/tmp/rp/trace/repm_R0-0.6188_0.20220509050606.bin\r\n/tmp/rp/trace/sdavc_proxy_R0-0.15234_0.20220509050604.bin\r\n/tmp/rp/trace/sdavc_proxy_pman_R0-0.15219_1.20220509050604.bin\r\n/tmp/rp/trace/sessmgrd_pman_R0-0.14700_0.20220509050602.bin\r\n/tmp/rp/trace/vman_R0-0.14560_0.20220509050602.bin\r\n/tmp/rp/trace/vman_pman_R0-0.14542_1.20220509050601.bin\r\n/tmp/rp/trace/psd_R0-0.5391_0.20220509050558.bin\r\n/tmp/rp/trace/selinux_smu_R0-0.13554_0.20220509050556.bin\r\n/tmp/rp/trace/kernel_ftrace_log_R0-0.13535_0.20220509050556.bin\r\n/tmp/rp/trace/btman_pman_R0-0.9189_1.20220509050455.bin\r\n/tmp/rp/trace/bhytoolsd_R0-0.6308_0.20220509050455.bin\r\n/tmp/rp/trace/cli_agent_pman_R0-0.8886_0.20220509050447.bin\r\n/tmp/rp/trace/binos_R0-0.8442_0.20220509050436.bin\r\n/tmp/rp/trace/dbm_pman_R0-0.8103_0.20220509050428.bin\r\n/tmp/rp/trace/iptbl_R0-0.8093_0.20220509050428.bin\r\n/tmp/rp/trace/emd_pman_R0-0.7817_1.20220509050424.bin\r\n/tmp/rp/trace/fman_rp_pman_R0-0.7329_1.20220509050415.bin\r\n/tmp/rp/trace/hman_pman_R0-0.7093_1.20220509050413.bin\r\n/tmp/rp/trace/keyman_pman_R0-0.6954_1.20220509050409.bin\r\n/tmp/rp/trace/ofa_pman_R0-0.6786_0.20220509050405.bin\r\n/tmp/rp/trace/oom_R0-0.6535_0.20220509050400.bin\r\n/tmp/rp/trace/plogd_pman_R0-0.6432_0.20220509050357.bin\r\n/tmp/rp/trace/repm_pman_R0-0.6181_0.20220509050352.bin\r\n/tmp/rp/trace/smand_pman_R0-0.6030_1.20220509050349.bin\r\n/tmp/rp/trace/psd_pman_R0-0.5318_1.20220509050343.bin\r\n/tmp/rp/trace/psvp_R0-0.5042_0.20220509050336.bin\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_080125.gz\r\n/harddisk/tracelogs/cyaninit_R0-0.5010_0.20220509050340.bin.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_072735.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_080738.gz\r\n/harddisk/tracelogs/dmi_ports_fetch_R0-0.19770_0.20220509050041.bin.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_075711.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_074912.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_070208.gz\r\n/harddisk/tracelogs/btman_rotate_immediate_R0-0.20030_0.20220509050102.bin.gz\r\n/harddisk/tracelogs/btman_rotate_immediate_R0-0.19856_0.20220509050042.bin.gz\r\n/harddisk/tracelogs/system_shell_R0-0.9105_0.20220509080558.bin\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_073035.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_070720.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_080023.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_073738.gz\r\n/harddisk/tracelogs/utf_R0-0.9196_0.20220509050620.bin.gz\r\n/tmp/maroon_stats/pman_rp_0_7093.maroon\r\n/tmp/maroon_stats/pman_rp_0_20333.maroon\r\n/tmp/maroon_stats/pman_fp_0_16083.maroon\r\n/tmp/maroon_stats/pman_fp_0_17117.maroon\r\n/tmp/maroon_stats/pman_rp_0_20704.maroon\r\n/tmp/maroon_stats/pman_rp_0_21463.maroon\r\n/tmp/maroon_stats/pman_rp_0_14542.maroon\r\n/tmp/maroon_stats/pman_rp_0_21213.maroon\r\n/tmp/maroon_stats/pman_rp_0_26162.maroon\r\n/tmp/maroon_stats/pman_fp_0_16525.maroon\r\n/tmp/maroon_stats/pman_rp_0_26667.maroon\r\n/tmp/maroon_stats/pman_fp_0_16904.maroon\r\n/tmp/maroon_stats/pman_rp_0_26542.maroon\r\n/tmp/maroon_stats/pman_rp_0_23017.maroon\r\n/tmp/maroon_stats/pman_rp_0_26405.maroon\r\n/tmp/maroon_stats/pman_rp_0_26797.maroon\r\n/tmp/maroon_stats/pman_rp_0_6432.maroon\r\n/tmp/maroon_stats/pman_rp_0_20969.maroon\r\n/tmp/maroon_stats/pman_rp_0_23917.maroon\r\n/tmp/maroon_stats/pman_fp_0_16321.maroon\r\n/tmp/maroon_stats/pman_fp_0_17307.maroon\r\n/tmp/maroon_stats/pman_fp_0_16727.maroon\r\n/tmp/maroon_stats/pman_fp_0_17512.maroon\r\n/tmp/maroon_stats/pman_rp_0_5705.maroon\r\n/tmp/maroon_stats/pman_rp_0_6030.maroon\r\n/tmp/maroon_stats/pman_rp_0_5318.maroon\r\n/tmp/maroon_stats/pman_rp_0_19984.maroon\r\n/tmp/maroon_stats/pman_rp_0_19258.maroon\r\n/tmp/maroon_stats/pman_rp_0_7329.maroon\r\n/tmp/maroon_stats/pman_rp_0_8886.maroon\r\n/tmp/maroon_stats/pman_rp_0_6954.maroon\r\n/tmp/maroon_stats/pman_rp_0_6181.maroon\r\n/tmp/maroon_stats/pman_rp_0_6786.maroon\r\n/tmp/maroon_stats/pman_rp_0_9189.maroon\r\n/tmp/maroon_stats/pman_rp_0_8103.maroon\r\n/tmp/maroon_stats/pman_rp_0_7817.maroon\r\n/tmp/maroon_stats/pman_rp_0_14700.maroon\r\n/tmp/maroon_stats/pman_rp_0_15219.maroon\r\n/tmp/maroon_stats/pman_rp_0_18381.maroon\r\n/tmp/maroon_stats/pman_rp_0_18984.maroon\r\n/tmp/maroon_stats/pman_rp_0_16028.maroon\r\n/tmp/maroon_stats/pman_rp_0_16776.maroon\r\n/tmp/maroon_stats/pman_rp_0_19672.maroon\r\n/tmp/maroon_stats/pman_rp_0_8528.maroon\r\n/tmp/maroon_stats/rotee_rp_0_13790.maroon\r\n/tmp/maroon_stats/pman_rp_0_26285.maroon\r\n/tmp/maroon_stats/ucode_pkt_PPE0_fp_0_16334.maroon\r\n/tmp/maroon_stats/keyman_rp_0_6957.maroon\r\n/tmp/maroon_stats/fpmd_rp_0_26411.maroon\r\n/tmp/maroon_stats/cxpd_rp_0_26200.maroon\r\n/tmp/maroon_stats/dbgd_rp_0_26292.maroon\r\n/tmp/maroon_stats/ompd_rp_0_26673.maroon\r\n/tmp/maroon_stats/ttmd_rp_0_26803.maroon\r\n/tmp/maroon_stats/ftmd_rp_0_26547.maroon\r\n/tmp/maroon_stats/pman_rp_0_23139.maroon\r\n/tmp/maroon_stats/cfgmgr_rp_0_23065.maroon\r\n/tmp/maroon_stats/vdaemon_rp_0_23144.maroon\r\n/tmp/maroon_stats/dmiauthd_rp_0_20711.maroon\r\n/tmp/maroon_stats/pubd_rp_0_20002.maroon\r\n/tmp/maroon_stats/ndbmand_rp_0_20343.maroon\r\n/tmp/maroon_stats/ncsshd_bp_rp_0_20977.maroon\r\n/tmp/maroon_stats/rotee_FRU_SLOT_NUM_7228.maroon\r\n/tmp/maroon_stats/install_mgr_rp_0_16783.maroon\r\n/tmp/maroon_stats/lman_rp_0_16040.maroon\r\n/tmp/maroon_stats/btman_fp_0_17522.maroon\r\n/tmp/maroon_stats/cman_fp_fp_0_17317.maroon\r\n/tmp/maroon_stats/cpp_cp_svr_fp_0_17128.maroon\r\n/tmp/maroon_stats/vman_rp_0_14560.maroon\r\n/tmp/maroon_stats/cpp_driver_fp_0_16917.maroon\r\n/tmp/maroon_stats/cpp_sp_svr_fp_0_16538.maroon\r\n/tmp/maroon_stats/cpp_ha_top_leve_fp_0_16736.maroon\r\n/tmp/maroon_stats/fman_fp_image_fp_0_16106.maroon\r\n/tmp/maroon_stats/cli_agent_rp_0_8908.maroon\r\n/tmp/maroon_stats/dbm_rp_0_8111.maroon\r\n/tmp/maroon_stats/linux_iosd-imag_rp_0_5718.maroon\r\n/tmp/maroon_stats/btman_rp_0_9196.maroon\r\n/tmp/maroon_stats/fman_rp_rp_0_7340.maroon\r\n/tmp/maroon_stats/cmand_rp_0_8532.maroon\r\n/tmp/maroon_stats/emd_rp_0_7821.maroon\r\n/tmp/maroon_stats/plogd_rp_0_6454.maroon\r\n/tmp/maroon_stats/hman_rp_0_7098.maroon\r\n/tmp/maroon_stats/repm_rp_0_6188.maroon\r\n/tmp/maroon_stats/smand_rp_0_6034.maroon\r\n/tmp/maroon_stats/psd_rp_0_5391.maroon\r\n/tmp/maroon_stats/sessmgrd_rp_0_14706.maroon\r\n/var/log/audit/audit.log"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/crashlog/synced":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash logs synchronously from device","operationId":"getDeviceCrashLogsSynced","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device crash logs":{"description":"Device crash logs","value":{"data":[{"vdevice-name":"172.16.255.11","createTimeStamp":1649439701737,"index":0,"core-filename":"vm1-system-report_20220407-031603-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"ThuApr703:16:10UTC2022","vdevice-dataKey":"172.16.255.11-0","@rid":855,"vmanage-system-ip":"172.16.255.11","lastupdated":1649769370563,"core-time-date":1649301370000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651156427829,"index":1,"core-filename":"vm1-system-report_20220428-124017-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"ThuApr2812:40:32UTC2022","vdevice-dataKey":"172.16.255.11-1","@rid":1224,"vmanage-system-ip":"172.16.255.11","lastupdated":1651156427519,"core-time-date":1651149632000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651156431854,"index":2,"core-filename":"vm1-system-report_20220428-125006-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"ThuApr2812:50:11UTC2022","vdevice-dataKey":"172.16.255.11-2","@rid":1225,"vmanage-system-ip":"172.16.255.11","lastupdated":1651156427519,"core-time-date":1651150211000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651708111493,"index":4,"core-filename":"vm1_ftmd_25306_20220504-112749-UTC.core.gz","vdevice-host-name":"vm1","core-time":"WedMay411:28:57UTC2022","vdevice-dataKey":"172.16.255.11-4","@rid":1250,"vmanage-system-ip":"172.16.255.11","lastupdated":1651708111141,"core-time-date":1651663737000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651505130582,"index":3,"core-filename":"vm1-system-report_20220504-040557-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"WedMay404:06:43UTC2022","vdevice-dataKey":"172.16.255.11-3","@rid":1463,"vmanage-system-ip":"172.16.255.11","lastupdated":1651637687479,"core-time-date":1651637203000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write"}},"/device/csp/containers/container":{"get":{"tags":["Real-Time Monitoring - Container Lifecycle"],"description":"Get device container from device (Real Time)","operationId":"createDeviceContainersInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"device container":{"description":"device container","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"ISRV","uuid":"C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0","memory":"4096","numcpu":"4","disk_size":"4096","image-name":"example.tar.gz","container_type":"virtual","port":"22","state":"running","error":"NA","uptime":"4:20:09:2","cpu_load":"2","disk_used_mb":"2048","memory_used_kb":"8192","ip-address":"192.168.30.163","ip-address-configured":"false","netmask":"255.255.255.0","default-gw":"127.0.1.254","bridge":"ovs-data-br","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/pnic":{"get":{"tags":["Real-Time Monitoring - RBAC"],"description":"Get pnic interfaces from device","operationId":"getPnicStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PNIC interfaces":{"description":"PNIC interfaces","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"eth0","operational-speed":"1G","operational-duplex":"full-duplex","autoneg":"auto","member_of":"pc","link_state":"up","lldp":"enabled","mac_address":"d8:b1:90:ff:f5:88","vdevice-dataKey":"172.16.255.15","mtu":"900","refcnt":"110","bytes":"1469476983","packets":"17749881","errors":"0","dropped":"0","broadcast":"14159834","multicast":"2889066","tx-bytes":"198318715","tx-packets":"272603","tx-errors":"0","tx-dropped":"0","tx-broadcast":"14156964","tx-multicast":"2888574","lastupdated":1661501479353,"pkt-capture":"ICMP"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/csp/pnic/synced":{"get":{"tags":["Real-Time Monitoring - RBAC"],"description":"Get pnic stats from device","operationId":"getPNICStatsFromDevice","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PNIC stats":{"description":"PNIC stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"eth0","operational-speed":"1G","operational-duplex":"full-duplex","autoneg":"auto","member_of":"pc","link_state":"up","lldp":"enabled","mac_address":"d8:b1:90:ff:f5:88","vdevice-dataKey":"172.16.255.15","mtu":"900","refcnt":"110","bytes":"1469476983","packets":"17749881","errors":"0","dropped":"0","broadcast":"14159834","multicast":"2889066","tx-bytes":"198318715","tx-packets":"272603","tx-errors":"0","tx-dropped":"0","tx-broadcast":"14156964","tx-multicast":"2888574","lastupdated":1661501479353,"pkt-capture":"ICMP"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/csp/rbac":{"get":{"tags":["Real-Time Monitoring - RBAC"],"description":"Get RBAC interfaces from device","operationId":"getRBACInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device RBAC interface":{"description":"Device RBAC interface","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","name":"rbac_user","password":"Nbv12345","role":"network-admin","active":"true","last_5_passwords":"Nbv12345","last-login-ts":"21:43:28 UTC Mon Aug 27 2022","lastupdated":1661501479353,"vdevice-dataKey":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/csp/resources/cpu-info/allocation":{"get":{"tags":["Real-Time Monitoring - NetworkHub Resources"],"description":"Get NetworkHub CPU allocation info from device","operationId":"getAllocationInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NetworkHub CPU allocation info":{"description":"NetworkHub CPU allocation info","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","total-sockets":"1","cores-per-socket":"8","total-logical-cpus":"16","logical-cpus-used-by-system":"2","logical-cpus-used-by-vnfs":"4","logical-cpus-used-dedicated":"12","logical-cpus-used-sharable":"2","lastupdated":1661501479353,"vdevice-dataKey":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/csp/resources/cpu-info/cpus":{"get":{"tags":["Real-Time Monitoring - NetworkHub Resources"],"description":"Get NetworkHub CPU info from device","operationId":"getCPUInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NetworkHub CPU info":{"description":"NetworkHub CPU info","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","cpu-id":"7","socket-id":"0","vdevice-dataKey":"172.16.255.11","core-id":"7","system-use":false,"name":"ROUTER3","vcpus":"4","low-latency":true,"vcpu-id":"0","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/csp/resources/cpu-info/vnfs":{"get":{"tags":["Real-Time Monitoring - NetworkHub Resources"],"description":"Get NetworkHub CPU VNF info from device","operationId":"getVNFInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NetworkHub CPU VNF info":{"description":"NetworkHub CPU VNF info","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","name":"ROUTER3","vcpus":"4","low-latency":true,"vcpu-id":"0","socket-id":"0","core-id":"7","cpu-id":"7","vdevice-dataKey":"172.16.255.11","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/csp/system/native":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system native settings from device","operationId":"createDeviceSystemSettingNativeInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system native settings":{"description":"Device system native settings","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","interface":"ge0/0","ipv4_address":"192.168.2.1","vdevice-dataKey":"172.16.255.15","netmask":"255.255.255.0","mac_address":"00:05:ad:00:10:41","mtu":"1500","txqueuelen":"16","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/system/processlist":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system process list from device","operationId":"createDeviceSystemProcessList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system process list":{"description":"Device system process list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","pid":"1","cpu":"3.5","mem":"1,6","vsz":"192156","rss":"7424","start":"Wed16","time":"0:00.02","vdevice-dataKey":"172.16.255.15","cmd":"systemd","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/system/settings":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system settings from device","operationId":"createDeviceSystemSetting","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system settings":{"description":"Device system settings","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","interface":"ge0/0","ipv4_address":"192.168.30.163","ipv4_netmask":"255.255.255.0","ipv4_dhcp":"enabled","ipv4_expire":"-","global_ipv6_address":"fe80::72db:98ff:fe07:1f35","global_prefixlen":"0","link_local_ipv6_address":"fe80::72db:98ff:fe07:1f35","link_local_prefixlen":"0","ipv6_dhcp":"enabled","ipv6_slaac":"disabled","vdevice-dataKey":"172.16.255.15","ipv6_dhcp_state":"Stateful","lastupdated":"1661501479353"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/system/status":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system status from device","operationId":"createDeviceSystemStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system status":{"description":"Device system status","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"wan-br","status":"OK","vdevice-dataKey":"172.16.255.15","type":"default-bridge","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/ctsPac":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec PAC information from device","operationId":"getCtsPac","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec PAC information":{"description":"TrustSec PAC information","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","pac-type":"Cisco Trustse","authority-id":"Authority ","initiator-id":"device1","vdevice-dataKey":"172.16.255.15-vm5","authority-id-info":"acs1","pac-life-time":"13:59:27 PDT Jun 5 2022","pac-refresh-time":"00:01:24","pac-opaque":"000200B000030001000400101100E046659D4275B644BF946EFA49CD00060094000301008285A14CB259CA096487096D68D5F34D000000014C09A6AA00093A808ACA80B39EB656AF0BCA91F3564DF540447A11F9ECDFA4AEC3A193769B80066832495B8C40F6B5B46B685A68411B7DF049A32F2B03F89ECF948AC4BB85CF855CA186BEF8E2A8C69A7C0BE1BDF6EC27D826896A31821A7BA523C8BD90072CB8A8D0334F004D4B627D33001B0519D41738F7EDDF3A"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/devicestatus":{"get":{"tags":["Monitoring - Device Details"],"description":"Get devices status per type","operationId":"getDeviceOnlyStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceStatusData"},"examples":{"Device Status":{"description":"Device Status","value":"[\n {\n \"type\": \"vSmart\",\n \"name\": \"vSmart\",\n \"image\": \"images/vsmart.png\",\n \"count\": 3,\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart\",\n \"statusList\": [\n {\n \"status\": \"error\",\n \"name\": \"Error\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=error\",\n \"color\": \"fa7c7d\",\n \"icon\": \"images/device/device-error.png\",\n \"count\": 0\n },\n {\n \"status\": \"warning\",\n \"name\": \"Warning\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=warning\",\n \"color\": \"f2ce60\",\n \"icon\": \"images/device/device-warning.png\",\n \"count\": 0\n },\n {\n \"status\": \"normal\",\n \"name\": \"Normal\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=normal\",\n \"color\": \"b0e276\",\n \"icon\": \"images/device/device-normal.png\",\n \"count\": 3\n },\n {\n \"status\": \"new\",\n \"name\": \"Discovered device\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=new\",\n \"color\": \"7c8afa\",\n \"icon\": \"images/device/device-new.png\",\n \"count\": 0\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/dhcp/client":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCP client from device (Real Time)","operationId":"getDHCPClient","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DHCP client":{"description":"DHCP client","value":{"data":[{"lease-server-addr":"10.0.1.1","state":"dhcp-client-state-bound","if-name":"GigabitEthernet1","dns-address-secondary":"0.0.0.0","subnet-mask":"255.255.255.0","client-addr":"10.0.1.5","lease-remaining":"3143","gateway-addr":"0.0.0.0","dns-address":"10.0.1.1","vdevice-dataKey":"169.254.10.12-Mgmt-intf-GigabitEthernet1","vrf-name":"Mgmt-intf","lastupdated":1643101911868,"vdevice-host-name":"vm5","vdevice-name":"169.254.10.12","lease-time":"3600"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dhcp/interface":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCP interfaces from device (Real Time)","operationId":"getDHCPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DHCP interfaces":{"description":"DHCP interfaces","value":{"data":[{"server":"10.0.1.1","vdevice-dataKey":"169.254.10.10-512-eth0","lease-time":"0:01:00:00","vdevice-name":"169.254.10.10","ifname":"eth0","acquired-ip":"10.0.1.3/24","dns":"10.0.1.1","lastupdated":1643013783968,"time-remaining":"0:00:31:25","state":"bound","vpn-id":"512","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dhcp/server":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCP server from device (Real Time)","operationId":"getDHCPServer","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DHCP server":{"description":"DHCP server","value":{"data":[{"vdevice-dataKey":"169.254.10.9-10-ge0/0-","vdevice-name":"169.254.10.9","ifname":"ge0/0","lastupdated":1655094784187,"vpn-id":"10","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dhcpv6/interface":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCPv6 interfaces from device","operationId":"getDHCPv6Interface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device DHCP v6 interface":{"description":"Device DHCP v6 interface","value":{"data":[{"vdevice-dataKey":"169.254.10.10-512-eth0","vdevice-name":"169.254.10.10","ifname":"eth0","lastupdated":1646099652315,"state":"init","vpn-id":"512","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dot1x/clients":{"get":{"tags":["Real-Time Monitoring - DOT1x"],"description":"Get DOT1x client from device (Real Time)","operationId":"getWLANDOT1xClients","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DOT1x client":{"description":"DOT1x client","value":{"data":[{"vdevice-name":"172.16.254.2","vdevice-host-name":"vm3","if-name":"ge0/1","mac-address":"00:50:b6:0f:1c:84","auth-state":"Authenticating","auth-method":"Radius","vlan":"12","vpn":"-","eap-method":"(PEAP)","username":"admin","session-time":"9","connected-time":"9","inactive-time":"0","session-id":"57E1B641-00000001","eapol-frames-rx":"50","eapol-frames-tx":"50","eapol-start-frames-rx":"50","eapol-logoff-frames-rx":"50","eapol-request-id-frames-tx":"50","eapol-response-id-frames-rx":"50","eapol-request-frames-tx":"50","eapol-request-frames-rx":"50","lastupdated":1657853484627,"vdevice-dataKey":"172.16.254.2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dot1x/interfaces":{"get":{"tags":["Real-Time Monitoring - DOT1x"],"description":"Get DOT1x interface from device (Real Time)","operationId":"getWLANDOT1xInterfaces","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DOT1x interface":{"description":"DOT1x interface","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","if-name":"ge0/1","oper-state":"up","host-mode":"Multi Auth","ctrl-dir":"none","mab-server":"true","mab-local":"true","wake-on-lan":"true","reauth-timeout":"600","inactivity-timeout":"3600","guest-vlan":"11","auth-fail-vlan":"12","auth-reject-vlan":"13","default-vlan":"","primary-radius-server":"192.168.48.12","secondary-radius-server":"192.168.48.11","accounting-interval":"disabled","nas-identifier":"none","nas-ipaddr":"none","num-clients":"1","lastupdated":1654066320000,"vdevice-dataKey":"172.16.254.1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dot1x/radius":{"get":{"tags":["Real-Time Monitoring - DOT1x"],"description":"Get DOT1x Radius from device (Real Time)","operationId":"getDOT1xRadius","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DOT1x Radius":{"description":"DOT1x Radius","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","if-name":"ge0/1","ip-address":"192.168.48.11","vpn":"512","is-primary":"true","auth-port":"1812","auth-is-current":"true","auth-round-trip-time":"0","auth-access-requests":"10","auth-access-retransmissions":"0","auth-access-accepts":"1","auth-access-rejects":"0","auth-access-challenges":"9","auth-malformed-access-responses":"0","auth-bad-authenticators":"0","auth-pending-requests":"0","auth-timeouts":"0","auth-unknown-types":"0","auth-packets-dropped":"0","acct-port":"1813","acct-is-current":"true","acct-round-trip-time":"0","acct-requests":"5","acct-retransmissions":"0","acct-responses":"2","acct-malformed-responses":"0","acct-bad-authenticators":"0","acct-pending-requests":"0","acct-timeouts":"3","acct-unknown-types":"0","acct-packets-dropped":"0","vdevice-dataKey":"172.16.254.1","lastupdated":1654066320000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/downloadedImages":{"get":{"tags":["Configuration - Downloaded Images"],"description":"Get images list from device","operationId":"createSoftwareList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1644801887912,"downloadedImages":"[]","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dpi/application-mapping":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI supported application list from device","operationId":"getSupportedApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI supported application list":{"description":"DPI supported application list","value":{"data":[{"name":"an","family":"network-service","familyShort":"network_service","longname":"ActiveNetworks","appId":"861"},{"name":"bb","family":"network-management","familyShort":"network_management","longname":"Systemsandnetworkmonitoringtool","appId":"50333632"},{"name":"fc","family":"network-service","familyShort":"network_service","longname":"FibreChannel","appId":"16777349"},{"name":"il","family":"network-service","familyShort":"network_service","longname":"InternalLinkTransportProtocol","appId":"16777256"},{"name":"ns","family":"network-service","familyShort":"network_service","longname":"NetworkSystems","appId":"50332408"},{"name":"sm","family":"network-service","familyShort":"network_service","longname":"SM","appId":"16777338"},{"name":"st","family":"network-service","familyShort":"network_service","longname":"Stream","appId":"16777221"},{"name":"3pc","family":"network-service","familyShort":"network_service","longname":"ThirdPartyConnectProtocol","appId":"16777250"},{"name":"acp","family":"network-service","familyShort":"network_service","longname":"AeolonCoreProtocol","appId":"50332247"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/application/fields":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI query field from device","operationId":"getDPIDeviceFieldJSON","parameters":[{"name":"isDeviceDashBoard","in":"query","description":"Flag whether is device dashboard request","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI query field":{"description":"DPI query field","value":{"data":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"EventTime","options":[{"enableDateFields":false,"number":"24","value":"Last24hours","key":"last_24_hours"},{"enableDateFields":false,"number":"12","value":"Last12hours","key":"last_12_hours"},{"enableDateFields":false,"number":"6","value":"Last6hours","key":"last_6_hours"},{"enableDateFields":false,"number":"3","value":"Last3hours","key":"last_3_hours"},{"enableDateFields":false,"number":"1","value":"Last1hour","key":"last_1_hour"},{"enableDateFields":false,"number":"168","value":"Last7days","key":"last_168_hours"}]},{"isRequired":true,"fieldData":{"type":"url","url":"dataservice/device/action/vpn"},"dataType":"int","property":"vpn_id","name":"VPN","multiSelect":false},{"isRequired":true,"dataType":"string","property":"vdevice_name","name":"Devicename","multiSelect":false,"isHidden":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI applications from device (Real Time)","operationId":"createDPICollectorList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"family","in":"query","description":"Family","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI applications":{"description":"DPI applications","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network_service","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-management","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-service","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-management","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-service","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dpi/common/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI common application list from device","operationId":"getCommonApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI common application list":{"description":"DPI common application list","value":{"data":[{"name":"3com-amp3","familyShort":"network-service","longname":"3ComAMP3","family":"NetworkService","qosmosName":"3com-amp3","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"3com-tsmux","familyShort":"network-service","longname":"3ComTSMUX","family":"NetworkService","qosmosName":"3com-tsmux","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"3pc","familyShort":"network-service","longname":"ThirdPartyConnect","family":"NetworkService","qosmosName":"3pc","qosmosFamily":"network_service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"4chan","familyShort":"web","longname":"4CHAN","family":"Web","qosmosName":"4chan","qosmosFamily":"web","trafficClass":"transactional-data","businessRelevance":"business-irrelevant"},{"name":"58-city","familyShort":"web","longname":"58City","family":"Web","qosmosName":"58com","qosmosFamily":"web","trafficClass":"transactional-data","businessRelevance":"business-irrelevant"},{"name":"914c/g","familyShort":"terminal","longname":"TexasInstruments914Terminal","family":"Terminal","qosmosName":"914c/g","qosmosFamily":"terminal","trafficClass":"ops-admin-mgmt","businessRelevance":"business-relevant"},{"name":"9pfs","familyShort":"network-service","longname":"9P","family":"NetworkService","qosmosName":"9p","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"abc-news","familyShort":"web","longname":"ABCNews","family":"Web","qosmosName":"abcnews","qosmosFamily":"web","trafficClass":"transactional-data","businessRelevance":"business-irrelevant"},{"name":"acap","familyShort":"network-management","longname":"ApplicationConfigurationAccessProtocol","family":"NetworkManagement","qosmosName":"acap","qosmosFamily":"network-management","trafficClass":"ops-admin-mgmt","businessRelevance":"business-relevant"},{"name":"acas","familyShort":"network-service","longname":"ACAServices","family":"NetworkService","qosmosName":"acas","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/device/fields":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI field from device","operationId":"getDPIFieldJSON","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI field":{"description":"DPI field","value":{"data":[{"property":"entry_time","name":"EventTime","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_24_hours","value":"Last24hours","number":"24","enableDateFields":false},{"key":"last_12_hours","value":"Last12hours","number":"12","enableDateFields":false},{"key":"last_6_hours","value":"Last6hours","number":"6","enableDateFields":false},{"key":"last_3_hours","value":"Last3hours","number":"3","enableDateFields":false},{"key":"last_1_hour","value":"Last1hour","number":"1","enableDateFields":false},{"key":"last_168_hours","value":"Last7days","number":"168","enableDateFields":false}]},{"property":"application","name":"Application","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/devicedetails/fields":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI detailed field from device","operationId":"getDPIDeviceDetailsFieldJSON","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI detailed field":{"description":"DPI detailed field","value":{"data":[{"property":"entry_time","name":"EventTime","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_24_hours","value":"Last24hours","number":"24","enableDateFields":false},{"key":"last_12_hours","value":"Last12hours","number":"12","enableDateFields":false},{"key":"last_6_hours","value":"Last6hours","number":"6","enableDateFields":false},{"key":"last_3_hours","value":"Last3hours","number":"3","enableDateFields":false},{"key":"last_1_hour","value":"Last1hour","number":"1","enableDateFields":false},{"key":"last_168_hours","value":"Last7days","number":"168","enableDateFields":false}]},{"property":"application","name":"Application","isRequired":true,"multiSelect":false,"dataType":"string"},{"property":"vdevice_name","name":"Devicename","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/flows":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI flow list from device (Real Time)","operationId":"createDPIFlowsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"src-ip","in":"query","description":"Source IP","schema":{"type":"string"}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"family","in":"query","description":"Family","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI flows":{"description":"DPI flows","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.2","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.3","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.4","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.5","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.6","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dpi/qosmos-static/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI QoSMos static application list","operationId":"getQosmosStaticApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI QoSMos static application list":{"description":"DPI QoSMos static application list","value":{"data":[{"name":"9p","family":"FileServer","familyShort":"file_server","longname":"Plan9FilesystemProtocol","appId":"3430"},{"name":"ah","family":"NetworkService","familyShort":"network_service","longname":"AuthenticationHeader","appId":"720"},{"name":"dr","family":"Web","familyShort":"web","longname":"Dr.dk","appId":"2043"},{"name":"dv","family":"Web","familyShort":"web","longname":"DV.is","appId":"1861"},{"name":"hs","family":"Web","familyShort":"web","longname":"Hs.fi(HelsinginSanomat)","appId":"2097"},{"name":"il","family":"NetworkService","familyShort":"network_service","longname":"InternetLink(Transportprotocol)","appId":"637"},{"name":"ip","family":"NetworkService","familyShort":"network_service","longname":"InternetProtocol","appId":"81"},{"name":"ja","family":"Web","familyShort":"web","longname":"Ja.is","appId":"1897"},{"name":"mk","family":"Web","familyShort":"web","longname":"Mk.co.kr","appId":"1213"},{"name":"mq","family":"ApplicationService","familyShort":"application_service","longname":"IBMWebsphereMQ","appId":"312"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/qosmos/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI QoSMos application list from device","operationId":"getQosmosApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI QoSMos application list":{"description":"DPI QoSMos application list","value":{"data":[{"name":"an","family":"network-service","familyShort":"network_service","longname":"ActiveNetworks","appId":"861"},{"name":"bna","family":"network-service","familyShort":"network_service","longname":"BNA","appId":"803"},{"name":"box","family":"web","familyShort":"web","longname":"Box","appId":"1074"},{"name":"dls","family":"network-service","familyShort":"network_service","longname":"DirectoryLocationService","appId":"1078"},{"name":"dmp","family":"audio-video","familyShort":"audio_video","longname":"CiscoDigitalMediaPlayer","appId":"1422"},{"name":"apple-location-services","family":"application-service","familyShort":"application_service","longname":"AppleLocationServices","appId":"294"},{"name":"apple-push-notification","family":"application-service","familyShort":"application_service","longname":"ApplePushNotificationService","appId":"1169"},{"name":"sixtofour-ipv6-tunneled","family":"network-service","familyShort":"network_service","longname":"SixtofourIPv6Tunneled","appId":"1223"},{"name":"internet-audio-streaming","family":"instant-messaging","familyShort":"instant_messaging","longname":"InternetAudioStreamingWebApps","appId":"1514"},{"name":"internet-video-streaming","family":"web","familyShort":"web","longname":"InternetVideoStreamingWebApps","appId":"1513"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/device/dpi/summary":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI summary from device (Real Time)","operationId":"createDPISummaryRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI applications":{"description":"DPI applications","value":{"data":[{"flows-expired":"0","vdevice-dataKey":"169.254.10.10","flows-created":"0","vdevice-name":"169.254.10.10","current-flows":"0","peak-rate":"0","current-rate":"0","lastupdated":1643014386555,"vdevice-host-name":"vm3","status":"disable","peak-flows":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dpi/supported-applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get supported applications from device (Real Time)","operationId":"createDPIStatistics","parameters":[{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"family","in":"query","description":"Family","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI applications":{"description":"DPI applications","value":{"data":[{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-an","application":"an","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Active Networks","vdevice-host-name":"vm3"},{"family-long-name":"network-management","vdevice-dataKey":"169.254.10.10-bb","application":"bb","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_management","application-long-name":"Systems and network monitoring tool","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-fc","application":"fc","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Fibre Channel","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-il","application":"il","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Internal Link Transport Protocol","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-ns","application":"ns","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Network Systems","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-sm","application":"sm","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"SM","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-st","application":"st","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Stream","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-3pc","application":"3pc","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Third Party Connect Protocol","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-acp","application":"acp","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Aeolon Core Protocol","vdevice-host-name":"vm3"},{"family-long-name":"erp","vdevice-dataKey":"169.254.10.10-adp","application":"adp","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"erp","application-long-name":"Automatic Data Processing","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dre/auto-bypass-stats":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE auto-bypass statistics","operationId":"getDreAutoBypassStats","parameters":[{"name":"appqoe-dre-auto-bypass-server-ip","in":"query","description":"Server IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"appqoe-dre-auto-bypass-port","in":"query","description":"Port","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Auto-Bypass Stats":{"description":"DRE Auto-Bypass Stats","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","appqoe-dre-auto-bypass-server-ip":"10.0.0.1","appqoe-dre-auto-bypass-port":"9088","appqoe-dre-auto-bypass-state":"Monitor","appqoe-dre-auto-bypass-dre-lan-bytes":48887002724,"appqoe-dre-auto-bypass-dre-wan-bytes":49401300299,"appqoe-dre-auto-bypass-dre-comp":0,"appqoe-dre-auto-bypass-last-update":"13:41:51","appqoe-dre-auto-bypass-entry-creation-time":"03:08:53","lastupdated":1645775163290,"vdevice-dataKey":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dre/dre-stats":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE statistics","operationId":"getDreStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Stats":{"description":"DRE Stats","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","data-total-cons":325071,"data-max-cons":704,"data-active-cons":0,"data-total-orig-bytes":6743098654720,"data-total-opt-bytes":3039763103744,"data-reduction-ratio":54,"data-cache-status":"Active","data-cache-size":426322690048,"data-cache-used-percent":93,"data-cache-oldest-data":"17:13:53:40","data-data-replaced":0,"lastupdated":1645775163290,"vdevice-dataKey":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dre/dre-status":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE status","operationId":"getDreStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Status":{"description":"DRE Status","value":{"data":[{"lastupdated":1645775163290,"appqoe-dre-status-health-status":"dre-status-disabled","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dre/peer-stats":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE peer statistics","operationId":"getDrePeerStats","parameters":[{"name":"appqoe-dre-stats-peer-system-ip","in":"query","description":"System IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"appqoe-dre-stats-peer-peer-no","in":"query","description":"Peer Number","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Peer Stats":{"description":"DRE Peer Stats","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","appqoe-dre-stats-peer-peer-no":"0","appqoe-dre-stats-peer-system-ip":"209.165.201.1","appqoe-dre-stats-peer-hostname":"dreopt","appqoe-dre-stats-peer-active-cons":"0","appqoe-dre-stats-peer-total-cons":"3714","lastupdated":1652171693495,"vdevice-dataKey":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dualStaticRouteTracker":{"get":{"tags":["Real-Time Monitoring - Dual Static Route Tracker Service"],"description":"Get dual static route tracker info from device","operationId":"getDualStaticRouteTrackerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Dual static route tracker info":{"description":"Dual static route tracker info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/eigrp/interface":{"get":{"tags":["Real-Time Monitoring - EIGRP"],"description":"Get EIGRP interface list from device (Real Time)","operationId":"createEIGRPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"EIGRP interface list":{"description":"EIGRP interface list","value":{"data":[{"vdevice-name":"169.254.10.13","vdevice-host-name":"vm6","name":"GigabitEthernet0","passive":"GigabitEthernet0/0","hello-interval":"5","hold-timer":"15","auth-mode":"md5","lastupdated":1654586532070,"vdevice-dataKey":"169.254.10.13-eigrp-af-ipv4-0.0.0.0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/eigrp/route":{"get":{"tags":["Real-Time Monitoring - EIGRP"],"description":"Get EIGRP route from device (Real Time)","operationId":"createEIGRPRoute","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"EIGRP route":{"description":"EIGRP route","value":{"data":[{"vdevice-name":"169.254.10.13","afi":"eigrp-af-ipv4","origin":"eigrp-origin-redistributed","infosource":"0.0.0.0","omp-tag":"0","succ-metric":"0","vdevice-host-name":"vm6","nexthop":"172.16.254.2","vdevice-dataKey":"169.254.10.13-eigrp-af-ipv4-0.0.0.0","metric":"1","lastupdated":1654586532070},{"vdevice-name":"169.254.10.13","afi":"eigrp-af-ipv4","origin":"eigrp-origin-redistributed","infosource":"0.0.0.0","omp-tag":"0","succ-metric":"0","vdevice-host-name":"vm6","nexthop":"172.16.254.4","vdevice-dataKey":"169.254.10.13-eigrp-af-ipv4-0.0.0.0","metric":"1","lastupdated":1654586532070}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/eigrp/topology":{"get":{"tags":["Real-Time Monitoring - EIGRP"],"description":"Get EIGRP topology info from device (Real Time)","operationId":"createEIGRPTopology","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"EIGRP topology info":{"description":"EIGRP topology info","value":{"data":[{"vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15-0----","vdevice-name":"172.16.255.15","topo-id":"0","lastupdated":1649307997571}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/enableSDAVC/{deviceIP}/{enable}":{"post":{"tags":["Monitoring - Device Details"],"description":"Enable/Disable SDAVC on device","operationId":"enableSDAVCOnDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}},{"name":"enable","in":"path","description":"Enable/Disable flag","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/endpointTracker":{"get":{"tags":["Real-Time Monitoring - Endpoint Tracker Service"],"description":"Get endpoint tracker info from device","operationId":"getEndpointTrackerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Endpoint tracker info":{"description":"Endpoint tracker info","value":{"data":[{"record-name":"test","if-name":"GigabitEthernet1","lastupdated":1650794336441,"actual-delay":"4294967295","vdevice-dataKey":"172.16.255.15-vm5-GigabitEthernet1","state":"tracker-if-state-down","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/endpointTrackerGroup":{"get":{"tags":["Real-Time Monitoring - Endpoint Tracker Group Service"],"description":"Get endpoint tracker group info from device","operationId":"getEndpointTrackerGroupInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Endpoint tracker group info":{"description":"Endpoint tracker group info","value":{"data":[{"oper":"tracker-group-oper-and","name":"tracker1","vdevice-dataKey":"172.16.255.15-vm5-tracker3_tracker-group","elem-state":"tracker-if-state-down","lastupdated":1650866884165,"actual-delay":"4294967295","group-name":"tracker3","group-state":"tracker-if-state-down","attach-point-name":"tracker3_tracker-group","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"oper":"tracker-group-oper-and","name":"tracker2","vdevice-dataKey":"172.16.255.15-vm5-tracker3_tracker-group","elem-state":"tracker-if-state-down","lastupdated":1650866884165,"actual-delay":"4294967295","group-name":"tracker3","group-state":"tracker-if-state-down","attach-point-name":"tracker3_tracker-group","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/environmentData":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Environment Data information from device","operationId":"getEnvironmentData","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec environment data information":{"description":"TrustSec environment data information","value":{"data":[{"status":"env-download-in-progress","device-sgt":0,"last-updated-time":"1970-01-01T00:00:00+00:00","lastupdated":1652325611225,"vdevice-dataKey":"172.16.255.15-vm5","next-refresh-time":"1970-01-01T00:00:00+00:00","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15","life-time":"0","total-num-servers":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/environmentData/radiusServer":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Environment Data Radius Server list from device","operationId":"getRadiusServer","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec environment data radius server list information":{"description":"TrustSec environment data radius server list information","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","ip-addr":"0.0.0.0","port-num":"1812","is-alive":"TRUE","auto-test":"TRUE","keywrap":"-","idle-time":"3600","dead-time":"60","lastupdated":1652325611225,"vdevice-dataKey":"172.16.255.15-vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/featurelist":{"get":{"tags":["Real-Time Monitoring - Device Feature List"],"description":"Get feature lists from device (Real Time)","operationId":"getFeatureList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature lists":{"description":"Feature lists","value":{"data":[{"vdevice-dataKey":"172.16.255.11-statistics-collection-1.0","vdevice-name":"172.16.255.11","name":"statistics-collection","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-upgrade-confirm-1.0","vdevice-name":"172.16.255.11","name":"upgrade-confirm","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-vmanage-mode-2.0","vdevice-name":"172.16.255.11","name":"vmanage-mode","lastupdated":1647222469375,"version":"2.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-dpi-statistics-2.0","vdevice-name":"172.16.255.11","name":"dpi-statistics","lastupdated":1647222469375,"version":"2.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-cert-serial-hashing-1.0","vdevice-name":"172.16.255.11","name":"cert-serial-hashing","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-upgrade-1.0","vdevice-name":"172.16.255.11","name":"upgrade","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-cert-serial-version-1.0","vdevice-name":"172.16.255.11","name":"cert-serial-version","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-vbond-standalone-1.0","vdevice-name":"172.16.255.11","name":"vbond-standalone","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-tools-2.0","vdevice-name":"172.16.255.11","name":"tools","lastupdated":1647222469375,"version":"2.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-admin-tech-options-1.0","vdevice-name":"172.16.255.11","name":"admin-tech-options","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/featurelist/synced":{"get":{"tags":["Real-Time Monitoring - Device Feature List"],"description":"Get feature lists synchronously from device","operationId":"getSyncedFeatureList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature lists":{"description":"Feature lists","value":{"data":[{"vdevice-dataKey":"172.16.255.11-statistics-collection-1.0","@rid":632,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912241600,"name":"statistics-collection","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"},{"vdevice-dataKey":"172.16.255.11-upgrade-confirm-1.0","@rid":639,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912243273,"name":"upgrade-confirm","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"},{"vdevice-dataKey":"172.16.255.11-vmanage-mode-2.0","@rid":646,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912247190,"name":"vmanage-mode","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"2.0"},{"vdevice-dataKey":"172.16.255.11-dpi-statistics-2.0","@rid":654,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912250128,"name":"dpi-statistics","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"2.0"},{"vdevice-dataKey":"172.16.255.11-cert-serial-hashing-1.0","@rid":662,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912255235,"name":"cert-serial-hashing","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"},{"vdevice-dataKey":"172.16.255.11-upgrade-1.0","@rid":669,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912260609,"name":"upgrade","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/all-statuses/{deviceUUID}":{"get":{"tags":["File based RealTime Data Collection - Get Data Collection status for Device UUID"],"description":"Get Data Collection status for given Device UUID","operationId":"getDataCollectionStatusForDevice","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"All data collection statuses for given device","content":{"application/json":{"schema":{"type":"string"},"examples":{"All data collection statuses for given device":{"description":"All data collection statuses for given device","value":[{"deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee","deviceSystemIP":"172.16.255.15","collectionSubStatus":"file-downloaded-to-vmanage","statsCommand":"advertised-routes","requestEndTime":1661066092631,"requestUUID":"5fe0ec18-6da3-471f-aad7-03fc94b08a83","requestStartTime":"1661065501749","requestedFileFormat":"csv-file","detailedMessage":"Successfully downloaded file from device","collectionMainStatus":"success","lastStateChangedTime":1661066092544,"stateChangeLogs":[{"changeTime":1661066092544,"detailedMessage":"Successfully downloaded file from device","state":"file-downloaded-to-vmanage"},{"changeTime":1661066087249,"detailedMessage":"Published to destination vManage for Downloading generated file","state":"publised-for-file-download"},{"changeTime":1661066087031,"detailedMessage":"Device generated file","state":"file-generated"},{"changeTime":1661065506807,"detailedMessage":"RPC sent to Device for file generation","state":"device-notified"},{"changeTime":1661065501797,"detailedMessage":"Published to destination vManage for sending RPC request","state":"publised-for-rpc-request"}]},{"deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee","deviceSystemIP":"172.16.255.15","collectionSubStatus":"file-downloaded-to-vmanage","statsCommand":"advertised-routes","requestEndTime":1661066092631,"requestUUID":"893456sdf-6da3-471f-aad7-03fc94b08a83","requestStartTime":"16610656756789","requestedFileFormat":"json-file","detailedMessage":"Successfully downloaded file from device","collectionMainStatus":"success","lastStateChangedTime":1661066092544,"stateChangeLogs":[{"changeTime":1661066092544,"detailedMessage":"Successfully downloaded file from device","state":"file-downloaded-to-vmanage"},{"changeTime":1661066087249,"detailedMessage":"Published to destination vManage for Downloading generated file","state":"publised-for-file-download"},{"changeTime":1661066087031,"detailedMessage":"Device generated file","state":"file-generated"},{"changeTime":1661065506807,"detailedMessage":"RPC sent to Device for file generation","state":"device-notified"},{"changeTime":1661065501797,"detailedMessage":"Published to destination vManage for sending RPC request","state":"publised-for-rpc-request"}]}]}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"}}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/download/{requestUUID}":{"get":{"tags":["File based RealTime Data Collection - Download Generated File"],"description":"Download generated file","operationId":"downloadGeneratedFile","parameters":[{"name":"requestUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Generated file","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"}}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/file-generation-status":{"post":{"tags":["File based RealTime Data Collection - Device notification - File generation status"],"description":"Device notify when file is ready and vManage has to download them","operationId":"handleFileGenerationStatusResponseFromDevice","requestBody":{"description":"File generation status notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleFileGenerationStatusNotificationRequest"},"examples":{"Successful file generation status payload":{"description":"Successful file generation status payload","value":{"transactionId":"94e2a016-6b21-83d2-b6163c55ccd3%3cd2a8f8-8fce-63a6894ea555","status":"success","fileName":"/tmp/json/audit/audit_advertised_2022-09-19_13:54:34.csv","checksum":"3534534563454532788799807","detailedMessage":"Successfully generated file"}},"Failed file generation status payload":{"description":"Failed file generation status payload","value":{"transactionId":"94e2a016-6b21-83d2-b6163c55ccd3%3cd2a8f8-8fce-63a6894ea555","status":"failed","detailedMessage":"File generation failed due to no space left"}}}}}},"responses":{"200":{"description":"File generation status accepted"},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"}}}}}}},"x-roles-required":"vmanage-http-stream,System-read,System-write"}},"/device/file-based/data-collection/initiate-file-generation":{"post":{"tags":["File based RealTime Data Collection - Initiate File Generation"],"description":"Request device to prepare realtime collection data in required file format","operationId":"initiateFileGenerationRequestToDevice","requestBody":{"description":"Initiate file generation payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateFileGenerationRequest"},"examples":{"Initiate File Generation - OMP Routes Advertised in CSV Format":{"description":"Initiate File Generation - OMP Routes Advertised in CSV Format","value":{"deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee","statsCommand":"advertised-routes","requestedFileFormat":"csv-file"}},"Initiate File Generation - OMP Routes Received in JSON Format":{"description":"Initiate File Generation - OMP Routes Received in JSON Format","value":{"deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee","statsCommand":"received-routes","requestedFileFormat":"json-file"}}}}}},"responses":{"200":{"description":"Response for file generation request","content":{"application/json":{"schema":{"type":"string"},"examples":{"Data Collection information":{"description":"Data Collection information","value":{"deviceSystemIP":"172.16.255.15","deviceLocalSystemIP":"172.16.255.15","requestedFileFormat":"csv-file","requestUUID":"c04aadac-6efb-4cfd-8cbd-0fc47e00e931","statsCommand":"advertised-routes","deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee"}}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"}}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/status/{requestUUID}":{"get":{"tags":["File based RealTime Data Collection - Get Data Collection status for a Request UUID"],"description":"Get Data Collection status for given Request UUID","operationId":"getDataCollectionStatusForUUID","parameters":[{"name":"requestUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Data collection status for given UUID","content":{"application/json":{"schema":{"type":"string"},"examples":{"Data collection status for given UUID":{"description":"Data collection status for given UUID","value":{"deviceUUID":"C8K-10a453ab-e30b-4476-aa98-bc5ded7298ee","deviceSystemIP":"172.16.255.15","collectionSubStatus":"file-downloaded-to-vmanage","statsCommand":"advertised-routes","requestEndTime":1661066092631,"requestUUID":"5fe0ec18-6da3-471f-aad7-03fc94b08a83","requestStartTime":"1661065501749","requestedFileFormat":"csv-file","detailedMessage":"Successfully downloaded file from device","collectionMainStatus":"success","lastStateChangedTime":1661066092544,"stateChangeLogs":[{"changeTime":1661066092544,"detailedMessage":"Successfully downloaded file from device","state":"file-downloaded-to-vmanage"},{"changeTime":1661066087249,"detailedMessage":"Published to destination vManage for Downloading generated file","state":"publised-for-file-download"},{"changeTime":1661066087031,"detailedMessage":"Device generated file","state":"file-generated"},{"changeTime":1661065506807,"detailedMessage":"RPC sent to Device for file generation","state":"device-notified"},{"changeTime":1661065501797,"detailedMessage":"Published to destination vManage for sending RPC request","state":"publised-for-rpc-request"}]}}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"}}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/supported-commands/{deviceUUID}":{"get":{"tags":["File based RealTime Data Collection - Get Supported Commands List for a Device UUID"],"description":"Get Supported Command list for given Device UUID","operationId":"getSupportedCommandsList","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Supported Command list for given Device","content":{"application/json":{"schema":{"type":"string"},"examples":{"Response for Device with Supported Commands":{"description":"Response for Device with Supported Commands","value":[{"options":["csv-file","json-file"],"command":"OMP Advertised Routes"},{"options":["csv-file","json-file"],"command":"OMP Received Routes"}]},"Response for Device with No Supported Commands":{"description":"Response for Device with No Supported Commands","value":{}}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","value":{"operation":"Initiate file generation","errorType":"Invalid Payload or Parameter(s)","errorMessage":"Empty/Invalid Device IP"}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"operation":"Download generated file for UUID : b81467bb-9827-46a0-8db8-f742d4d91c0a","errorType":"General or Internal Error","errorMessage":"Data Collection state is in-progress, Cannot download file at this moment"}}}}}}},"x-roles-required":"System-read,System-write"}},"/device/geofence/status":{"get":{"tags":["Real-Time Monitoring - Geo-fencing"],"description":"Get Geo-fencing Status from device","operationId":"getGeofenceStatus","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Geo-fencing Status":{"description":"Geo-fencing Status","value":{"data":[{"geofence-config-status":"Geofencing-Disabled","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","lastupdated":1645089720394,"current-location-status":"Location-Invalid","current-device-location-timestamp":"2022-02-15T06:39:22+00:00","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/alarms":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware alarm list from device","operationId":"createAlarmList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware alarm list":{"description":"Hardware alarm list","value":{"data":[{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-22-0","vdevice-name":"10.0.0.121","alarm-id":"22","alarm-description":"PowerSupply/FANModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-critical","vdevice-host-name":"Router","alarm-name":"PowerSupplyBay1"},{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-62-0","vdevice-name":"10.0.0.121","alarm-id":"62","alarm-description":"PowerOverEthernetModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"POEBay0"},{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-82-0","vdevice-name":"10.0.0.121","alarm-id":"82","alarm-description":"PowerOverEthernetModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"POEBay1"},{"alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1090-1","vdevice-name":"10.0.0.121","alarm-id":"1090","alarm-description":"TransceiverMissing-LinkDown","lastupdated":1652171693495,"alarm-instance":"1","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"subslot0/0transceivercontainer0"},{"alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1100-1","vdevice-name":"10.0.0.121","alarm-id":"1100","alarm-description":"TransceiverMissing-LinkDown","lastupdated":1652171693495,"alarm-instance":"1","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"subslot0/0transceivercontainer1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/environment":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware environment list from device","operationId":"createEnvironmentList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware environment list":{"description":"Hardware environment list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-Interface module-0","vdevice-name":"169.254.10.10","hw-class":"PIM","hw-item":"Interface module","hw-dev-index":0,"lastupdated":1643076101789,"vdevice-host-name":"vm3","measurement":"Present: yes; Powered On: no; Fault: no","status":"Down"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/errors":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware error list from device","operationId":"createErrorAlarmList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware error list":{"description":"Hardware error list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-Interface module-0","vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","alarm-id":"22","alarm-instance":"0","alarm-name":"POEBay0","alarm-time":"2022-04-26T02:28:26+00:00","alarm-category":"alarm-severity-critical","alarm-description":"PowerSupply/FANModuleMissing","lastupdated":1652171693495}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/inventory":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware inventory list from device","operationId":"createInventoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware inventory list":{"description":"Hardware inventory list","value":{"data":[{"hw-type":"Chassis","vdevice-dataKey":"169.254.10.10-Chassis-0","vdevice-name":"169.254.10.10","hw-dev-index":0,"serial-number":"sim","part-number":"vEdge-Cloud","lastupdated":1643076350328,"version":"1.0","vdevice-host-name":"vm3","hw-description":"vEdge-Cloud"},{"hw-type":"PIM","vdevice-dataKey":"169.254.10.10-PIM-0","vdevice-name":"169.254.10.10","hw-dev-index":0,"serial-number":"None","part-number":"ge-8","lastupdated":1643076350328,"version":"None","vdevice-host-name":"vm3","hw-description":"Max 8 x 1GE VM ports"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/status/summary":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware status summary from device","operationId":"createStatusSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware status summary":{"description":"Hardware status summary","value":{"data":[{"vdevice-name":"10.0.0.121","createTimeStamp":1611557599955,"current-reading":"1015","vdevice-host-name":"Router","sensor-name":"voltage","vdevice-dataKey":"10.0.0.121-V:Vcore-A-R0","@rid":927,"vmanage-system-ip":"10.0.0.121","sensor-units":"millivolts","name":"V:Vcore-A","lastupdated":1652152463462,"location":"R0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557593593,"current-reading":"31","vdevice-host-name":"Router","sensor-name":"temperature","vdevice-dataKey":"10.0.0.121-Temp:Temp1-P0","@rid":1731,"vmanage-system-ip":"10.0.0.121","sensor-units":"celsius","name":"Temp:Temp1","lastupdated":1651807463843,"location":"P0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557593651,"current-reading":"25","vdevice-host-name":"Router","sensor-name":"temperature","vdevice-dataKey":"10.0.0.121-Temp:Temp2-P0","@rid":1760,"vmanage-system-ip":"10.0.0.121","sensor-units":"celsius","name":"Temp:Temp2","lastupdated":1652152463462,"location":"P0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557599821,"current-reading":"1508","vdevice-host-name":"Router","sensor-name":"voltage","vdevice-dataKey":"10.0.0.121-V:1.5v-A-R0","@rid":1881,"vmanage-system-ip":"10.0.0.121","sensor-units":"millivolts","name":"V:1.5v-A","lastupdated":1652152463462,"location":"R0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557593684,"current-reading":"28","vdevice-host-name":"Router","sensor-name":"temperature","vdevice-dataKey":"10.0.0.121-Temp:Temp3-P0","@rid":2044,"vmanage-system-ip":"10.0.0.121","sensor-units":"celsius","name":"Temp:Temp3","lastupdated":1651999921808,"location":"P0","state":"Normal"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/synced/alarms":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware alarm list synchronously from device","operationId":"createSyncedAlarmList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware alarm list":{"description":"Hardware alarm list","value":{"data":[{"vdevice-name":"10.0.0.121","alarm-id":"22","alarm-description":"PowerSupply/FANModuleMissing","createTimeStamp":1650884158338,"alarm-instance":"0","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-22-0","@rid":3034,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-critical","alarm-name":"PowerSupplyBay1"},{"vdevice-name":"10.0.0.121","alarm-id":"62","alarm-description":"PowerOverEthernetModuleMissing","createTimeStamp":1650884158392,"alarm-instance":"0","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-62-0","@rid":3035,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"POEBay0"},{"vdevice-name":"10.0.0.121","alarm-id":"82","alarm-description":"PowerOverEthernetModuleMissing","createTimeStamp":1650884158434,"alarm-instance":"0","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-82-0","@rid":3036,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"POEBay1"},{"vdevice-name":"10.0.0.121","alarm-id":"1090","alarm-description":"TransceiverMissing-LinkDown","createTimeStamp":1650884158484,"alarm-instance":"1","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1090-1","@rid":3037,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"subslot0/0transceivercontainer0"},{"vdevice-name":"10.0.0.121","alarm-id":"1100","alarm-description":"TransceiverMissing-LinkDown","createTimeStamp":1650884158543,"alarm-instance":"1","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1100-1","@rid":3042,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"subslot0/0transceivercontainer1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/synced/environment":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware environment list synchronously from device","operationId":"createSyncedEnvironmentList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware environment list":{"description":"Hardware environment list","value":{"data":[{"vdevice-name":"172.16.255.11","hw-dev-index":0,"createTimeStamp":1647316012518,"vdevice-host-name":"vm1","measurement":"Present:yes;PoweredOn:no;Fault:no","vdevice-dataKey":"172.16.255.11-Interfacemodule-0","@rid":1156,"hw-item":"Interfacemodule","hw-class":"PIM","vmanage-system-ip":"172.16.255.11","lastupdated":1647316012314,"status":"Down"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/synced/inventory":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware inventory list synchronously from device","operationId":"createSyncedInventoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware inventory list":{"description":"Hardware inventory list","value":{"data":[{"vdevice-name":"172.16.255.11","serial-number":"sim","hw-dev-index":0,"createTimeStamp":1647316018898,"version":"1.0","vdevice-host-name":"vm1","hw-description":"vEdge-Cloud","hw-type":"Chassis","vdevice-dataKey":"172.16.255.11-Chassis-0","@rid":1163,"vmanage-system-ip":"172.16.255.11","part-number":"vEdge-Cloud","lastupdated":1647316017498},{"vdevice-name":"172.16.255.11","serial-number":"None","hw-dev-index":0,"createTimeStamp":1647316036497,"version":"None","vdevice-host-name":"vm1","hw-description":"Max8x1GEVMports","hw-type":"PIM","vdevice-dataKey":"172.16.255.11-PIM-0","@rid":1169,"vmanage-system-ip":"172.16.255.11","part-number":"ge-8","lastupdated":1647316017498}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/system":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware system data list from device","operationId":"createSystemList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware system data list":{"description":"Hardware system data list","value":[{"last-reboot-reason":"reload","software-version":"Cisco IOS Software [Cupertino], Virtual XE Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Experimental Version 17.8.20211216:090342 [BLD_POLARIS_DEV_LATEST_20211216_061759:/nobackup/mcpre/s2c-build-ws 101]\nCopyright (c) 1986-2021 by Cisco Systems, Inc.\nCompiled Thu 16-Dec-21 01:03 by mcpre","lastupdated":1643186341301,"vdevice-dataKey":"172.16.255.15-2022-01-26T08:40:53.165+00:00-2022-01-26T08:37:03+00:00","boot-time":"2022-01-26T08:37:03+00:00","rommon-version":"IOS-XE ROMMON","current-time":"2022-01-26T08:40:53.165+00:00","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/threshold":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware temperature list from device","operationId":"createTempThresholdList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware temperature list":{"description":"Hardware temperature list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","hw-sensor-type":"Board","hw-dev-index":"0","fan-speed-normal":"64","yellow-alarm-normal":"65","yellow-alarm-bad-fan":"60","red-alarm-normal":"80","red-alarm-bad-fan":"75","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9-Interface module-0"},{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","hw-sensor-type":"CPU Junction","hw-dev-index":"1","fan-speed-normal":"64","yellow-alarm-normal":"65","yellow-alarm-bad-fan":"60","red-alarm-normal":"80","red-alarm-bad-fan":"75","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9-Interface module-1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardwarehealth/detail":{"get":{"tags":["Monitoring - Device Details"],"description":"Get hardware health details for device","operationId":"getHardwareHealthDetails","parameters":[{"name":"deviceId","in":"query","description":"Device Id","schema":{"type":"string"}},{"name":"state","in":"query","description":"Device state","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHardwareHealthDetail"}},"examples":{"Device hardware health details":{"description":"Device hardware health details","value":{"data":[{"bfdSessions":"3","memUsageDisplay":"52.0","site-id":"100","device-type":"vedge","version":"20.7.999-1133","hardwareState":"normal","uptime-date":1635324240000,"uuid":"63e8518c-e76f-4d5f-a4c7-28ffb669526b","lastupdated":1635371851165,"reachability":"reachable","device-model":"vedge-cloud","host-name":"vm11","local-system-ip":"172.16.255.21","cpuLoadDisplay":"39.27","controlConnections":"3","board-serial":"12346568","number-vsmart-peers":2,"system-ip":"172.16.255.21","ompPeers":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/hardwarehealth/summary":{"get":{"tags":["Monitoring - Device Details"],"description":"Get hardware health summary for device","operationId":"getHardwareHealthSummary","parameters":[{"name":"isCached","in":"query","description":"Status cached","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","description":"VPN Id","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device hardware health":{"description":"Device hardware health","value":{"data":[{"count":5,"status":"error","statusList":[{"status":"up","count":5,"message":"5 {normal=5, warning=0, error=0}","name":"normal","detailsURL":"/dataservice/device/hardwarehealth/detail?state=normal"},{"status":"warning","count":0,"message":"0 {normal=5, warning=0, error=0}","name":"warning","detailsURL":"/dataservice/device/hardwarehealth/detail?state=warning"},{"status":"down","count":0,"message":"0 {normal=5, warning=0, error=0}","name":"error","detailsURL":"/dataservice/device/hardwarehealth/detail?state=error"}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/history":{"get":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getStatDataRawData_20","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getStatsRawData_20","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/aggregation":{"get":{"tags":["Configuration - Device Config History"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_21","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Configuration - Device Config History"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_22","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/device/history/app-agg/aggregation":{"post":{"tags":["Configuration - Device Config History"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_20","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/device/history/config":{"get":{"tags":["Configuration - Device Config History"],"description":"Get device config history","operationId":"getLastThousandConfigList","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","description":"Query filter","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config history":{"description":"Device config history","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/config/diff/list":{"get":{"tags":["Configuration - Device Config History"],"description":"Get diff of two configs","operationId":"getConfigDiff","parameters":[{"name":"config_id1","in":"query","description":"Config Id one","required":true,"schema":{"type":"string"}},{"name":"config_id2","in":"query","description":"Config Id two","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/config/{config_id}":{"get":{"tags":["Configuration - Device Config History"],"description":"Get device config","operationId":"getDeviceConfig","parameters":[{"name":"config_id","in":"path","description":"Config Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/csv":{"get":{"tags":["Configuration - Device Config History"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_20","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/doccount":{"get":{"tags":["Configuration - Device Config History"],"description":"Get response count of a query","operationId":"getCount_21","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Config History"],"description":"Get response count of a query","operationId":"getCountPost_21","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/history/fields":{"get":{"tags":["Configuration - Device Config History"],"description":"Get fields and type","operationId":"getStatDataFields_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/history/page":{"get":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getStatBulkRawData_21","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_20","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/query/fields":{"get":{"tags":["Configuration - Device Config History"],"description":"Get query fields","operationId":"getStatQueryFields_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/igmp/groups":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP neighbor list from device","operationId":"createIGMPGroupsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IGMP neighbor":{"description":"IGMP neighbor","value":{"data":[{"if-name":"ge0/0","v1-members-present":"false","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","lastupdated":1643076514019,"state":"members-present","vpn-id":"10","event":"init-event","vdevice-host-name":"vm3","group":"225.225.0.1","uptime":"0:06:38:43"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/igmp/interface":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP interface list from device","operationId":"createIGMPInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IGMP interface":{"description":"IGMP interface","value":{"data":[{"vdevice-name":"169.254.10.10","if-addr":"100.100.3.101/24","vpn-id":"10","vdevice-host-name":"vm3","querier":"true","querier-ip":"100.100.3.101","if-name":"ge0/0","vdevice-dataKey":"169.254.10.10-10-ge0/0","group-count":1,"query-interval":"0:00:00:51","lastupdated":1643076670382,"state":"querier","event":"init-event"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/igmp/statistics":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP statistics list from device","operationId":"createIGMPStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IGMP statistics":{"description":"IGMP statistics","value":{"data":[{"rx_group_query":0,"vdevice-name":"169.254.10.10","tx_group_query":0,"vpn-id":"10","rx_v2_report":0,"rx_unknown":0,"vdevice-host-name":"vm3","rx_v1_report":0,"rx_leave":0,"tx_general_query":194,"vdevice-dataKey":"169.254.10.10","rx_general_query":0,"tx_error":0,"lastupdated":1643076824172,"rx_error":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/igmp/summary":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP summary from device","operationId":"createIGMPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IGMP summary":{"description":"IGMP summary","value":{"data":[{"last-member-query-response-time":"3","querier-timeout":"255","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","query-interval":"125","query-response-time":"10","lastupdated":1643076984762,"version":"2","last-member-query-count":"2","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/interface":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces","operationId":"getDeviceInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":18,"if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":13,"ifname":"ge0/1","rx-pps":14,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":2,"allow-service":"dhcp dns icmp https","if-tracker-status":"NA","num-flaps":"0","rx-packets":6544375,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":48131,"tx-drops":2,"uptime":"4:20:14:13","ipv6-address":"-","secondary":"false","ip-address":"10.101.3.3/16","hwaddr":"52:54:00:a1:4f:47","speed-mbps":"1000","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","tx-octets":1238809794,"tx-packets":6404951,"rx-octets":1209186254,"rx-kbps":19,"lastupdated":1643077714908,"port-type":"transport","uptime-date":1642659240000,"encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/1","rx-pps":0,"af-type":"ipv6","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ipv6-admin-status":"Up","ifindex":2,"allow-service":"dhcp dns icmp https","if-tracker-status":"NA","num-flaps":"0","rx-packets":3644,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"uptime":"4:20:14:13","ipv6-address":"-","hwaddr":"52:54:00:a1:4f:47","speed-mbps":"1000","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","tx-octets":9140,"tx-packets":128,"rx-octets":405455,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"transport","uptime-date":1642659240000,"encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/2","rx-pps":0,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Down","ifindex":3,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:39:5a:01","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/2","rx-pps":0,"af-type":"ipv6","shaping-rate":0,"if-oper-status":"Down","ipv6-admin-status":"Up","ifindex":3,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:39:5a:01","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/3","rx-pps":0,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Down","ifindex":4,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:2d:a0:f5","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/arp_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface ARP statistics","operationId":"getDeviceInterfaceARPStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ARP statistics":{"description":"ARP statistics","value":{"data":[{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"45746","rx-arp-requests":"296","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"12281","ip-address":"-","tx-arp-replies":"304","tx-no-arp-drops":"2","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","rx-arp-replies":"12281","ifname":"ge0/1","tx-arp-request-fail":"0","af-type":"ipv4","lastupdated":1643077098782,"arp-add-fails":"1"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"1","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","rx-arp-replies":"0","ifname":"ge0/1","tx-arp-request-fail":"0","af-type":"ipv6","lastupdated":1643077098782,"arp-add-fails":"0"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"0","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","rx-arp-replies":"0","ifname":"ge0/2","tx-arp-request-fail":"0","af-type":"ipv4","lastupdated":1643077098782,"arp-add-fails":"0"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"0","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","rx-arp-replies":"0","ifname":"ge0/2","tx-arp-request-fail":"0","af-type":"ipv6","lastupdated":1643077098782,"arp-add-fails":"0"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"0","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","rx-arp-replies":"0","ifname":"ge0/3","tx-arp-request-fail":"0","af-type":"ipv4","lastupdated":1643077098782,"arp-add-fails":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/error_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface error stats","operationId":"getDeviceInterfaceErrorStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Error stats":{"description":"Error stats","value":{"data":[{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"2078","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"2","ifname":"ge0/1","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv4","arp-add-fails":"1","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"46027","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/1","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv6","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/2","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv4","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/2","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv6","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/3","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv4","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/ipv6Stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface IPv6 stats","operationId":"getDeviceInterfaceIpv6Stats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface IPv6 stats":{"description":"Interface IPv6 stats","value":{"data":[{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet1","lastupdated":1645602691945,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet2","lastupdated":1645602691945,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet3","lastupdated":1645602691946,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet4","lastupdated":1645602691946,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet5","lastupdated":1645602691946,"out-error-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/pkt_size":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface packet size","operationId":"getDeviceInterfacePktSizes","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface packet size":{"description":"Interface packet size","value":{"data":[{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/1","num-flaps":"0","af-type":"ipv4","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/1","num-flaps":"0","af-type":"ipv6","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/2","num-flaps":"0","af-type":"ipv4","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/2","num-flaps":"0","af-type":"ipv6","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/3","num-flaps":"0","af-type":"ipv4","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/port_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface port stats","operationId":"getDeviceInterfacePortStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface port stats":{"description":"Interface port stats","value":{"data":[{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/1","af-type":"ipv4","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/1","af-type":"ipv6","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/2","af-type":"ipv4","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/2","af-type":"ipv6","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/qosStats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface QOS stats","operationId":"getDeviceInterfaceQosStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface QOS stats":{"description":"Interface QOS stats","value":{"data":[{"drop-bytes":"0","vdevice-name":"169.254.10.13","early-drop-bytes":"0","early-drop-pkts":"0","classified-bytes":"771","vdevice-host-name":"vm6","has-child":"false","vdevice-dataKey":"169.254.10.13-GigabitEthernet2-vpn10_qos_policy-Queue0","classified-pkts":"3","classifier-entry-name":"Queue0","policy-name":"vpn10_qos_policy","output-bytes":"771","name":"GigabitEthernet2","lastupdated":1654656462183,"drop-pkts":"0","output-pkts":"3"},{"drop-bytes":"0","vdevice-name":"169.254.10.13","early-drop-bytes":"0","early-drop-pkts":"0","classified-bytes":"0","vdevice-host-name":"vm6","has-child":"false","vdevice-dataKey":"169.254.10.13-GigabitEthernet2-vpn10_qos_policy-class-default","classified-pkts":"0","classifier-entry-name":"class-default","output-bytes":"0","policy-name":"vpn10_qos_policy","name":"GigabitEthernet2","lastupdated":1654656462183,"drop-pkts":"0","output-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/queue_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface queue stats","operationId":"getDeviceInterfaceQueueStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface queue stats":{"description":"Interface queue stats","value":{"data":[{"qnum":"0","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","vpn-id":"0","queued-bytes":"0","tail-drop-bytes":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-0","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","af-type":"ipv4","tx-bytes":"0","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"2","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-2","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"3","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-3","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"4","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-4","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"5","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-5","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/serial":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get serial interface","operationId":"getDeviceSerialInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","ifname":"eth0","crc-type":"32","loopback":"Green","keepalive":"3","timeslot":"10","vdevice-dataKey":"172.16.255.15","subrate":"100000","lastupdated":"1661309393233"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface stats","operationId":"getDeviceInterfaceStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface stats":{"description":"Interface stats","value":{"data":[{"vdevice-name":"169.254.10.10","rx-packets":"6634251","rx-errors":"0","tx-kbps":"18","tx-errors":"0","tx-pps":"13","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"48776","tx-drops":"2","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","ifname":"ge0/1","rx-pps":"13","tx-octets":"1255701145","tx-packets":"6493413","af-type":"ipv4","rx-octets":"1225652937","rx-kbps":"19","lastupdated":1643083561267},{"vdevice-name":"169.254.10.10","rx-packets":"3694","rx-errors":"0","tx-kbps":"0","tx-errors":"0","tx-pps":"0","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"0","tx-drops":"0","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","ifname":"ge0/1","rx-pps":"0","tx-octets":"9280","tx-packets":"130","af-type":"ipv6","rx-octets":"411008","rx-kbps":"0","lastupdated":1643083561267},{"vdevice-name":"169.254.10.10","rx-packets":"0","rx-errors":"0","tx-kbps":"0","tx-errors":"0","tx-pps":"0","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"0","tx-drops":"0","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","ifname":"ge0/2","rx-pps":"0","tx-octets":"0","tx-packets":"0","af-type":"ipv4","rx-octets":"0","rx-kbps":"0","lastupdated":1643083561267},{"vdevice-name":"169.254.10.10","rx-packets":"0","rx-errors":"0","tx-kbps":"0","tx-errors":"0","tx-pps":"0","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"0","tx-drops":"0","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","ifname":"ge0/2","rx-pps":"0","tx-octets":"0","tx-packets":"0","af-type":"ipv6","rx-octets":"0","rx-kbps":"0","lastupdated":1643083561267}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/synced":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces synchronously","operationId":"getSyncedDeviceInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","required":true,"schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"vdevice-name":"172.16.255.11","if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","@rid":855,"ifname":"ge0/1","af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":2,"if-tracker-status":"NA","createTimeStamp":1647315879734,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","secondary":"false","ip-address":"10.0.26.11/24","hwaddr":"52:54:00:db:d9:1b","speed-mbps":"1000","vdevice-dataKey":"172.16.255.11-0-ge0/1-ipv4","vmanage-system-ip":"172.16.255.11","lastupdated":1647315879722,"port-type":"service","encap-type":"null"},{"vdevice-name":"172.16.255.11","if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","@rid":869,"ifname":"ge0/2","af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":3,"allow-service":"dhcpdnsicmphttps","if-tracker-status":"NA","createTimeStamp":1647315880679,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","secondary":"false","ip-address":"10.0.5.11/24","hwaddr":"52:54:00:5b:92:ab","speed-mbps":"1000","vdevice-dataKey":"172.16.255.11-0-ge0/2-ipv4","vmanage-system-ip":"172.16.255.11","lastupdated":1647315879722,"port-type":"transport","encap-type":"null"},{"ifindex":4,"vdevice-name":"172.16.255.11","if-tracker-status":"NA","if-admin-status":"Down","createTimeStamp":1647315881312,"tcp-mss-adjust":"1416","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","hwaddr":"52:54:00:36:5b:37","ip-address":"-","vdevice-dataKey":"172.16.255.11-0-ge0/3-ipv4","@rid":883,"ifname":"ge0/3","vmanage-system-ip":"172.16.255.11","af-type":"ipv4","lastupdated":1647315879722,"shaping-rate":0,"port-type":"service","if-oper-status":"Down","encap-type":"null"},{"vdevice-name":"172.16.255.11","if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","@rid":897,"ifname":"ge0/4","af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":5,"if-tracker-status":"NA","createTimeStamp":1647315882880,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","secondary":"false","ip-address":"10.0.7.11/24","hwaddr":"52:54:00:67:74:f1","speed-mbps":"1000","vdevice-dataKey":"172.16.255.11-0-ge0/4-ipv4","vmanage-system-ip":"172.16.255.11","lastupdated":1647315879722,"port-type":"service","encap-type":"null"},{"ifindex":6,"vdevice-name":"172.16.255.11","if-tracker-status":"NA","if-admin-status":"Down","createTimeStamp":1647315883461,"tcp-mss-adjust":"1416","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","hwaddr":"52:54:00:0f:c2:a7","ip-address":"-","vdevice-dataKey":"172.16.255.11-0-ge0/5-ipv4","@rid":908,"ifname":"ge0/5","vmanage-system-ip":"172.16.255.11","af-type":"ipv4","lastupdated":1647315879722,"shaping-rate":0,"port-type":"service","if-oper-status":"Down","encap-type":"null"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/trustsec":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get policy filter memory usage from device","operationId":"trustsec","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy filter memory usage":{"description":"Policy filter memory usage","value":{"data":[{"mode":"cts-ndac-mode-manual","if-name":"GigabitEthernet2","sgt-propagate":"cts-sgt-propagate-enabled","vdevice-dataKey":"169.254.10.13-vm6-GigabitEthernet2","vdevice-name":"169.254.10.13","trusted":"cts-manual-untrusted","lastupdated":1654654895429,"peer-sgt":0,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/interface/vpn":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces per VPN","operationId":"generateDeviceInterfaceVPN","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"index":0,"vpnId":"0","ifname":"ge0/1"},{"index":1,"vpnId":"0","ifname":"ge0/2"},{"index":2,"vpnId":"0","ifname":"ge0/3"},{"index":3,"vpnId":"0","ifname":"ge0/4"},{"index":4,"vpnId":"0","ifname":"ge0/5"},{"index":5,"vpnId":"0","ifname":"ge0/6"},{"index":6,"vpnId":"0","ifname":"ge0/7"},{"index":7,"vpnId":"0","ifname":"system"},{"index":8,"vpnId":"1","ifname":"ge0/0"},{"index":9,"vpnId":"512","ifname":"eth0"},{"index":10,"vpnId":"65528","ifname":"loopback65528"},{"index":11,"vpnId":"65530","ifname":"loopback65530"},{"index":12,"vpnId":"65530","ifname":"loopback65531"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/ip/fib":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get FIB list from device (Real Time)","operationId":"createFibList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"address-family","in":"query","description":"Address family","schema":{"type":"string","enum":["IPv4","IPv6"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"tloc","in":"query","description":"tloc IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FIB list":{"description":"FIB list","value":{"data":[{"nexthop-address":"10.0.5.13","vdevice-dataKey":"172.16.255.21-0-0.0.0.0/0","vdevice-name":"172.16.255.21","prefix":"0.0.0.0/0","lastupdated":1649641392351,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.5.0/24","vdevice-name":"172.16.255.21","prefix":"10.0.5.0/24","lastupdated":1649641392351,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.5.21/32","vdevice-name":"172.16.255.21","prefix":"10.0.5.21/32","lastupdated":1649641392351,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.100.0/24","vdevice-name":"172.16.255.21","prefix":"10.0.100.0/24","lastupdated":1649641392351,"out-ifname":"ge0/7","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.100.21/32","vdevice-name":"172.16.255.21","prefix":"10.0.100.21/32","lastupdated":1649641392351,"out-ifname":"ge0/7","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-100.0.0.0/24","vdevice-name":"172.16.255.21","prefix":"100.0.0.0/24","lastupdated":1649641392351,"out-ifname":"ge0/6","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-100.0.0.11/32","vdevice-name":"172.16.255.21","prefix":"100.0.0.11/32","lastupdated":1649641392351,"out-ifname":"ge0/6","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"nexthop-address":"100.0.0.1","vdevice-dataKey":"172.16.255.21-0-100.2.0.0/24","vdevice-name":"172.16.255.21","prefix":"100.2.0.0/24","lastupdated":1649641392351,"out-ifname":"ge0/6","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/ipRoutes":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get ietf routing list from device","operationId":"createIetfRoutingList","parameters":[{"name":"routing-instance-name","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"address-family","in":"query","description":"Address family","schema":{"type":"string"}},{"name":"outgoing-interface","in":"query","description":"Outgoing Interface","schema":{"type":"string"}},{"name":"source-protocol","in":"query","description":"Source Protocol","schema":{"type":"string"}},{"name":"next-hop-address","in":"query","description":"Next Hop Address","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ietf routing list":{"description":"ietf routing list","value":{"data":[{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"0.0.0.0/0","route-source-protocol":"static","next-hop-next-hop-address":"10.102.254.254","routing-instance-name":"default","protocol-name":"0","route-route-preference":"1","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","route-metric":"0","lastupdated":1645080304580},{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"10.101.0.0/16","route-source-protocol":"direct","next-hop-next-hop-address":"0.0.0.0","routing-instance-name":"default","protocol-name":"0","route-route-preference":"0","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","next-hop-outgoing-interface":"GigabitEthernet3","route-metric":"0","lastupdated":1645080304580},{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"10.101.5.5/32","route-source-protocol":"direct","next-hop-next-hop-address":"0.0.0.0","routing-instance-name":"default","protocol-name":"0","route-route-preference":"0","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","next-hop-outgoing-interface":"GigabitEthernet3","route-metric":"0","lastupdated":1645080304580},{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"10.102.0.0/16","route-source-protocol":"direct","next-hop-next-hop-address":"0.0.0.0","routing-instance-name":"default","protocol-name":"0","route-route-preference":"0","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","next-hop-outgoing-interface":"GigabitEthernet5","route-metric":"0","lastupdated":1645080304580}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/mfiboil":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get IP MFIB OIL list from device (Real Time)","operationId":"createIPMfibOilList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP MFIB OIL list":{"description":"IP MFIB OIL list","value":{"data":[{"vdevice-dataKey":"169.254.10.11-10-","vdevice-name":"169.254.10.11","lastupdated":1654849997281,"source":"0.0.0.0","vpn-id":10,"vdevice-host-name":"vm4","group":"224.0.1.39"},{"vdevice-dataKey":"169.254.10.11-10-","vdevice-name":"169.254.10.11","lastupdated":1654849997281,"source":"0.0.0.0","vpn-id":10,"vdevice-host-name":"vm4","group":"224.0.1.40"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/mfibstats":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get IP MFIB statistics list from device (Real Time)","operationId":"createIPMfibStatsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP MFIB statistics list":{"description":"IP MFIB statistics list","value":{"data":[{"tx-octet-rate":0,"tx-pkts":0,"vdevice-name":"169.254.10.11","rx-octet-rate":0,"rx-packet-rate":0,"source":"0.0.0.0","rpf-failure":0,"vpn-id":10,"vdevice-host-name":"vm4","tx-packet-rate":0,"tx-policy-drop":0,"avg_replication":"0.00","vdevice-dataKey":"169.254.10.11-10-","rx-policy-drop":0,"tx-octets":0,"rx-octets":0,"tx-to-pim-pkts":0,"lastupdated":1654850155929,"tx-invalid-oil-failure":0,"rx-pkts":"0","group":"224.0.1.39"},{"tx-octet-rate":0,"tx-pkts":0,"vdevice-name":"169.254.10.11","rx-octet-rate":0,"rx-packet-rate":0,"source":"0.0.0.0","rpf-failure":0,"vpn-id":10,"vdevice-host-name":"vm4","tx-packet-rate":0,"tx-policy-drop":0,"avg_replication":"0.00","vdevice-dataKey":"169.254.10.11-10-","rx-policy-drop":0,"tx-octets":0,"rx-octets":0,"tx-to-pim-pkts":0,"lastupdated":1654850155929,"tx-invalid-oil-failure":0,"rx-pkts":"0","group":"224.0.1.40"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/mfibsummary":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get IP MFIB summary list from device (Real Time)","operationId":"createIPMfibSummaryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP MFIB summary list":{"description":"IP MFIB summary list","value":{"data":[{"upstream-tunnel":"0.0.0.0","vdevice-dataKey":"169.254.10.11-10-224.0.1.39","vdevice-name":"169.254.10.11","upstream-if":"---","lastupdated":1654850209775,"source":"0.0.0.0","vpn-id":10,"num-tunnel-oils":"0","vdevice-host-name":"vm4","group":"224.0.1.39","num-service-oils":"0"},{"upstream-tunnel":"0.0.0.0","vdevice-dataKey":"169.254.10.11-10-224.0.1.40","vdevice-name":"169.254.10.11","upstream-if":"---","lastupdated":1654850209775,"source":"0.0.0.0","vpn-id":10,"num-tunnel-oils":"0","vdevice-host-name":"vm4","group":"224.0.1.40","num-service-oils":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/filter":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT filter list from device","operationId":"createNatFilterList","parameters":[{"name":"nat-vpn-id","in":"query","description":"NAT VPN Id","schema":{"type":"string"}},{"name":"nat-ifname","in":"query","description":"NAT interface name","schema":{"type":"string"}},{"name":"private-source-address","in":"query","description":"Private source address","schema":{"type":"string"}},{"name":"proto","in":"query","description":"Protocol","schema":{"type":"string","enum":["icm","tcp","udp"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT filter list":{"description":"NAT filter list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","nat-vpn-id":"0","nat-ifname":"ge0/0","private-vpn-id":"0","proto":"icmp","private-source-address":"10.1.15.15","private-dest-address":"10.1.14.14","private-source-port":"4697","public-source-address":"10.1.15.15","public-dest-address":"10.1.14.14","public-source-port":"64931","public-dest-port":"64931","filter-state":"established","idle-timeout":"0:00:00:41","idle-timeout-date":"-","outbound-packets":"1","outbound-octets":"98","inbound-packets":"1","inbound-octets":"98","lastupdated":1657853484627,"vdevice-dataKey":"172.16.254.1-10-224.0.1.40"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/interface":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT interface list from device (Real Time)","operationId":"createNatInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT interface list":{"description":"NAT interface list","value":{"data":[{"fib-filter-count":0,"vdevice-name":"169.254.10.9","lastupdated":1654525771150,"vpn-id":0,"vdevice-dataKey":"169.254.10.9-0","mapping-type":"endpoint-independent","filter-count":0,"vdevice-host-name":"vm2","ifname":"ipsec10","filter-type":"address-port-restricted"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/interfacestatistics":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT interface statistics list from device","operationId":"createNatInterfaceStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT interface statistics list":{"description":"NAT interface statistics list","value":[{"out2in-drops":0,"in2out-drops":0,"vdevice-dataKey":"172.16.255.15-0-0","vdevice-host-name":"vm5","initialized":9223372036854775807,"entry-timeouts":0,"pool-stats-drop":"0","limit-entry-add-fail":"0","outsides":0,"packets-punted":"0","lastupdated":1645079319277,"mapping-stats-drop":"0","misses":0,"interrupt-switched":0,"frag-pak-count":"0","statics":0,"flows":0,"entries":"0","vdevice-name":"172.16.255.15","hits":0,"portlist-req-fail":"0","ipalias-add-fail":0,"insides":0,"statics-sorted":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/translation":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT translation list from device (Real Time)","operationId":"createNatTranslationList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT translation list":{"description":"NAT translation list","value":{"data":[{"inside-local-addr":"10.1.15.15","outside-local-port":"50","vdevice-name":"172.16.255.15","inside-global-port":"50","flags":"0","outside-global-port":"50","vdevice-host-name":"vm5","vrfid":"0","protocol":"1","outside-local-addr":"10.1.16.16","vdevice-dataKey":"172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-50","outside-global-addr":"10.1.16.16","inside-local-port":"50","lastupdated":1651038839092,"application-type":"0","inside-global-addr":"10.1.15.15"},{"inside-local-addr":"10.1.15.15","outside-local-port":"51","vdevice-name":"172.16.255.15","inside-global-port":"51","flags":"0","outside-global-port":"51","vdevice-host-name":"vm5","vrfid":"0","protocol":"1","outside-local-addr":"10.1.16.16","vdevice-dataKey":"172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-51","outside-global-addr":"10.1.16.16","inside-local-port":"51","lastupdated":1651038839092,"application-type":"0","inside-global-addr":"10.1.15.15"},{"inside-local-addr":"10.1.15.15","outside-local-port":"49","vdevice-name":"172.16.255.15","inside-global-port":"49","flags":"0","outside-global-port":"49","vdevice-host-name":"vm5","vrfid":"0","protocol":"1","outside-local-addr":"10.1.16.16","vdevice-dataKey":"172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-49","outside-global-addr":"10.1.16.16","inside-local-port":"49","lastupdated":1651038839092,"application-type":"0","inside-global-addr":"10.1.15.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat64/translation":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT64 interface list from device","operationId":"createNat64TranslationList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT64 interface list":{"description":"NAT64 interface list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vrf-name":"1","protocol":"icmp","orig-ipv6-src-addr":"2001:DB8:3001::9","orig-ipv6-dst-addr":"2800:1503:2000:1:1::0a01:7102","orig-src-port":2654,"orig-dst-port":2654,"translated-src-addr":"10.1.113.2","translated-dst-addr":"50.50.50.50","translated-src-port":"2654","translated-dst-port":"2654","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/routetable":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get route table list from device (Real Time)","operationId":"createRouteTableList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"address-family","in":"query","description":"Address family","schema":{"type":"string","enum":["IPv4","IPv6"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"protocol","in":"query","description":"IP protocol","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Route table list":{"description":"Route table list","value":{"data":[{"rstatus":"F S","protocol":"static","vdevice-dataKey":"169.254.10.10-0-0.0.0.0/0","vdevice-name":"169.254.10.10","prefix":"0.0.0.0/0","lastupdated":1643160579908,"nexthop-addr":"10.101.254.254","vpn-id":0,"nexthop-type":"ipv4","vdevice-host-name":"vm3","address-family":"ipv4","nexthop-ifname":"ge0/1"},{"color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.5.0/24","ip":"172.16.254.4","encap":"ipsec","vpn-id":10,"nexthop-label":"1047","nexthop-type":"ipv4-indirect","vdevice-host-name":"vm3","rstatus":"F S","protocol":"omp","vdevice-dataKey":"169.254.10.10-10-10.0.5.0/24","lastupdated":1643160579908,"address-family":"ipv4"},{"rstatus":"F S","protocol":"connected","vdevice-dataKey":"169.254.10.10-512-fcff::/120","vdevice-name":"169.254.10.10","prefix":"fcff::/120","lastupdated":1643160579908,"vpn-id":512,"nexthop-type":"ipv6","vdevice-host-name":"vm3","address-family":"ipv6","nexthop-ifname":"loop0.2"},{"rstatus":"F S","protocol":"connected","vdevice-dataKey":"169.254.10.10-65528-192.168.0.0/24","vdevice-name":"169.254.10.10","prefix":"192.168.0.0/24","lastupdated":1643160579908,"vpn-id":65528,"nexthop-type":"ipv4","vdevice-host-name":"vm3","address-family":"ipv4","nexthop-ifname":"loopback65528"},{"rstatus":"F S","protocol":"connected","vdevice-dataKey":"169.254.10.10-65530-192.168.0.0/24","vdevice-name":"169.254.10.10","prefix":"192.168.0.0/24","lastupdated":1643160579908,"vpn-id":65530,"nexthop-type":"ipv4","vdevice-host-name":"vm3","address-family":"ipv4","nexthop-ifname":"loopback65530"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/v4fib":{"get":{"tags":["Real-Time Monitoring - IPv4 FIB"],"description":"Get IPv4 FIB list from device (Real Time)","operationId":"createIPv4FibList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"tloc","in":"query","description":"tloc IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FIB list":{"description":"FIB list","value":{"data":[{"path-id":1,"vdevice-dataKey":"169.254.10.10-512-10.0.1.0/24","vdevice-name":"169.254.10.10","prefix":"10.0.1.0/24","lastupdated":1643096072514,"out-ifname":"eth0","vpn-id":512,"vdevice-host-name":"vm3"},{"path-id":1,"vdevice-dataKey":"169.254.10.10-512-10.0.1.3/32","vdevice-name":"169.254.10.10","prefix":"10.0.1.3/32","lastupdated":1643096072514,"out-ifname":"eth0","vpn-id":512,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/v6fib":{"get":{"tags":["Real-Time Monitoring - IPv6 FIB"],"description":"Get IPv6 FIB list from device (Real Time)","operationId":"createIPv6FibList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"tloc","in":"query","description":"tloc IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FIB list":{"description":"FIB list","value":{"data":[{"path-id":1,"vdevice-dataKey":"169.254.10.10-0-fe80::3274:7d86:eb7f:4a3c/128","vdevice-name":"169.254.10.10","prefix":"fe80::3274:7d86:eb7f:4a3c/128","lastupdated":1643096311251,"out-ifname":"vmanage_system","vpn-id":0,"vdevice-host-name":"vm3"},{"path-id":1,"vdevice-dataKey":"169.254.10.10-0-fe80::40b8:4592:c183:592c/128","vdevice-name":"169.254.10.10","prefix":"fe80::40b8:4592:c183:592c/128","lastupdated":1643096311251,"out-ifname":"system","vpn-id":0,"vdevice-host-name":"vm3"},{"path-id":1,"vdevice-dataKey":"169.254.10.10-0-fe80::5054:ff:fea1:4f47/128","vdevice-name":"169.254.10.10","prefix":"fe80::5054:ff:fea1:4f47/128","lastupdated":1643096311251,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ipsec/identity":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get Crypto IPSEC identity entry from device","operationId":"createCryptoIpsecIdentity","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crypto IPSEC identity entry":{"description":"Crypto IPSEC identity entry","value":{"data":[{"vdevice-name":"169.254.10.12","local-ident-addr":"10.102.5.5","local-endpt-addr":"10.102.5.5","remote-ident-protocol":"0","interface":"Tunnel5","vpn-id":"0","vdevice-host-name":"vm5","local-ident-mask":"255.255.255.255","local-ident-protocol":"0","vdevice-dataKey":"169.254.10.12","plaintext-mtu":"1438","lastupdated":1644890148156,"remote-ident-addr":"10.101.3.3","remote-endpt-addr":"10.101.3.3","remote-ident-mask":"255.255.255.255","dh-group":"crypto-dh-grouptype-none"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ike/inbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec IKE inbound connection list from device","operationId":"createIkeInboundList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec IKE local inbound connection list":{"description":"IPsec IKE local inbound connection list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","source-ip":"2.2.2.2","source-port":"4500","dest-ip":"3.3.3.3","dest-port":"4500","new-spi":"257","old-spi":"256","cipher-suite":"aes256-cbc-sha1","new-key-hash":"****01be","old-key-hash":"****a0df","ext-seq":"11","lastupdated":"1654066322656","vdevice-dataKey":"169.254.10.9-10-ipsec1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ike/outbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec IKE outbound connection list from device","operationId":"createIkeOutboundList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec IKE outbound connection list":{"description":"IPsec IKE outbound connection list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","source-ip":"2.2.2.2","source-port":"4500","dest-ip":"3.3.3.3","dest-port":"4500","spi":"257","cipher-suite":"aes256-cbc-sha1","keyhash":"****55b5","tunnel-mtu":"1418","ext-seq":"11","lastupdated":"1654066322656","vdevice-dataKey":"169.254.10.9-10-ipsec1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ike/sessions":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec IKE sessions from device","operationId":"createIkeSessions","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec IKE sessions":{"description":"IPsec IKE sessions","value":{"data":[{"dest-ip":"3.3.3.3","source-port":4500,"vdevice-name":"169.254.10.9","vpn-id":"10","version":"1","vdevice-host-name":"vm2","uptime":"0:00:00:00","if-name":"ipsec1","dest-port":4500,"vdevice-dataKey":"169.254.10.9-10-ipsec1","cipher-suite":"aes256-cbc-sha1","lastupdated":1654066322656,"source-ip":"2.2.2.2","state":"INTF_CREATED","uptime-date":1654066320000,"dh-group":"16 (MODP-4096)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ikev1":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get Crypto IKEv1 SA entry from device","operationId":"createCryptov1LocalSAList","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crypto IKEv1 SA entry":{"description":"Crypto IKEv1 SA entry","value":{"data":[{"init-spi":"NzA4MjczNjM1RTYwOUE0MQ==","remote-ip-addr":"10.1.16.16","vdevice-name":"172.16.255.15","sa-status":"crypto-sa-status-active","lifetime":84025,"vdevice-host-name":"vm5","local-ip-addr":"10.1.15.15","my-auth-method":"crypto-ikev2-auth-psk","ivrf":"none","local-port":500,"peer-auth-method":"crypto-ikev2-auth-psk","vdevice-dataKey":"172.16.255.15","fvrf":"none","resp-spi":"MDkzRDYwQ0YwQzUxMDcxMg==","encr-alg":"crypto-encr-alg-aes-cbc","remote-port":500,"hash-algo":"crypto-hash-alg-auth-hmac-sha256","lastupdated":1657094847813,"sa-id":"1002","dh-group":"crypto-dh-grouptype-group16"},{"init-spi":"NTlCQjQyNzVEOURCMEExNg==","remote-ip-addr":"10.1.16.16","vdevice-name":"172.16.255.15","sa-status":"crypto-sa-status-active","lifetime":84026,"vdevice-host-name":"vm5","local-ip-addr":"10.1.15.15","my-auth-method":"crypto-ikev2-auth-psk","ivrf":"none","local-port":500,"peer-auth-method":"crypto-ikev2-auth-psk","vdevice-dataKey":"172.16.255.15","fvrf":"none","resp-spi":"RTlFMUZEN0VCQUZGNDNGQQ==","encr-alg":"crypto-encr-alg-aes-cbc","remote-port":500,"hash-algo":"crypto-hash-alg-auth-hmac-sha256","lastupdated":1657094847813,"sa-id":"1003","dh-group":"crypto-dh-grouptype-group16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ikev2":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get Crypto IKEv2 SA entry from device","operationId":"createCryptov2LocalSAList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crypto IKEv2 SA entry":{"description":"Crypto IKEv2 SA entry","value":{"data":[{"init-spi":"MkVENzFDRUMxODUyNDVDNA==","remote-ip-addr":"10.1.16.16","vdevice-name":"172.16.255.15","sa-status":"crypto-sa-status-active","lifetime":86400,"vdevice-host-name":"vm5","local-ip-addr":"10.1.15.15","my-auth-method":"crypto-ikev2-auth-psk","ivrf":"1","local-port":500,"peer-auth-method":"crypto-ikev2-auth-psk","vdevice-dataKey":"172.16.255.15","fvrf":"none","resp-spi":"MzY1RjFGMUMxODgxNTY5Qg==","encr-alg":"crypto-encr-alg-aes-cbc","remote-port":500,"hash-algo":"crypto-hash-alg-auth-hmac-sha512","lastupdated":1657274365619,"sa-id":"1","dh-group":"crypto-dh-grouptype-group24"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/inbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec inbound connection list from device (Real Time)","operationId":"createInBoundList","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec inbound connection list":{"description":"IPsec inbound connection list","value":{"data":[{"dest-ip":"10.101.3.3","source-port":12386,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.1","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.101.2.2","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.3","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.101.4.4","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.4","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.102.5.5","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.5","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.102.6.6","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.16","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.102.16.16","remote-tloc-color":"default","local-tloc-color":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/localsa":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec local SA list from device","operationId":"createLocalSAList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec local SA list":{"description":"IPsec local SA list","value":{"data":[{"tloc-color":"default","vdevice-dataKey":"169.254.10.10-172.16.254.2","vdevice-name":"169.254.10.10","port":12406,"tloc-address":"172.16.254.2","ipv6":"::","ip":"10.101.3.3","lastupdated":1643166514716,"encrypt-key-hash":"*****386b","spi":"286","auth-key-hash":"*****386b","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/outbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec outbound connection list from device (Real Time)","operationId":"createOutBoundList","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec outbound connection list":{"description":"IPsec outbound connection list","value":{"data":[{"dest-ip":"10.101.2.2","integrity-used":"ip-udp-esp","source-port":12426,"vdevice-name":"169.254.10.10","spi":262,"auth-key-hash":"*****2450","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.1","dest-port":12386,"vdevice-dataKey":"169.254.10.10-10.101.3.3","tunnel-mtu":1441,"lastupdated":1643334538276,"source-ip":"10.101.3.3","remote-tloc-color":"default","encrypt-key-hash":"*****2450"},{"dest-ip":"10.101.4.4","integrity-used":"ip-udp-esp","source-port":12426,"vdevice-name":"169.254.10.10","spi":289,"auth-key-hash":"*****3b7e","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.3","dest-port":12366,"vdevice-dataKey":"169.254.10.10-10.101.3.3","tunnel-mtu":1441,"lastupdated":1643334538276,"source-ip":"10.101.3.3","remote-tloc-color":"default","encrypt-key-hash":"*****3b7e"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/pwk/inbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPSEC pairwise key inbound entry from device","operationId":"createIPsecPWKInboundConnections","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPSEC pairwise key inbound entry":{"description":"IPSEC pairwise key inbound entry","value":{"data":[{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.1","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066644,"remote-tloc-color":"lte","source-ip":"10.102.2.2","local-tloc-color":"default","sa-index":"7","remote-tloc-index":"32775"},{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.1","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066644,"remote-tloc-color":"3g","source-ip":"10.101.2.2","local-tloc-color":"default","sa-index":"19","remote-tloc-index":"32781"},{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.2","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066644,"remote-tloc-color":"lte","source-ip":"10.102.3.3","local-tloc-color":"default","sa-index":"11","remote-tloc-index":"32777"},{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.2","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066645,"remote-tloc-color":"3g","source-ip":"10.101.3.3","local-tloc-color":"default","sa-index":"9","remote-tloc-index":"32776"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/pwk/localsa":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPSEC pairwise key local SA entry from device","operationId":"createIPsecPWKLocalSA","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPSEC pairwise key local SA entry":{"description":"IPSEC pairwise key local SA entry","value":{"data":[{"tloc-color":"default","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32770","ip":"10.101.5.5","spi":"262","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"9"},{"tloc-color":"default","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32770","ip":"10.101.5.5","spi":"263","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"11"},{"tloc-color":"3g","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32771","ip":"10.102.5.5","spi":"262","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"10"},{"tloc-color":"3g","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32771","ip":"10.102.5.5","spi":"263","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"12"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/pwk/outbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPSEC pairwise key outbound entry from device","operationId":"createIPsecPWKOutboundConnections","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPSEC pairwise key outbound entry":{"description":"IPSEC pairwise key outbound entry","value":{"data":[{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"a600","local-tloc-color":"lte","dest-ip":"10.0.5.11","source-ip":"10.1.15.15","remote-tloc-index":"32772","lastupdated":1645156239932,"sa-index":"183","remote-tloc-address":"172.16.255.11","tloc-index":"32772","dest-port":"12367","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"},{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"b13e","local-tloc-color":"lte","dest-ip":"10.0.5.21","source-ip":"10.1.15.15","remote-tloc-index":"32771","lastupdated":1645156239933,"sa-index":"182","remote-tloc-address":"172.16.255.21","tloc-index":"32771","dest-port":"12377","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"},{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"59f1","local-tloc-color":"lte","dest-ip":"10.1.14.14","source-ip":"10.1.15.15","remote-tloc-index":"32774","lastupdated":1645156239933,"sa-index":"184","remote-tloc-address":"172.16.255.14","tloc-index":"32774","dest-port":"12366","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"},{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"61b6","local-tloc-color":"lte","dest-ip":"10.1.16.16","source-ip":"10.1.15.15","remote-tloc-index":"32773","lastupdated":1645156239933,"sa-index":"181","remote-tloc-address":"172.16.255.16","tloc-index":"32773","dest-port":"12366","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipv6/nd6":{"get":{"tags":["Real-Time Monitoring - Device"],"description":"Get ipv6 data from device","operationId":"getIpv6Data","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP v6 data":{"description":"IP v6 data","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vrf-name":"8","if-name":"Et0/0","ip":"FE80::A8BB:CCFF:FE01:F500","mac-address":"AA:BB:CC:01:F5:00","state":"REACHABLE","idle-timer":"8850","uptime":"01:34:16","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/keyvalue":{"get":{"tags":["Monitoring - Device Details"],"description":"Get vEdge inventory as key value (key as systemIp value as hostName)","operationId":"getDeviceListAsKeyValue","parameters":[{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vEdge inventory":{"description":"vEdge inventory","value":{"header":{"generatedOn":1635297986225},"data":[{"key":"172.16.255.128","value":"vm128 (172.16.255.128)"},{"key":"172.16.253.129","value":"vm129 (172.16.253.129)"},{"key":"172.16.255.130","value":"vm130 (172.16.255.130)"},{"key":"172.16.253.131","value":"vm131 (172.16.253.131)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/license/evaluation":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license evaluation info from device","operationId":"getLicenseEvalInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License evaluation info":{"description":"License evaluation info","value":{"data":[{"vdevice-dataKey":"169.254.10.14","vdevice-name":"169.254.10.14","lastupdated":1646031617468,"eval-expired":"false","eval-in-use":"false","time-left":"0","vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/pak":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license pak info from device","operationId":"getLicensePAKInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License pak info":{"description":"License pak info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","singleton_id":10,"store":"Primary License Storage","storeindex":0,"version":"1.0","feature_name":"test_subscr","type":"Evaluation","state":"Active, Not in Use, EULA accepted","count":"Non-Counted","priority":"Low","lastupdated":660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/privacy":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license privacy info from device","operationId":"getLicensePrivacyInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License privacy info":{"description":"License privacy info","value":{"data":[{},{"lastupdated":1646030987293,"hostname":"false","vdevice-dataKey":"169.254.10.14","vdevice-name":"169.254.10.14","version":"false","vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/registration":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license registration info from device","operationId":"getLicenseRegInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License info":{"description":"License info","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","always-enabled":"true","lastupdated":1645754331129,"vdevice-host-name":"vm5","smart-enabled":"false"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/udi":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license UDI info from device","operationId":"getLicenseUDIInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License UDI info":{"description":"License UDI info","value":{"data":[{"mac-address":"00:00:00:00:00:00","vdevice-dataKey":"169.254.10.14","vdevice-name":"169.254.10.14","lastupdated":1646030100474,"pid":"CSR1000V","sn":"9PBHZUBMD18","vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/usage":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license usage info from device","operationId":"getLicenseUsageInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License usage info":{"description":"License usage info","value":{"data":[{"vdevice-name":"172.16.254.4","vdevice-host-name":"vm5","entitlement-tag":"WAN_License","short-name":"-","license-name":"WAN_License","description":"-","count":"8","enforcement-mode":"Blocking","post-paid":"false","subscription-id":"968BA1CF-C146-4ADF-A300-308DCF718EEE","lastupdated":1646031617468,"vdevice-dataKey":"172.16.254.4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/logging":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get logging from device (Real Time)","operationId":"getLoggingFromDevice","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Logging":{"description":"Logging","value":{"data":[{"disk_priority":"info","disk_filerotate":10,"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","host_priority":"emerg","lastupdated":1643178776334,"disk_status":"enabled","disk_filename":"vsyslog","disk_filesize":10,"host_status":"disabled","host_vpn_id":0,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/models":{"get":{"tags":["Monitoring - Device Details"],"description":"Get all device models supported by the vManage","operationId":"listAllDeviceModels","parameters":[{"name":"list","in":"query","required":true,"schema":{"type":"string","default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceModelsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/models/{uuid}":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device model for the device","operationId":"getDeviceModels","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device model":{"description":"Device model","value":{"name":"vedge-cloud","displayName":"vEdge Cloud","deviceType":"vedge","isCliSupported":true,"templateSupported":true,"deviceClass":"viptela-router","cpuCountAttribute":{"enable":true,"attributeField":"linux_cpu_count"},"onboardCert":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/monitor":{"get":{"tags":["Monitoring - Device Details"],"description":"Get all monitoring details of the devices","operationId":"listAllMonitorDetailsDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitor device details":{"description":"Monitor device details","value":{"header":{"generatedOn":1635227574211,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-MonitorDeviceDetails"},"columns":[{"title":"Status","property":"status","display":"icon","iconProperty":"status-icon","colorProperty":"status-color","hideable":false,"dataType":"string"},{"title":"Device Type","property":"device-type","display":"keyvalue","keyvalueProperty":"device-type","keyvalue":[{"key":"vsmart","value":"vSmart"},{"key":"vbond","value":"vBond"},{"key":"vmanage","value":"vManage"},{"key":"vedge","value":"WAN Edge"}],"dataType":"string"}],"fields":[{"property":"status","dataType":"string","display":"icon"},{"property":"host-name","dataType":"string","display":"iconAndText"}]},"data":[{"device-model":"vmanage","device-type":"vmanage","system-ip":"169.254.10.1","host-name":"vm200","site-id":"200","layoutLevel":1,"status":"normal"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/multicast/replicator":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get replicator list from device","operationId":"createReplicatorList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Replicator list":{"description":"Replicator list","value":{"data":[{"vdevice-dataKey":"169.254.10.9","vdevice-name":"169.254.10.9","replicator-status":"UP","replicator-address":"172.16.254.1","lastupdated":1655109179818,"vpn-id":"10","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/multicast/rpf":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get RPF list from device","operationId":"createRpfList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"RPF list":{"description":"RPF list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","rpf-address":"10.20.25.18","rpf-status":"resolved","nexthop-count":"1","nbr-addr":"-","rpf-if-name":"ge0/4","rpf-tunnel":"-","vdevice-dataKey":"172.16.254.1","lastupdated":1644997246553}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/multicast/topology":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get topology list from device","operationId":"createTopologyList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topology list":{"description":"Topology list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","group":"225.0.0.0","source":"0.0.0.0","join-type":"(*,G)","rp-address":"58.0.1.100","replicator":"172.16.255.14","upstream-neighbor":"172.16.255.14","upstream-state":"joined","upstream-interface":"172.16.255.14","up-time":"0:01:26:52","up-time-date":"18 07 2022 16:26:52 A z","expires":"0:00:00:31","expires-date":"20 07 2022 16:26:52 A z","oif-tunnel":"-","vdevice-dataKey":"172.16.254.1","lastupdated":1644997246553},{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","group":"225.0.0.9","source":"56.0.1.100","join-type":"(*,G)","rp-address":"-","replicator":"-","upstream-neighbor":"56.0.1.100","upstream-state":"joined","upstream-interface":"ge0/0","up-time":"0:16:26:52","up-time-date":"18 07 2022 16:26:52 A z","expires":"0:16:26:52","expires-date":"20 07 2022 16:26:52 A z","oif-tunnel":"172.16.255.14","vdevice-dataKey":"172.16.254.1","lastupdated":1644997246553}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/multicast/tunnel":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get PIM tunnel from device","operationId":"createPimTunnelList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PIM tunnel":{"description":"PIM tunnel","value":{"data":[{"tunnel-status":"UP","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","replicator":"no","lastupdated":1643179140806,"vpn-id":"10","vdevice-host-name":"vm3","tunnel-address":"172.16.254.1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ndv6":{"get":{"tags":["Real-Time Monitoring - IPv6 Neighbours"],"description":"Get IPv6 Neighbors from device (Real Time)","operationId":"getIpv6Interface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"if-name","in":"query","description":"Interface name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"mac","in":"query","description":"Mac address","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPv6 Neighbors":{"description":"IPv6 Neighbors","value":{"data":[{"if-name":"ge0/1","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"fe80::5054:ff:fea1:4f47","lastupdated":1643172402186,"state":"static","vpn-id":"0","uptime-date":1642659240000,"vdevice-host-name":"vm3","mac":"52:54:00:a1:4f:47","uptime":"5:22:32:19"},{"if-name":"ge0/1","idle-timer":"0:00:00:00","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"fe80::5054:ff:fecf:dad8","lastupdated":1643172402186,"state":"dynamic","vpn-id":"0","uptime-date":1643048160000,"vdevice-host-name":"vm3","mac":"52:54:00:cf:da:d8","uptime":"1:10:30:01"},{"if-name":"ge0/1","idle-timer":"0:00:00:00","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"fe80::fc54:ff:fea1:4f47","lastupdated":1643172402186,"state":"dynamic","vpn-id":"0","uptime-date":1642670640000,"vdevice-host-name":"vm3","mac":"fe:54:00:a1:4f:47","uptime":"5:19:21:53"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/nms/running":{"get":{"tags":["Real-Time Monitoring - NMS"],"description":"Get nms running state from device","operationId":"getRunning","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Nms running":{"description":"Nms running","value":{"data":[{"vdevice-host-name":"vm12","vdevice-dataKey":"172.16.255.22-true","running":"true","vdevice-name":"172.16.255.22","lastupdated":1642648535452}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/ntp/associations":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get NTP peer associations list from device (Real Time)","operationId":"createAssociationsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"NTP peer associations list":{"description":"NTP peer associations list","value":{"data":[{"count":1,"status":"8011","idx":1,"last_event":"mobilize","vdevice-name":"172.16.255.11","associd":"51657","auth":"none","reachability":"no","lastupdated":1647428253985,"conf":"yes","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11-1-51657","condition":"reject"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/ntp/peer":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get NTP peer list from device (Real Time)","operationId":"createPeerList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"NTP peer associations list":{"description":"NTP peer associations list","value":{"data":[{"index":1,"remote":"10.10.10.10","reach":"0","when":"-","lastupdated":1647576150422,"st":"16","delay":"0.000","vdevice-dataKey":"172.16.255.11-1","offset":"+0.000","vdevice-host-name":"vm1","jitter":"0.000","poll":"512","type":"u","refid":".INIT.","vdevice-name":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/ntp/status":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get NTP status list from device (Real Time)","operationId":"createNTPStatusList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"NTP peer associations list":{"description":"NTP peer associations list","value":{"data":[{"sys-poll":"3","stratum":"16","lastupdated":1647483667971,"root-delay":"0.0","vdevice-dataKey":"172.16.255.15-3","reftime":"1970-01-01T00:00:00+00:00","offset":"0.0","kod-type":"ntp-ref-init","root-disp":"38.5","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/omp/cloudx":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get CloudExpress routes received list","operationId":"createOMPCloudXRecv","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudExpress routes received list":{"description":"CloudExpress routes received list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","originator":"172.16.255.14","app-id":"1","app-name":"salesforce","to-peer":"172.16.255.19","from-peer":"172.16.255.20","status":"C,I,R","latency":"0","loss":"0","vdevice-dataKey":"172.16.254.1","lastupdated":1658131633272}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/links":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP connection list","operationId":"createOMPLinkList","parameters":[{"name":"state","in":"query","description":"Connection state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OMP connection list":{"description":"OMP connection list","value":{"data":[{"state":"up","lastupdated":"1646804216515","linkKey":"172.16.255.16-172.16.255.20","adeviceId":"172.16.255.16","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.16","bsystem-ip":"172.16.255.20","asite-id":"600","bsite-id":"200","ahost-name":"vm6","bhost-name":"vm10","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804204258","linkKey":"172.16.255.16-172.16.255.19","adeviceId":"172.16.255.16","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.16","bsystem-ip":"172.16.255.19","asite-id":"600","bsite-id":"100","ahost-name":"vm6","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804204257","linkKey":"172.16.255.15-172.16.255.19","adeviceId":"172.16.255.15","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.15","bsystem-ip":"172.16.255.19","asite-id":"500","bsite-id":"100","ahost-name":"vm5","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804216515","linkKey":"172.16.255.15-172.16.255.20","adeviceId":"172.16.255.15","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.15","bsystem-ip":"172.16.255.20","asite-id":"500","bsite-id":"200","ahost-name":"vm5","bhost-name":"vm10","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804204257","linkKey":"172.16.255.14-172.16.255.19","adeviceId":"172.16.255.14","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.14","bsystem-ip":"172.16.255.19","asite-id":"400","bsite-id":"100","ahost-name":"vm4","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/omp/mcastautodiscoveradvt":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast autodiscover advertised list","operationId":"createOMPMcastAutoDiscoverAdvt","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast autodiscover advertised list":{"description":"OMP multicast autodiscover advertised list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","lastupdated":1643180905996,"source-originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.253.129"},{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","lastupdated":1643180905996,"source-originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/mcastautodiscoverrecv":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast autodiscover received list","operationId":"createOMPMcastAutoDiscoverRecv","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast autodiscover received list":{"description":"OMP multicast autodiscover received list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","from-peer":"172.16.253.129","lastupdated":1643181632850,"source-originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C I R"},{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","from-peer":"172.16.255.130","lastupdated":1643181632851,"source-originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C I R"},{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","from-peer":"0.0.0.0","lastupdated":1643181632852,"source-originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C Red R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/mcastroutesadvt":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast routes advertised list","operationId":"createOMPMcastRoutesAdvt","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast routes advertised list":{"description":"OMP multicast routes advertised list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","address-family":"ipv4","vpn-id":"1","source-originator":"172.16.255.14","destination":"172.16.255.16","group":"225.0.0.1","source":"0.0.0.0","rp":"10.20.25.18","to-peer":"172.16.255.20","vdevice-dataKey":"172.16.254.1-ipv4-10","lastupdated":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/mcastroutesrecv":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast routes received list","operationId":"createOMPMcastRoutesRecv","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast routes received list":{"description":"OMP multicast routes received list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","address-family":"ipv4","vpn-id":"1","source-originator":"172.16.255.14","destination":"172.16.255.16","group":"225.0.0.1","source":"0.0.0.0","from-peer":"172.16.255.19","status":"C,I,R","vdevice-dataKey":"172.16.254.1-ipv4-10","lastupdated":1658131633272}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/peers":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP session list (Real Time)","operationId":"createOMPSessionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OP session list":{"description":"OP session list","value":{"data":[{"domain-id":1,"vdevice-name":"169.254.10.10","refresh":"supported","site-id":129,"type":"vsmart","vdevice-host-name":"vm3","up-time-date":1643135160000,"vdevice-dataKey":"169.254.10.10-172.16.253.129-vsmart","peer":"172.16.253.129","up-time":"0:12:57:30","legit":"yes","lastupdated":1643181828115,"state":"up"},{"domain-id":1,"vdevice-name":"169.254.10.10","refresh":"supported","site-id":130,"type":"vsmart","vdevice-host-name":"vm3","up-time-date":1643135160000,"vdevice-dataKey":"169.254.10.10-172.16.255.130-vsmart","peer":"172.16.255.130","up-time":"0:12:57:30","legit":"yes","lastupdated":1643181828115,"state":"up"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/routes/advertised":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP advertised routes list (Real Time)","operationId":"createAdvertisedRoutesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP advertised routes list":{"description":"OMP advertised routes list","value":{"data":[{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.3.0/24","ip":"172.16.254.2","label":"1069","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","path-id":"65","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643179668956,"to-peer":"172.16.253.129"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.3.0/24","ip":"172.16.254.2","label":"1069","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","path-id":"65","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643179668956,"to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/routes/advertised/ompIpv6":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP advertised routes list (Real Time)","operationId":"createAdvertisedRoutesListIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP advertised routes list":{"description":"OMP advertised routes list","value":{"data":[{"color":"lte","vdevice-name":"172.16.255.16","prefix":"2001:a14:19::/64","ip":"172.16.255.16","advertise-id":"70","label":"1003","encap":"ipsec","site-id":"600","originator":"172.16.255.16","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","path-id":"70","protocol":"connected","vdevice-dataKey":"172.16.255.16-1","metric":"0","lastupdated":1653905306196,"to-peer":"172.16.255.19"},{"color":"lte","vdevice-name":"172.16.255.16","prefix":"2001:a14:19::/64","ip":"172.16.255.16","advertise-id":"70","label":"1003","encap":"ipsec","site-id":"600","originator":"172.16.255.16","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","path-id":"70","protocol":"connected","vdevice-dataKey":"172.16.255.16-1","metric":"0","lastupdated":1653905306196,"to-peer":"172.16.255.20"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/omp/routes/received":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP received routes list (Real Time)","operationId":"createReceivedRoutesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP received routes list":{"description":"OMP received routes list","value":{"data":[{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.5.0/24","ip":"172.16.254.4","from-peer":"172.16.253.129","label":"1047","encap":"ipsec","site-id":"5","originator":"172.16.254.4","vpn-id":"10","vdevice-host-name":"vm3","path-id":"42","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C I R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.5.0/24","ip":"172.16.254.4","from-peer":"172.16.255.130","label":"1047","encap":"ipsec","site-id":"5","originator":"172.16.254.4","vpn-id":"10","vdevice-host-name":"vm3","path-id":"42","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.16.0/24","ip":"172.16.254.16","from-peer":"172.16.253.129","label":"1014","encap":"ipsec","site-id":"16","originator":"172.16.254.16","vpn-id":"10","vdevice-host-name":"vm3","path-id":"38","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C I R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.16.0/24","ip":"172.16.254.16","from-peer":"172.16.255.130","label":"1014","encap":"ipsec","site-id":"16","originator":"172.16.254.16","vpn-id":"10","vdevice-host-name":"vm3","path-id":"38","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.2.0/24","ip":"172.16.254.1","from-peer":"172.16.253.129","label":"1018","encap":"ipsec","site-id":"2","originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","path-id":"29","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C I R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.2.0/24","ip":"172.16.254.1","from-peer":"172.16.255.130","label":"1018","encap":"ipsec","site-id":"2","originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","path-id":"29","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.3.0/24","ip":"172.16.254.2","from-peer":"0.0.0.0","label":"1069","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","path-id":"65","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041520,"attribute-type":"installed","status":"C Red R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/routes/received/ompIpv6":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP received routes list (Real Time)","operationId":"createReceivedRoutesListIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP received routes list":{"description":"OMP received routes list","value":{"data":[{"path-id":"830","vdevice-dataKey":"172.16.255.16-1","vdevice-name":"172.16.255.16","prefix":"2001:a14:18::/64","from-peer":"172.16.255.19","lastupdated":1653904719952,"label":"1003","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","status":"C I R"},{"path-id":"861","vdevice-dataKey":"172.16.255.16-1","vdevice-name":"172.16.255.16","prefix":"2001:a14:18::/64","from-peer":"172.16.255.20","lastupdated":1653904719952,"label":"1003","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","status":"C R"},{"path-id":"70","vdevice-dataKey":"172.16.255.16-1","vdevice-name":"172.16.255.16","prefix":"2001:a14:19::/64","from-peer":"0.0.0.0","lastupdated":1653904719952,"label":"1003","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","status":"C Red R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/omp/services":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP services list","operationId":"createOMPServices","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP services list":{"description":"OMP services list","value":{"data":[{"path-id":"65","vdevice-dataKey":"169.254.10.10-10-VPN-172.16.254.2","vdevice-name":"169.254.10.10","service":"VPN","from-peer":"0.0.0.0","lastupdated":1643250832867,"originator":"172.16.254.2","label":"1077","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C Red R"},{"vdevice-dataKey":"169.254.10.10-10-VPN-172.16.254.2","vdevice-name":"169.254.10.10","service":"VPN","lastupdated":1643250832868,"originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.253.129"},{"vdevice-dataKey":"169.254.10.10-10-VPN-172.16.254.2","vdevice-name":"169.254.10.10","service":"VPN","lastupdated":1643250832869,"originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/status":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get device OMP status","operationId":"getDeviceOMPStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device OMP status":{"description":"Device OMP status","value":{"data":[{"type":"omp","name":"OMP","image":"images/omp.png","count":0,"detailView":"dialog","detailsURL":"/dataservice/device/omp/links","statusList":[{"status":"up","icon":"images/connection/connection-network-up.png","color":"b0e276","name":"up","detailView":"dialog","detailsURL":"/dataservice/device/omp/links?state=up","count":0},{"status":"down","icon":"images/connection/connection-network-down.png","color":"fa7c7d","name":"down","detailView":"dialog","detailsURL":"/dataservice/device/omp/links?state=down","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/omp/summary":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP summary","operationId":"createOMPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OMP summary":{"description":"OMP summary","value":{"data":[{"tlocs-sent":4,"policy-sent":0,"mcast-routes-sent":0,"packets-sent":81579,"vdevice-name":"169.254.10.10","inform-sent":14,"packets-received":81956,"routes-received":18,"tlocs-received":22,"mcast-routes-installed":0,"update-sent":84,"devicetype":"vedge","mcast-routes-received":0,"hello-received":81472,"alert-sent":0,"update-received":468,"vsmart-peers":2,"operstate":"UP","policy-received":0,"handshake-received":2,"handshake-sent":2,"alert-received":0,"services-sent":4,"vdevice-host-name":"vm3","inform-received":14,"vdevice-dataKey":"169.254.10.10--","tlocs-installed":10,"services-installed":0,"ompuptime":"9:11:16:34","services-received":2,"lastupdated":1645494228477,"routes-sent":4,"hello-sent":81479,"routes-installed":8,"adminstate":"UP"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/synced/peers":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OP session list","operationId":"createSyncedOMPSessionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OP session list":{"description":"OP session list","value":{"data":[{"domain-id":1,"vdevice-name":"172.16.255.11","createTimeStamp":1646804055895,"refresh":"supported","site-id":100,"type":"vsmart","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11-172.16.255.19-vsmart","@rid":568,"vmanage-system-ip":"172.16.255.11","peer":"172.16.255.19","legit":"yes","lastupdated":1646804055844,"region-id":"None","state":"up"},{"domain-id":1,"vdevice-name":"172.16.255.11","createTimeStamp":1646804061584,"refresh":"supported","site-id":200,"type":"vsmart","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11-172.16.255.20-vsmart","@rid":574,"vmanage-system-ip":"172.16.255.11","peer":"172.16.255.20","legit":"yes","lastupdated":1646804055844,"region-id":"None","state":"up"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/tlocs/advertised":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get advertised TLOCs list (Real Time)","operationId":"createAdvertisedTlocsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Advertised TLOCs list":{"description":"Advertised TLOCs list","value":{"data":[{"color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.2","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","weight":"1","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vdevice-host-name":"vm3","tloc-public-ip":"10.101.3.3","tloc-public-port":"12406","tloc-private-ip":"10.101.3.3","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.2","tloc-private-port":"12406","tloc-spi":"286","lastupdated":1643179953349,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4","to-peer":"172.16.253.129"},{"color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.2","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","weight":"1","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vdevice-host-name":"vm3","tloc-public-ip":"10.101.3.3","tloc-public-port":"12406","tloc-private-ip":"10.101.3.3","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.2","tloc-private-port":"12406","tloc-spi":"286","lastupdated":1643179953351,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4","to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/tlocs/received":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get received TLOCs list (Real Time)","operationId":"createReceivedTlocsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Received TLOCs list":{"description":"Received TLOCs list","value":{"data":[{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.1","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.253.129","weight":"1","encap":"ipsec","site-id":"2","originator":"172.16.254.1","vdevice-host-name":"vm3","tloc-public-ip":"10.101.2.2","tloc-public-port":"12386","tloc-private-ip":"10.101.2.2","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.1","tloc-private-port":"12386","tloc-spi":"263","lastupdated":1643185163270,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.2","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"0.0.0.0","weight":"1","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vdevice-host-name":"vm3","tloc-public-ip":"10.101.3.3","tloc-public-port":"12406","tloc-private-ip":"10.101.3.3","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.2","tloc-private-port":"12406","tloc-spi":"287","lastupdated":1643185163276,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.3","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.255.130","weight":"1","encap":"ipsec","site-id":"4","originator":"172.16.254.3","vdevice-host-name":"vm3","tloc-public-ip":"10.101.4.4","tloc-public-port":"12406","tloc-private-ip":"10.101.4.4","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.3","tloc-private-port":"12406","tloc-spi":"284","lastupdated":1643185163281,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.4","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.255.130","weight":"1","encap":"ipsec","site-id":"5","originator":"172.16.254.4","vdevice-host-name":"vm3","tloc-public-ip":"10.102.5.5","tloc-public-port":"12406","tloc-private-ip":"10.102.5.5","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.4","tloc-private-port":"12406","tloc-spi":"288","lastupdated":1643185163286,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.5","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.253.129","weight":"1","encap":"ipsec","site-id":"6","originator":"172.16.254.5","vdevice-host-name":"vm3","tloc-public-ip":"10.102.6.6","tloc-public-port":"12406","tloc-private-ip":"10.102.6.6","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.5","tloc-private-port":"12406","tloc-spi":"292","lastupdated":1643185163290,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.16","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.253.129","weight":"1","encap":"ipsec","site-id":"16","originator":"172.16.254.16","vdevice-host-name":"vm3","tloc-public-ip":"10.102.16.16","tloc-public-port":"12406","tloc-private-ip":"10.102.16.16","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.16","tloc-private-port":"12406","tloc-spi":"287","lastupdated":1643185163295,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/ondemand/local":{"get":{"tags":["Real-Time Monitoring - Show On Demand Local"],"description":"Get on-demand local (Real Time)","operationId":"getOnDemandLocal","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"On Demand Local list":{"description":"On Demand Local list","value":{"data":[{"status":"-","site-id":"5","on-demand":"no","lastupdated":1642667823842,"idle-timeout-expiry":"10","vdevice-dataKey":"169.254.10.12-","vdevice-host-name":"vm5","vdevice-name":"169.254.10.12","system-ip":"172.16.254.4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ondemand/remote":{"get":{"tags":["Real-Time Monitoring - Show On Demand Remote"],"description":"Get on-demand remote (Real Time)","operationId":"getOnDemandRemote","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"On Demand Remote list":{"description":"On Demand Remote list","value":{"data":[{"status":"-","site-id":"3","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.2"},{"status":"-","site-id":"4","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.3"},{"status":"-","site-id":"5","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.4"},{"status":"-","site-id":"6","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.5"},{"status":"-","site-id":"16","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/orchestrator/connections":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get connection list from device","operationId":"createConnectionListFromDevice","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection list":{"description":"Connection list","value":{"data":[{"peer-region-id-set":"N/A","domain-id":1,"site-id":100,"local-color":"default","uptime":"1:23:51:47","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.19","state":"up","private-port":12355,"public-port":12355,"public-ip":"10.0.5.19","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.5.19","vdevice-name":"172.16.255.26","system-ip":"172.16.255.19"},{"peer-region-id-set":"N/A","domain-id":1,"site-id":100,"local-color":"default","uptime":"1:23:51:46","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.19","state":"up","private-port":12455,"public-port":12455,"public-ip":"10.0.5.19","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.5.19","vdevice-name":"172.16.255.26","system-ip":"172.16.255.19"},{"peer-region-id-set":"N/A","domain-id":1,"site-id":200,"local-color":"default","uptime":"1:23:51:47","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.20","state":"up","private-port":12356,"public-port":12356,"public-ip":"10.0.12.20","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.12.20","vdevice-name":"172.16.255.26","system-ip":"172.16.255.20"},{"peer-region-id-set":"N/A","domain-id":1,"site-id":200,"local-color":"default","uptime":"1:23:51:46","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.20","state":"up","private-port":12456,"public-port":12456,"public-ip":"10.0.12.20","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.12.20","vdevice-name":"172.16.255.26","system-ip":"172.16.255.20"},{"domain-id":0,"site-id":200,"local-color":"default","uptime":"1:23:51:45","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vmanage-172.16.255.22","state":"up","private-port":12346,"public-port":12346,"public-ip":"10.0.12.22","uptime-date":1649589180000,"peer-type":"vmanage","vdevice-host-name":"vm16","private-ip":"10.0.12.22","vdevice-name":"172.16.255.26","system-ip":"172.16.255.22"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/connectionshistory":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get connection history list from device","operationId":"createConnectionHistoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection history list":{"description":"Connection history list","value":{"data":[{"remote-color":"default","index":0,"site-id":500,"public-port":12386,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"default","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-0-2022-04-10T12:23:23+0000","state":"up","domain-id":1,"private-port":12386,"public-ip":"10.1.15.15","downtime":"2022-04-10T12:23:23+0000","vdevice-host-name":"vm16","private-ip":"10.1.15.15","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"},{"remote-color":"default","index":1,"site-id":100,"public-port":12386,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"default","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-1-2022-04-10T11:48:32+0000","state":"up","domain-id":1,"private-port":12386,"public-ip":"10.0.5.11","downtime":"2022-04-10T11:48:32+0000","vdevice-host-name":"vm16","private-ip":"10.0.5.11","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"},{"remote-color":"default","index":2,"site-id":0,"public-port":12387,"peer-type":"unknown","local_enum":"DHSTMO","rep-count":0,"local-color":"default","remote_enum":"NOERR","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-2-2022-04-10T11:48:21+0000","state":"connect","domain-id":0,"private-port":0,"public-ip":"10.0.5.11","downtime":"2022-04-10T11:48:21+0000","vdevice-host-name":"vm16","private-ip":"::","remote_enum-desc":"NoError.","local_enum-desc":"DTLSHandShakeTimeout.","vdevice-name":"172.16.255.26"},{"remote-color":"lte","index":3,"site-id":600,"public-port":12366,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"lte","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-3-2022-04-10T11:13:44+0000","state":"up","domain-id":1,"private-port":12366,"public-ip":"10.1.16.16","downtime":"2022-04-10T11:13:44+0000","vdevice-host-name":"vm16","private-ip":"10.1.16.16","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"},{"remote-color":"lte","index":4,"site-id":100,"public-port":12377,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"lte","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-4-2022-04-10T11:13:41+0000","state":"up","domain-id":1,"private-port":12377,"public-ip":"10.0.5.21","downtime":"2022-04-10T11:13:41+0000","vdevice-host-name":"vm16","private-ip":"10.0.5.21","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/localproperties":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get local properties list from device","operationId":"createLocalPropertiesListList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Local properties list":{"description":"Local properties list","value":{"data":[{"certificate-not-valid-before":"Apr1010:34:032022GMT","certificate-status":"Installed","protocol":"dtls","uuid":"0a3c20df-82d6-43d4-b27f-a67864d35950","root-ca-chain-status":"Installed","certificate-not-valid-after":"Apr1010:34:032023GMT","sp-organization-name":"vIPtelaIncRegression","lastupdated":1649766458903,"certificate-validity":"Valid","vdevice-dataKey":"172.16.255.26","vedge-list-version":"0","number-active-wan-interfaces":"1","system-ip":"172.16.255.26","organization-name":"vIPtelaIncRegression","vdevice-host-name":"vm16","device-type":"vbond","vdevice-name":"172.16.255.26","vsmart-list-version":"0","board-serial":"12346571"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/proxymapping":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get reverse proxy mapping from vbond","operationId":"createReverseProxyMappingList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reverse proxy mapping":{"description":"Reverse proxy mapping","value":{"data":[{"vdevice-name":"172.16.255.26","vdevice-host-name":"vm16","uuid":"1b852227-4a15-48be-8637-3e995b934578","private-ip":"10.0.12.19","private-port":"23456","proxy-ip":"10.0.37.19","proxy-port":"23456","lastupdated":1658198416779,"vdevice-dataKey":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/orchestrator/statistics":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get statistics from device","operationId":"getStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Statistics":{"description":"Statistics","value":{"data":[{"tx_challenge_ack":13,"tx_registers":0,"rx_pkts":168816,"tx_error":0,"vdevice-dataKey":"172.16.255.26","tx_challenge":15,"rx_challenge_ack":0,"tx_dtls_handshake_done":0,"vdevice-host-name":"vm16","tx_dtls_handshake_failures":0,"tx_challenge_gen_error":0,"rx_connects":0,"rx_octets":42608317,"rx_registers":64644,"lastupdated":1649768154244,"rx_challenge_resp":15,"tx_register_replies":64644,"tx_challenge_ack_error":0,"rx_challenge":0,"tx_dtls_handshake":0,"rx_dtls_handshake_done":15,"rx_dtls_handshake_failures":0,"rx_error":0,"challenge_failures":2,"tx_challenge_resp_error":0,"vdevice-name":"172.16.255.26","tx_blocked":0,"tx_connects":64671,"tx_octets":63147501,"tx_challenge_error":0,"rx_register_replies":0,"tx_challenge_resp":0,"tx_pkts":242150,"rx_dtls_handshake":70}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/summary":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get connection summary from device","operationId":"createConnectionSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection summary":{"description":"Connection summary","value":{"data":[{"protocol":"dtls","listening_port":12346,"listening_ip":"0.0.0.0","vsmart_counts":4,"vmanage_counts":2,"lastupdated":1649816906161,"instance":0,"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-0","listening_ipv6":"::","vedge_counts":0,"vdevice-name":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/validvedges":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get valid device list from device","operationId":"createValidDevicesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Valid device list":{"description":"Valid device list","value":{"data":[{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-1BFB0237-AFCA-4583-BF0C-BECD124565D6-12346572","serial-number":"12346572","validity":"valid","lastupdated":1649818236214,"chassis-number":"1BFB0237-AFCA-4583-BF0C-BECD124565D6","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-33418D3F-286E-4256-A7CB-7BF3A70E1ED8-12346570","serial-number":"12346570","validity":"valid","lastupdated":1649818236214,"chassis-number":"33418D3F-286E-4256-A7CB-7BF3A70E1ED8","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-4D0318BF-472E-4114-B72D-A5E99C5AFAD7-12346580","serial-number":"12346580","validity":"valid","lastupdated":1649818236214,"chassis-number":"4D0318BF-472E-4114-B72D-A5E99C5AFAD7","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-ADC329CC-701C-42D6-84C6-245F09C25583-12346578","serial-number":"12346578","validity":"valid","lastupdated":1649818236214,"chassis-number":"ADC329CC-701C-42D6-84C6-245F09C25583","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E-12346575","serial-number":"12346575","validity":"valid","lastupdated":1649818236214,"chassis-number":"C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E","vdevice-name":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/validvmanageid":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get valid vManage Id from device","operationId":"getValidVManageId","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Valid vManage Id":{"description":"Valid vManage Id","value":{"data":[{"chassis-number":"a52d3492-755a-4a02-9a3d-8bdf2dc1d241","vdevice-dataKey":"172.16.255.26-","vdevice-name":"172.16.255.26","lastupdated":1649823209136,"vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/validvsmarts":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get valid vSmart list from device","operationId":"createValidVSmartsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Valid vSmart list":{"description":"Valid vSmart list","value":{"data":[{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-12346567","serial-number":"12346567","vdevice-name":"172.16.255.26","lastupdated":1649824251432},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-12346569","serial-number":"12346569","vdevice-name":"172.16.255.26","lastupdated":1649824251432},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-12346573","serial-number":"12346573","vdevice-name":"172.16.255.26","lastupdated":1649824251432}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/ospf/database":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF database list from device (Real Time)","operationId":"createOSPFDatabaseList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF database list":{"description":"OSPF database list","value":{"data":[{"area":0,"link-id":"172.16.255.11","data":"10.2.2.11","vdevice-name":"172.16.255.11","link-count":"1","vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.11","lsa-type":"router","router-link-id":"10.2.2.12","router-link-type":"transit","sequence":"2147483652","vdevice-dataKey":"172.16.255.11-1-0","checksum":"50110","lastupdated":1646791144576,"tos-metric":"10","age":"153"},{"area":0,"link-id":"172.16.255.12","data":"10.2.2.12","vdevice-name":"172.16.255.11","link-count":"2","vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.12","lsa-type":"router","router-link-id":"10.2.2.12","router-link-type":"transit","sequence":"2147483655","vdevice-dataKey":"172.16.255.11-1-0","checksum":"52821","lastupdated":1646791144576,"tos-metric":"10","age":"153"},{"area":0,"link-id":"172.16.255.21","data":"10.2.3.21","vdevice-name":"172.16.255.11","link-count":"1","vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.21","lsa-type":"router","router-link-id":"10.2.3.21","router-link-type":"transit","sequence":"2147483651","vdevice-dataKey":"172.16.255.11-1-0","checksum":"8760","lastupdated":1646791144576,"tos-metric":"10","age":"154"},{"area":0,"sequence":"2147483649","link-id":"10.2.2.12","vdevice-dataKey":"172.16.255.11-1-0","vdevice-name":"172.16.255.11","checksum":"63980","lastupdated":1646791144576,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.12","age":"154","lsa-type":"network"},{"area":0,"sequence":"2147483649","link-id":"10.2.3.21","vdevice-dataKey":"172.16.255.11-1-0","vdevice-name":"172.16.255.11","checksum":"59106","lastupdated":1646791144576,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.21","age":"155","lsa-type":"network"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/databaseexternal":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF external database list from device (Real Time)","operationId":"createOSPFDatabaseExternal","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF external database list":{"description":"OSPF external database list","value":{"data":[{"link-id":"10.20.25.0","options-flags":"EDN","vdevice-name":"172.16.255.11","prefix":"10.20.25.0/24","metric-type":"type2","length":36,"flags":11,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.11","forwarding-addr":"0.0.0.0","sequence":2147483650,"vdevice-dataKey":"172.16.255.11-1-10.20.25.0","metric":"16777214","checksum":62048,"options":130,"lastupdated":1646791949860,"tag":0,"age":958},{"link-id":"10.20.25.0","options-flags":"EDN","vdevice-name":"172.16.255.11","prefix":"10.20.25.0/24","metric-type":"type2","length":36,"flags":6,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.21","forwarding-addr":"0.0.0.0","sequence":2147483650,"vdevice-dataKey":"172.16.255.11-1-10.20.25.0","metric":"16777214","checksum":46738,"options":130,"lastupdated":1646791949860,"tag":0,"age":959},{"link-id":"172.16.255.112","options-flags":"E","vdevice-name":"172.16.255.11","prefix":"172.16.255.112/32","metric-type":"type2","length":36,"flags":6,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.12","forwarding-addr":"0.0.0.0","sequence":2147483651,"vdevice-dataKey":"172.16.255.11-1-172.16.255.112","metric":"20","checksum":58083,"options":2,"lastupdated":1646791949860,"tag":0,"age":958}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/databasesummary":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF database summary list from device (Real Time)","operationId":"createOSPFDatabaseSummaryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF database summary list":{"description":"OSPF database summary list","value":{"data":[{"vdevice-dataKey":"172.16.255.11-1-0","router-lsa":3,"total-lsa":5,"vdevice-name":"172.16.255.11","summary-lsa":0,"nssa-lsa":0,"network-lsa":2,"lastupdated":1646792331519,"area-id":0,"vpn-id":1,"asbr-summary-lsa":0,"vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/interface":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF interface list from device (Real Time)","operationId":"createOSPFInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF interface list":{"description":"OSPF interface list","value":{"data":[{"lastupdated":1646026461327,"vdevice-dataKey":"169.254.10.14-0-1--","vdevice-name":"169.254.10.14","router-id":"0","vdevice-host-name":"vm16","instance-id":"1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/neighbor":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF neighbor list from device (Real Time)","operationId":"createOSPFNeighbors","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF neighbor list":{"description":"OSPF neighbor list","value":{"data":[{"lastupdated":1646027273671,"vdevice-dataKey":"169.254.10.14-0-1---","vdevice-name":"169.254.10.14","router-id":"0","vdevice-host-name":"vm16","instance-id":"1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/process":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF process list from device (Real Time)","operationId":"createOSPFProcess","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF process list":{"description":"OSPF process list","value":{"data":[{"ls-ack-sent":"5","summary-lsa-checksum":"0","vdevice-name":"172.16.255.11","spf-max-holdtime":"10000","spf-holdtime":"1000","number-areas":"1","rfc1583-compatible":"true","lsa-count":"5","external-lsa-checksum":"166869","router-id":"172.16.255.11","hello-received":"172","ignore-down-bit":"false","area-id":"0","dbd-received":"2","network-lsa-checksum":"123086","summary-lsa-count":"0","router-lsa-count":"3","router-lsa-checksum":"111691","spf-delay":"200","spf-hold-multiplier":"1","external-lsa-count":"3","ls-ack-received":"5","asbr-lsa-count":"0","vpn-id":"1","vdevice-host-name":"vm1","spf-last-exec-time":"1663","backbone-area":"true","network-lsa-count":"2","ls-req-sent":"1","asbr-lsa-checksum":"0","dbd-sent":"3","vdevice-dataKey":"172.16.255.11-1-","lsa-refresh-interval":"10","ls-upd-received":"12","nssa-lsa-count":"0","ls-req-received":"1","num-full-adj-routers":"1","spf-exec-count":"3","lastupdated":1646792665279,"ls-upd-sent":"8","nssa-lsa-checksum":"0","hello-sent":"172","num-interfaces":"1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/routes":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF route list from device (Real Time)","operationId":"createOSPFRoutesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF route list":{"description":"OSPF route list","value":{"data":[{"cost":"10","dest-type":"router","vdevice-name":"172.16.255.11","prefix":"172.16.255.12/32","flags":"2","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-router-172.16.255.12/32-0","route-type":"router","lastupdated":1646793742274,"area-id":"0","next-hop":"10.2.2.12","path-type":"intra-area"},{"cost":"20","dest-type":"router","vdevice-name":"172.16.255.11","prefix":"172.16.255.21/32","flags":"2","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-router-172.16.255.21/32-0","route-type":"router","lastupdated":1646793742276,"area-id":"0","next-hop":"10.2.2.12","path-type":"intra-area"},{"cost":"10","dest-type":"network","vdevice-name":"172.16.255.11","prefix":"10.2.2.0/24","flags":"0","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-network-10.2.2.0/24-0","route-type":"network","lastupdated":1646793742276,"area-id":"0","next-hop":"0.0.0.0","path-type":"intra-area"},{"cost":"20","dest-type":"network","vdevice-name":"172.16.255.11","prefix":"10.2.3.0/24","flags":"0","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-network-10.2.3.0/24-0","route-type":"network","lastupdated":1646793742276,"area-id":"0","next-hop":"10.2.2.12","path-type":"intra-area"},{"dest-type":"network","vdevice-name":"172.16.255.11","prefix":"172.16.255.112/32","flags":"78","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","type2-cost":"20","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-external-172.16.255.112/32-0","route-type":"external","lastupdated":1646793742276,"tag":"0","next-hop":"10.2.2.12","path-type":"external2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/v3interface":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF v3 interface list from device (Real Time)","operationId":"createOSPFv3Interface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF v3 interface list":{"description":"OSPF v3 interface list","value":{"data":[{"router-id":"90.90.90.90","af":"ospfv3-address-family-ipv4","area-id":"300","lastupdated":1649681917917,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300-","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"router-id":"100.100.5.101","af":"ospfv3-address-family-ipv6","area-id":"300","lastupdated":1649681917917,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300-","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/v3neighbor":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF v3 neighbor list from device (Real Time)","operationId":"createOSPFv3Neighbors","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF v3 neighbor list":{"description":"OSPF v3 neighbor list","value":{"data":[{"router-id":"90.90.90.90","af":"ospfv3-address-family-ipv4","area-id":"300","lastupdated":1649682289885,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300--","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"router-id":"100.100.5.101","af":"ospfv3-address-family-ipv6","area-id":"300","lastupdated":1649682289885,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300--","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/interface":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM interface list from device","operationId":"createPIMInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM interface list":{"description":"PIM interface list","value":{"data":[{"if-name":"ge0/0","dr-address":"100.100.3.101","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","if-addr":"100.100.3.101/24","neighbor-count":0,"hello-interval":30,"lastupdated":1643258686605,"join-prune-interval":60,"vpn-id":"10","priority":1,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/neighbor":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM neighbor list from device","operationId":"createPIMNeighborList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM neighbor list":{"description":"PIM neighbor list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","if-name":"ge0/0.1","nbr-addr":"10.0.9.11","up-time":"0:12:12:12","up-time-date":"0:12:12:12 2022/07/19","expires":"0:23:01:44","expires-date":"0:23:01:44 2022/07/19","priority":"1","hold-time":"105","dr-address":"10.0.9.14","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/rp-mapping":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM Rp-mapping list from device","operationId":"createPIMRpMappingList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM Rp-mapping list":{"description":"PIM Rp-mapping list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","type":"Auto-RP","group":"225.0.0.0/24","rp-address":"225.0.0.0/24","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"},{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"2","type":"Auto-RP","group":"227.0.0.0/24","rp-address":"58.0.2.100 ","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/statistics":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM statistics list from device","operationId":"createPIMStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM statistics list":{"description":"PIM statistics list","value":{"data":[{"hello-rx":0,"unknown-rx":0,"vdevice-name":"169.254.10.10","vpn-id":"10","vdevice-host-name":"vm3","bad-rx":0,"join-prune-tx":0,"vdevice-dataKey":"169.254.10.10","join-prune-rx":0,"auto-rp-mapping-rx":0,"unsupported-rx":0,"lastupdated":1643259067333,"assert-rx":0,"auto-rp-announce-rx":0,"assert-tx":0,"hello-tx":1090}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policer":{"get":{"tags":["Real-Time Monitoring - Policer"],"description":"Get policed interface list from device","operationId":"getPolicedInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policed interface":{"description":"Policed interface","value":{"data":[{"oos-bytes":"0","oos-action":"drop","vdevice-dataKey":"169.254.10.10-10","vdevice-name":"169.254.10.10","rate":81920,"oos-pkts":"0","name":"TCPOPT_SYN_POLICER","index":10,"lastupdated":1643264577448,"burst":10240,"vdevice-host-name":"vm3","direction":"in"},{"oos-bytes":"0","oos-action":"drop","vdevice-dataKey":"169.254.10.10-11","vdevice-name":"169.254.10.10","rate":100000000,"oos-pkts":"0","name":"TCPOPT_DATA_POLICER","index":11,"lastupdated":1643264577448,"burst":12500000,"vdevice-host-name":"vm3","direction":"in"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistassociations":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list associations from device","operationId":"createPolicyAccessListAssociations","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{"data":[{"vdevice-dataKey":"172.16.255.16-pol-acl-test","vdevice-name":"172.16.255.16","name":"pol-acl-test","lastupdated":1653374017047,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistcounters":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list counter from device","operationId":"createPolicyAccessListCounters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list counter":{"description":"Access list counter","value":{"data":[{"vdevice-dataKey":"172.16.255.16-pol-acl-test","counter-name":"default_action_count","vdevice-name":"172.16.255.16","bytes":"0","name":"pol-acl-test","lastupdated":1653374287187,"vdevice-host-name":"vm6","packets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistnames":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list names from device","operationId":"createPolicyAccessListNames","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list names":{"description":"Access list names","value":{"data":[{"vdevice-dataKey":"172.16.255.16-pol-acl-test","vdevice-name":"172.16.255.16","name":"pol-acl-test","lastupdated":1653374338991,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistpolicers":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list policers from device","operationId":"createPolicyAccessListPolicers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list policers":{"description":"Access list policers","value":{"data":[{"name":"pol-acl-test","lastupdated":1653374393223,"vdevice-dataKey":"172.16.255.16-pol-acl-test-","vdevice-name":"172.16.255.16","vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/approutepolicyfilter":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get approute policy filter from device","operationId":"createPolicyAppRoutePolicyFilter","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Approute policy filter":{"description":"Approute policy filter","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","policy-name":"accept_nat","vpn-name":"vpn_1","counter-name":"natpool1","packets":18179,"bytes":"27448882","vdevice-dataKey":"172.16.255.16-accept_nat-vpn_1-natpool1","lastupdated":1656400527112},{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","policy-name":"accept_nat","vpn-name":"vpn_1","counter-name":"natpool2","packets":18229,"bytes":"27441234","vdevice-dataKey":"172.16.255.16-accept_nat-vpn_1-natpool2","lastupdated":1656400527112},{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","policy-name":"accept_nat","vpn-name":"vpn_1","counter-name":"natpool3","packets":18888,"bytes":"27444442","vdevice-dataKey":"172.16.255.16-accept_nat-vpn_1-natpool3","lastupdated":1656400527112}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/datapolicyfilter":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get data policy filters from device","operationId":"createPolicDataPolicyFilter","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data policy filter":{"description":"Data policy filter","value":{"data":[{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool1","counter-name":"natpool1","vdevice-name":"172.16.255.15","bytes":"27448882","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":18179},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool2","counter-name":"natpool2","vdevice-name":"172.16.255.15","bytes":"27042692","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17910},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool3","counter-name":"natpool3","vdevice-name":"172.16.255.15","bytes":"26630462","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17637},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool4","counter-name":"natpool4","vdevice-name":"172.16.255.15","bytes":"26252860","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17386},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool5","counter-name":"natpool5","vdevice-name":"172.16.255.15","bytes":"25849690","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17119},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-default_action_count","counter-name":"default_action_count","vdevice-name":"172.16.255.15","bytes":"0","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/filtermemoryusage":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get data policy filter memory usage from device","operationId":"createPolicyFilterMemoryUsage","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data policy filter memory usage":{"description":"Data policy filter memory usage","value":{"data":[{"filter-max":"512","vdevice-dataKey":"169.254.10.10-0","vdevice-name":"169.254.10.10","blocks-used":"0","blocks-max":"1048576","filter-used":"0","lastupdated":1643266183894,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/iptosgtbindings":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show ip to sgt binding from Vsmart","operationId":"showVsmartIptoSgtBinding","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/iptouserbindings":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show ip to user binding from Vsmart","operationId":"showVsmartIptoUserBinding","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistassociations":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list associations from device","operationId":"createPolicyAccessListAssociationsIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{"data":[{"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test","vdevice-name":"172.16.255.16","name":"ipv6_pol-acl-test","lastupdated":1653376026043,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistcounters":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list counters from device","operationId":"createPolicyAccessListCountersIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list counters":{"description":"Access list counters","value":{"data":[{"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test","counter-name":"default_action_count","vdevice-name":"172.16.255.16","bytes":"0","name":"ipv6_pol-acl-test","lastupdated":1653376073433,"vdevice-host-name":"vm6","packets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistnames":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list names from device","operationId":"createPolicyAccessListNamesIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list names":{"description":"Access list names","value":{"data":[{"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test","vdevice-name":"172.16.255.16","name":"ipv6_pol-acl-test","lastupdated":1653376118299,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistpolicers":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list policers from device","operationId":"createPolicyAccessListPolicersIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list policers":{"description":"Access list policers","value":{"data":[{"name":"ipv6_pol-acl-test","lastupdated":1653376169819,"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test-","vdevice-name":"172.16.255.16","vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/pxgridstatus":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show Pxgrid status From Vsmart","operationId":"showVsmartPxGridStatus","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/pxgridusersessions":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show Pxgrid sessions From Vsmart","operationId":"showVsmartPxGridUserSessions","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/qosmapinfo":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get QoS map information from device","operationId":"createPolicQosMapInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"QoS map information":{"description":"QoS map information","value":{"data":[{"lastupdated":1654481032855,"vdevice-dataKey":"169.254.10.9-policy_qos_map","vdevice-name":"169.254.10.9","qos-map-name":"policy_qos_map","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/qosschedulerinfo":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get QoS scheduler information from device","operationId":"createPolicQosSchedulerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"QoS scheduler information":{"description":"QoS scheduler information","value":{"data":[{"vdevice-dataKey":"169.254.10.9-policy_qos_map_0","vdevice-name":"169.254.10.9","qos-map-name":"policy_qos_map","buffer-percent":"100","lastupdated":1654481134775,"bandwidth-percent":"100","qos-scheduler-name":"policy_qos_map_0","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/rewriteassociations":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get rewrite associations information from device","operationId":"createPolicyRewriteAssociationsInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Rewrite associations information":{"description":"Rewrite associations information","value":{"data":[{"name":"vpn10_rewrite_policy","lastupdated":1654562464357,"vdevice-dataKey":"169.254.10.9-vpn10_rewrite_policy","vdevice-name":"169.254.10.9","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/userusergroupbindings":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Show User-Usergroup bindings from Vsmart","operationId":"showVsmartUserUsergroupBindings","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":[{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:Employee","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser0"},{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:TestUserGroup-1","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser0"},{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:Employee","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser1"},{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:TestUserGroup-1","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser1"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/vsmart":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show Sdwan Policy From Vsmart","operationId":"showSdwanPolicyFromVsmart","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","name":"dp1","app-list":"SSH_policy","vpn-list":"vpn_1_list","vpn-id":"1","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zbfwdropstatistics":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone drop statistics from device","operationId":"getZoneDropStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone drop statistics":{"description":"Zone drop statistics","value":{"data":[{"l4-tcp-l7-ooo-seg":"0","l4-icmp-err-l4-invalid-seq":"0","policy-action-drop":"0","l4-icmp-err-no-ip-no-icmp":"0","l7-type-drop":"0","l4-scb-close":"0","l4-tcp-invalid-seg-synsent-state":"0","l4-tcp-syn-flood-drop":"0","l4-icmp-internal-err-no-nat":"0","l4-tcp-invalid-seq":"0","l7-no-seg":"0","no-new-session":"0","l4-icmp-internal-err-get-stat-blk-fail":"0","syncookie-max-dst":"0","insp-internal-err-get-stat-blk-fail":"0","l4-invalid-hdr":"0","l4-icmp-internal-err-alloc-fail":"0","l4-tcp-invalid-seg-pkt-win-overflow":"0","no-forwarding-zone":"0","l4-icmp-too-many-err-pkts":"0","fdb-err":"0","no-session":"0","insp-dstaddr-lookup-fail":"0","l4-session-limit":"0","insp-class-action-drop":"0","l4-tcp-rst-to-resp":"0","l4-tcp-stray-seg":"0","not-initiator":"0","backpressure":"0","l4-tcp-invalid-tcp-initiator":"0","l4-icmp-pkt-too-short":"0","zone-mismatch":"0","l4-tcp-unexpect-tcp-payload":"0","l7-no-frag":"0","l4-tcp-invalid-seg-pyld-after-fin-send":"0","l4-icmp-err-policy-not-present":"0","l7-alg-ret-drop":"0","l4-tcp-internal-err-synflood-alloc-hostdb-fail":"0","insp-classification-fail":"0","l4-tcp-invalid-win-scale-option":"0","l4-tcp-syn-in-win":"0","policy-icmp-action-drop":"0","vdevice-name":"169.254.10.12","lisp-inner-ipv6-insane":"0","l4-tcp-rst-in-win":"0","l4-tcp-retrans-invalid-flags":"0","catch-all":"0","l4-icmp-err-l4-invalid-ack":"0","syncookie-trigger":"0","l7-unknown-proto":"0","l4-tcp-syn-with-data":"0","l4-tcp-invalid-seg-pkt-too-old":"0","l4-icmp-err-classification-fail":"0","l4-icmp-internal-err-dir-not-identified":"0","l4-internal-err-undefined-dir":"0","insp-policy-not-present":"0","syncookie-internal-err-alloc-fail":"0","lisp-header-restore-fail":"0","l4-tcp-synflood-blackout-drop":"0","l4-tcp-invalid-ack-flag":"0","insp-pam-lookup-fail":"0","l4-icmp-scb-close":"0","invalid-zone":"0","ha-ar-standby":"0","vdevice-host-name":"vm5","l4-tcp-invalid-seg-synrcvd-state":"0","l4-tcp-invalid-ack-num":"0","l7-promote-fail-no-policy":"0","l4-too-many-pkts":"0","l4-icmp-err-pkts-burst":"0","l7-promote-fail-no-zone-pair":"0","vdevice-dataKey":"169.254.10.12-0","l4-icmp-err-multiple-unreach":"0","policy-fragment-drop":"0","l4-tcp-invalid-flags":"0","lisp-inner-ipv4-insane":"0","lastupdated":1645666649064,"l4-max-halfsession":"0","insp-sess-miss-policy-not-present":"0","l4-icmp-pkt-no-ip-hdr":"0","insp-policy-misconfigure":"0","lisp-inner-pkt-insane":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zbfwstatistics":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone based firewall statistics from device","operationId":"getZbfwStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone based firewall statistics":{"description":"Zone based firewall statistics","value":{"data":[{"no-pair-diff-zone-dropped":"0","tcp-retrans-seg":"0","flow-add-fail":"0","vdevice-name":"169.254.10.10","tcp-drop-stray-seg":"0","tcp-drop-invalid-seg-pkt-too-old":"0","zbf-pkts":"0","state-check-fail":"0","unsupported-proto":"0","no-pair-same-zone-allowed":"0","zone-no-zone-inet-denied":"0","tcp-drop-invalid-seg-synsent-state":"0","max-halfopen-exceeded":"0","tcp-drop-invalid-flags":"0","tcp-drop-unexpect-tcp-pyld":"0","num-flow-entries":"0","tcp-ooo-seg":"0","tcp-drop-invalid-seg-synrcvd-state":"0","tcp-drop-no-syn-in-listen-state":"0","tcp-drop-invalid-ack-flag":"0","fragments":"0","zone-no-zone-dropped":"0","no-zone-no-zone-allowed":"0","tcp-drop-invalid-ack-num":"0","policy-change-dropped":"0","tcp-drop-rst-to-resp":"0","tcp-drop-syn-with-data":"0","tcp-drop-syn-in-win":"0","tcp-drop-invalid-dir":"0","tcp-drop-invalid-win-scale-option":"0","frag-fail":"0","tcp-drop-retrans-invalid-flags":"0","tcp-drop-internal-invalid-tcp-state":"0","tcp-drop-rst-in-win":"0","tcp-drop-invalid-seg-pkt-win-overflow":"0","vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-","lastupdated":1643271305369,"tcp-drop-invalid-seq":"0","zone-no-zone-inet-allowed":"0","tcp-drop-invalid-seg-pyld-after-fin-send":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zonepairsessions":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone pair sessions from device","operationId":"getZonePairSessions","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone pair session":{"description":"Zone pair session","value":{"data":[{"src-ip":"10.1.15.15","dst-ip":"10.0.5.19","src-vpn-id":"65534","vdevice-name":"172.16.255.15","src-port":12426,"zp-name":"self_to_inet","dst-vrf":"0","dst-port":12455,"vdevice-host-name":"vm5","total-responder-bytes":"115724","protocol":"PROTO_L4_UDP","vdevice-dataKey":"13","lastupdated":1655955518778,"state":"open","dst-vpn-id":"0","total-initiator-bytes":"103518","classmap-name":"3","session-id":"13","src-vrf":"0"},{"src-ip":"10.0.1.1","dst-ip":"10.0.1.255","src-vpn-id":"0","vdevice-name":"172.16.255.15","src-port":123,"zp-name":"inet_to_self","dst-vrf":"0","dst-port":123,"vdevice-host-name":"vm5","total-responder-bytes":"0","protocol":"PROTO_L7_NTP","vdevice-dataKey":"28","lastupdated":1655955518778,"state":"opening","dst-vpn-id":"65534","total-initiator-bytes":"48","classmap-name":"3","session-id":"28","src-vrf":"0"},{"src-ip":"10.1.15.15","dst-ip":"10.0.12.22","src-vpn-id":"65534","vdevice-name":"172.16.255.15","src-port":12426,"zp-name":"self_to_inet","dst-vrf":"0","dst-port":12446,"vdevice-host-name":"vm5","total-responder-bytes":"918966","protocol":"PROTO_L4_UDP","vdevice-dataKey":"15","lastupdated":1655955518778,"state":"open","dst-vpn-id":"0","total-initiator-bytes":"5037561","classmap-name":"3","session-id":"15","src-vrf":"0"},{"src-ip":"10.1.15.15","dst-ip":"10.0.12.20","src-vpn-id":"65534","vdevice-name":"172.16.255.15","src-port":12426,"zp-name":"self_to_inet","dst-vrf":"0","dst-port":12456,"vdevice-host-name":"vm5","total-responder-bytes":"116455","protocol":"PROTO_L4_UDP","vdevice-dataKey":"14","lastupdated":1655955518778,"state":"open","dst-vpn-id":"0","total-initiator-bytes":"107116","classmap-name":"3","session-id":"14","src-vrf":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zonepairstatistics":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone pair statistics from device","operationId":"getZonePairs","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone pair statistics":{"description":"Zone pair statistics","value":{"data":[{"max-active-conn":"0","class-action":"Inspect Drop","vdevice-name":"172.16.255.15","src-zone-name":"employee","pkts-counter":"0","max-halfopen-conn":"0","vdevice-host-name":"vm5","zonepair-name":"employee-inet","class-name":"cmap_1","attempted-conn":"0","match-type-id":"3","match-type":"access-group name","current-active-conn":"0","current-halfopen-conn":"0","vdevice-dataKey":"172.16.255.15-employee-inet-cmap_1","time-since-last-session-create":"0","current-terminating-conn":"0","policy-name":"fw_policy1","match-name":"acl1_1","lastupdated":1655267493875,"max-terminating-conn":"0","dst-zone-name":"internet","bytes-counter":"0"},{"max-active-conn":"0","class-action":"Inspect Drop","vdevice-name":"172.16.255.15","src-zone-name":"employee","pkts-counter":"0","max-halfopen-conn":"0","vdevice-host-name":"vm5","class-name":"class-default","zonepair-name":"employee-inet","attempted-conn":"0","current-active-conn":"0","current-halfopen-conn":"0","vdevice-dataKey":"172.16.255.15-employee-inet-class-default","time-since-last-session-create":"0","current-terminating-conn":"0","policy-name":"fw_policy1","lastupdated":1655267493875,"max-terminating-conn":"0","dst-zone-name":"internet","bytes-counter":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zonepolicyfilter":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone policy filter from device","operationId":"getZonePolicyFilters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone policy filter":{"description":"Zone policy filter","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","name":"ZONE-POLICY-1","counter-name":"counter_seq_1","packets":"2","bytes":"196","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9-ZONE-POLICY-1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ppp/interface":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PPP interface list from device (Real Time)","operationId":"createPPPInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PPP interface list":{"description":"PPP interface list","value":{"data":[{"vdevice-dataKey":"169.254.10.9-ppp1","vdevice-name":"169.254.10.9","ifname":"ppp1","lastupdated":1654477366044,"pppoe-interface":"ge0/0","vpn-id":"0","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/pppoe/session":{"get":{"tags":["Real-Time Monitoring - PPPoE"],"description":"Get PPPoE session list from device","operationId":"createPPPoEInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PPPoE session list":{"description":"PPPoE session list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"0","ifname":"ge0/1","session-id":"1","server-mac":"00:0c:29:2e:20:1a","local-mac":"00:0c:29:be:27:f5","ppp-interface":"ppp1","ac-name":"branch100","service-name":"-","vdevice-dataKey":"169.254.10.9","lastupdated":1658198416779}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/pppoe/statistic":{"get":{"tags":["Real-Time Monitoring - PPPoE"],"description":"Get PPPoE statistics from device","operationId":"createPPPoENeighborList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PPPoE statistics":{"description":"PPPoE statistics","value":{"data":[{"pppoe-pads-pkts":"0","pppoe-ipcp-pkts":"0","vdevice-name":"169.254.10.10","pppoe-lcp-pkts":"0","pppoe-tx-session-drops":"0","pppoe-pado-pkts":"0","pppoe-padt-pkts":"0","pppoe-padr-pkts":"0","vdevice-host-name":"vm3","pppoe-tx-pkts":"0","pppoe-inv-discovery-pkts":"0","pppoe-rx-session-drops":"0","vdevice-dataKey":"169.254.10.10","pppoe-ccp-pkts":"0","lastupdated":1643355873158,"pppoe-rx-pkts":"0","pppoe-padi-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/queues":{"get":{"tags":["Monitoring - Device Details"],"description":"Get synchronized queue information, returns information about syncing, queued and stuck devices","operationId":"getSyncQueues","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue status":{"description":"Queue status","value":{"syncing":[],"queued":[],"Stuck":{}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/reachable":{"get":{"tags":["Monitoring - Device Details"],"description":"Get list of reachable devices","operationId":"listReachableDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceReachableData"},"examples":{"List of reachable devices":{"description":"List of reachable devices","value":"[\n {\n \"device-model\":\"vsmart\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:17 2021 GMT\",\n \"uuid\":\"bd7440de-aff6-4f9f-a99a-48d5f08b9fa5\",\n \"deviceId\":\"172.16.255.19\",\n \"syncScheduled\":1616436317638,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":0.22,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"ompPeersUp\":3,\n \"syncQueued\":1616436317586,\n \"isDeviceGeoData\":true,\n \"device-type\":\"vsmart\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-122.0\",\n \"syncCompleted\":1616436319560,\n \"domain-id\":\"1\",\n \"policy-template-name\":\"\",\n \"expectedControlConnections\":1,\n \"memUsageDisplay\":\"39.0\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":2,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.19\",\n \"controlConnectionsUp\":5,\n \"controlConnectionsToVsmarts\":\"1\",\n \"number-vbond-peers\":\"1\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"ompPeers\":\"3\",\n \"memState\":\"normal\",\n \"chassis-number\":\"bd7440de-aff6-4f9f-a99a-48d5f08b9fa5\",\n \"board_type\":\"None\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.19\",\n \"timezone\":\"UTC\",\n \"latitude\":\"45.0\",\n \"system-ip\":\"172.16.255.19\",\n \"site-id\":\"100\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:17 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345981\",\n \"@rid\":377,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vsmart\",\n \"memUsage\":39.0,\n \"lastDataSyncTime\":1616436319524,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"controlConnections\":\"5\",\n \"controlConnectionsDown\":0,\n \"availableVersions\":[\n \n ],\n \"policy-template-version\":\"\",\n \"number-vsmart-peers\":1,\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n \n ],\n \"host-name\":\"vm9\",\n \"uptime\":\"27 days 15 hrs 59 min 37 sec\",\n \"token\":\"-NA-\",\n \"cpuLoadDisplay\":\"0.22\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"number-vsmart-control-connections\":1,\n \"vmanage-system-ip\":\"172.16.255.19\",\n \"ompPeersDown\":0,\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616436319460,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045900000\n },\n {\n \"device-model\":\"vsmart\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:18 2021 GMT\",\n \"uuid\":\"0faa6449-8ab8-4e53-a580-893f16f80738\",\n \"deviceId\":\"172.16.255.20\",\n \"syncScheduled\":0,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":0.18,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"ompPeersUp\":3,\n \"syncQueued\":1616395493285,\n \"isDeviceGeoData\":true,\n \"device-type\":\"vsmart\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-90.0\",\n \"syncCompleted\":1616395494540,\n \"domain-id\":\"1\",\n \"policy-template-name\":\"\",\n \"expectedControlConnections\":1,\n \"memUsageDisplay\":\"39.0\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":2,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.20\",\n \"controlConnectionsUp\":5,\n \"controlConnectionsToVsmarts\":\"1\",\n \"number-vbond-peers\":\"1\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"ompPeers\":\"3\",\n \"memState\":\"normal\",\n \"chassis-number\":\"0faa6449-8ab8-4e53-a580-893f16f80738\",\n \"board_type\":\"None\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.20\",\n \"timezone\":\"UTC\",\n \"latitude\":\"45.0\",\n \"system-ip\":\"172.16.255.20\",\n \"site-id\":\"200\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:18 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345975\",\n \"@rid\":393,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vsmart\",\n \"memUsage\":39.0,\n \"lastDataSyncTime\":1616395494518,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"controlConnections\":\"5\",\n \"controlConnectionsDown\":0,\n \"availableVersions\":[\n \n ],\n \"policy-template-version\":\"\",\n \"number-vsmart-peers\":1,\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n \n ],\n \"host-name\":\"vm10\",\n \"uptime\":\"27 days 04 hrs 39 min 57 sec\",\n \"token\":\"-NA-\",\n \"cpuLoadDisplay\":\"0.18\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"number-vsmart-control-connections\":1,\n \"vmanage-system-ip\":\"172.16.255.20\",\n \"ompPeersDown\":0,\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616395494468,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045840000\n }\n{\n \"device-model\":\"vedge-cloud\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:40 2021 GMT\",\n \"fp_cpu_count\":\"1\",\n \"uuid\":\"fd31a48b-2908-4315-a911-a3f2f0a8da24\",\n \"deviceId\":\"172.16.255.26\",\n \"syncScheduled\":1616411710011,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":1.04,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"syncQueued\":1616411703542,\n \"isDeviceGeoData\":false,\n \"device-type\":\"vbond\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-122.777023\",\n \"syncCompleted\":1616411711225,\n \"memUsageDisplay\":\"63.7\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":3,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.26\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"memState\":\"normal\",\n \"chassis-number\":\"fd31a48b-2908-4315-a911-a3f2f0a8da24\",\n \"board_type\":\"Sim\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.26\",\n \"timezone\":\"UTC\",\n \"latitude\":\"37.666684\",\n \"system-ip\":\"172.16.255.26\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:40 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345979\",\n \"@rid\":369,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vbond\",\n \"memUsage\":63.7,\n \"lastDataSyncTime\":1616411711185,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"linux_cpu_count\":\"1\",\n \"availableVersions\":[\n \n ],\n \"vbond-standalone\":\"false\",\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n \n ],\n \"host-name\":\"vm16\",\n \"tcpd_cpu_count\":\"0\",\n \"uptime\":\"27 days 09 hrs 09 min 40 sec\",\n \"cpuLoadDisplay\":\"1.04\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"vmanage-system-ip\":\"172.16.255.26\",\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616411711138,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045900000\n} ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/reboothistory":{"get":{"tags":["Real-Time Monitoring - Reboot History"],"description":"Get device reboot history","operationId":"createRebootHistoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reboot history":{"description":"Device reboot history","value":{"data":[{"reboot_date_time-date":1642651714000,"lastupdated":1642656685355,"vdevice-dataKey":"172.16.255.11-2022-01-20T04:08:34+00:00","reboot_date_time":"2022-01-20T04:08:34+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,dca,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/reboothistory/details":{"get":{"tags":["Real-Time Monitoring - Reboot History"],"description":"Get detailed reboot history list","operationId":"getRebootHistoryDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Detailed device reboot history":{"description":"Detailed device reboot history","value":{"data":[{"reboot_date_time-date":1642651714000,"lastupdated":1642652319187,"reboot_date_time":"2022-01-20T04:08:34+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"},{"reboot_date_time-date":1642656388000,"lastupdated":1642656695661,"reboot_date_time":"2022-01-20T05:26:28+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"},{"reboot_date_time-date":1642657398000,"lastupdated":1642657658587,"reboot_date_time":"2022-01-20T05:43:18+00:00","reboot_reason":"reload","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"reboot_date_time-date":1642658548000,"lastupdated":1642659153477,"reboot_date_time":"2022-01-20T06:02:28+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/reboothistory/synced":{"get":{"tags":["Real-Time Monitoring - Reboot History"],"description":"Get device reboot history synchronously","operationId":"createSyncedRebootHistoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reboot history":{"description":"Device reboot history","value":{"data":[{"reboot_date_time-date":1642658548000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T06:02:28+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T06:02:28+00:00","createTimeStamp":1642659153490,"lastupdated":1642659153477,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1078},{"reboot_date_time-date":1642651714000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T04:08:34+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T04:08:34+00:00","createTimeStamp":1642652319194,"lastupdated":1642652319187,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1086},{"reboot_date_time-date":1642656388000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T05:26:28+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T05:26:28+00:00","createTimeStamp":1642656696210,"lastupdated":1642656695661,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1095},{"reboot_date_time-date":1642659874000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T06:24:34+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T06:24:34+00:00","createTimeStamp":1642660158532,"lastupdated":1642660158402,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1103},{"reboot_date_time-date":1642659181000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T06:13:01+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T06:13:01+00:00","createTimeStamp":1642659460686,"lastupdated":1642659460446,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1104}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/roleBasedCounters":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based Counters information from device","operationId":"getRoleBasedCounters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based counters information":{"description":"TrustSec role based counters information","value":{"data":[{"software-permit-count":"0","software-monitor-count":"0","software-deny-count":"0","vdevice-name":"172.16.255.15","total-permit-count":"0","src-sgt":55,"total-deny-count":"0","vdevice-host-name":"vm5","hardware-deny-count":"0","vdevice-dataKey":"172.16.255.15-vm5-55-66","hardware-permit-count":"0","lastupdated":1654768097970,"dst-sgt":66,"hardware-monitor-count":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/roleBasedIpv6Counters":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based Ipv6 Counters information from device","operationId":"getRoleBasedIpv6Counters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based counters information":{"description":"TrustSec role based counters information","value":{"data":[{"software-permit-count":"0","software-monitor-count":"0","software-deny-count":"0","vdevice-name":"172.16.255.16","total-permit-count":"0","src-sgt":3,"total-deny-count":"0","vdevice-host-name":"vm6","hardware-deny-count":"0","vdevice-dataKey":"172.16.255.16-vm6-3-5","hardware-permit-count":"0","lastupdated":1654823680867,"dst-sgt":5,"hardware-monitor-count":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/roleBasedIpv6Permissions":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based ipv6 Permissions information from device","operationId":"getRoleBasedIpv6Permissions","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based permissions information":{"description":"TrustSec role based permissions information","value":{"data":[{"last-updated-time":"2036-02-07T06:28:16+00:00","num-of-sgacl":1,"vdevice-dataKey":"172.16.255.16-vm6-3-5","vdevice-name":"172.16.255.16","policy-life-time":"0","sgacl-name":"zhanglist2","monitor-mode":"false","src-sgt":3,"lastupdated":1654823603240,"dst-sgt":5,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/roleBasedPermissions":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based Permissions information from device","operationId":"getRoleBasedPermissions","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based permissions information":{"description":"TrustSec role based permissions information","value":{"data":[{"last-updated-time":"2036-02-07T06:28:16+00:00","num-of-sgacl":1,"vdevice-dataKey":"172.16.255.15-vm5-55-66","vdevice-name":"172.16.255.15","policy-life-time":"0","sgacl-name":"acl1","monitor-mode":"false","src-sgt":55,"lastupdated":1654767424577,"dst-sgt":66,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/roleBasedSgtMap":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based SGT Map information from device","operationId":"getRoleBasedSgtMap","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based SGT map information":{"description":"TrustSec role based SGT map information","value":{"data":[{"vdevice-dataKey":"172.16.255.15-vm5-10.0.1.15/32-Default","ip":"10.0.1.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.0.20.15/32-Default","ip":"10.0.20.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.0.100.15/32-Default","ip":"10.0.100.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.1.15.15/32-Default","ip":"10.1.15.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.1.17.15/32-Default","ip":"10.1.17.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/sdwan-global-drop-statistics":{"get":{"tags":["Real-Time Monitoring - SDWAN Statistics"],"description":"Get SD-WAN global drop statistics detail from device (Real Time)","operationId":"getSDWanGlobalDropStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD-WAN global drop statistics":{"description":"SD-WAN global drop statistics","value":{"data":[{"ipv4-acl-lookup-miss-octets":"0","ip-ttl-exceeded-pkts":"0","unconfigured-mpls-fia-pkts":"0","tunnel-pkt-sb-missed-octets":"0","lisp-decap-failed-octets":"0","sdwan-bfd-octets":"0","gre-bad-options-pkts":"0","sdwan-data-policy-octets":"0","inv-common-preamble-pkts":"0","firewall-nonsession-octets":"0","bqs-oor-pkts":"0","unconfigured-ipv4-fia-pkts":"0","perf-lic-policer-lo-octets":"0","reass-frag-too-big-octets":"0","unsupport-linktype-no-route-pkts":"0","lisp-failed-to-punt-dynmaic-eid-config-pkts":"0","ipv4-no-adj-pkts":"323","sdwan-octets":"0","ipv6-acl-octets":"0","ipv4-acl-pkts":"0","firewall-backpressure-octets":"0","ipsec-input-octets":"6185","ipv6-adj-drop-pkts":"0","lookup-oce-unsupport-linktype-octets":"0","ipv6-no-adj-pkts":"6","reass-bad-len-octets":"0","ipv4-null0-pkts":"0","tcp-badfrag-pkts":"0","ip-bad-options-pkts":"0","reass-bad-len-pkts":"0","reass-no-frags-left-pkts":"0","reass-timeout-pkts":"0","ipv4-no-route-octets":"63122","oce-drop-adj-octets":"0","sdwan-generic-pkts":"0","no-gpm-memory-err-octets":"0","lisp-decap-failed-pkts":"0","frfab-wred-drop-octets":"0","ipsec-ted-indicate-octets":"0","lisp-sfltr-pkts":"0","tunnel-sec-chk-fail-octets":"0","pa-walk-err-pkts":"0","loadbalance-null0-pkts":"0","hqf-tx-error-octets":"0","ipv4mc-extra-replicae-octets":"0","ipv4-martian-pkts":"0","tcp-octets":"0","ipv4-pbr-pkts":"0","ipsec-invalid-sa-octets":"0","no-mem-octets":"0","ipv4-adj-drop-octets":"0","glean-adj-unsupport-linktype-octets":"0","vdevice-name":"169.254.10.12","ipv4-martian-octets":"0","identity-cft-error-pkts":"0","reass-frag-too-big-pkts":"0","lisp-disabled-octets":"0","udp-octets":"0","multilink-cfg-pkts":"0","pa-walk-err-octets":"0","bad-adj-octets":"0","unconfigured-ipv6-fia-pkts":"51334","flow-queue-failure-id-octets":"0","multilink-cfg-octets":"0","gpm-tx-len-exceed-pkts":"0","tunnel-decap-too-many-times-pkts":"0","inv-hdr-err-pkts":"0","attn-invalid-spid-octets":"0","tail-drop-octets":"0","tunnel-bad-gre-checksum-octets":"0","ipv4mc-ttl-threshold-chk-failed-pkts":"0","mpass-err-octets":"0","nat-out2in-octets":"0","ip-format-err-octets":"0","firewall-backpressure-pkts":"0","illegal-obj-pkts":"0","reass-overlap-octets":"0","bad-len-octets":"0","tunnel-misconfiguration-pkts":"0","reass-too-many-frags-octets":"0","punt-global-policer-drop-octets":"0","reass-too-many-frags-pkts":"0","frr-oce-invalid-state-octets":"0","invalid-queue-pkts":"0","ipv4mc-extra-replicae-pkts":"0","mpls-adj-drop-octets":"0","bad-uidb-idx-octets":"0","mpass-err-pkts":"0","ipv6-truncatedpkts-octets":"0","lastupdated":1645693979596,"ip-format-err-pkts":"0","ipsec-deny-drop-pkts":"0","invalid-encap-octets":"0","lookup-oce-should-drop-octets":"0","lisp-hash-lkup-failed-octets":"0","unresolved-octets":"0","ipv4-no-route-pkts":"398","lisp-failed-to-punt-gsmr-enabled-pkts":"0","ipv6-null0-pkts":"0","sdwan-bfd-pkts":"0","ipv4mc-invalid-replica-record-pkts":"0","unconfigured-fia-octets":"0","ext-drop-path-octets":"0","qos-actions-pkts":"0","mpass-invalid-fs-vector-pkts":"0","oce-drop-adj-pkts":"0","max-tu-octets":"0","invalid-encap-pkts":"0","mpls-pkts":"0","punt-err-pkts":"0","hqf-tx-error-pkts":"0","reass-drop-octets":"0","tail-drop-pkts":"0","ip-frag-err-octets":"0","punt-policer-drop-pkts":"0","mlp-pkts":"0","max-tu-pkts":"0","lisp-hash-lkup-failed-pkts":"0","inv-l2-hdr-pkts":"0","ipv4-unclassified-octets":"0","lisp-failed-to-punt-lsb-mismatch-pkts":"0","nat64-v6tov4-octets":"480","lisp-failed-to-punt-gsmr-enabled-octets":"0","sdwan-data-policy-pkts":"0","bqs-oor-octets":"0","ipv4-routing-err-pkts":"0","disabled-pkts":"2590","cts-format-octets":"0","bad-len-pkts":"0","ipv6-routing-err-octets":"0","illegal-obj-octets":"0","ipv6-unclassified-octets":"0","bad-uidb-idx-pkts":0,"bad-uidb-sub-idx-pkts":"0","for-us-pkts":"0","icmp-pkts":"0","invalid-wred-pkts":"0","lisp-elig-oce-octets":"0","bfd-octets":"0","sdwan-tloc-ext-pkts":"0","ipv4-acl-lookup-miss-pkts":"0","reass-no-frag-info-octets":"0","mpls-adj-drop-pkts":"0","sdwan-generic-octets":"0","reass-drop-pkts":"0","inv-common-preamble-octets":"0","bad-ip-checksum-octets":"0","ipv6-acl-lookup-miss-pkts":"0","reass-no-frag-info-low-pkts":"0","frr-oce-no-backup-pkts":"0","ipv6-unclassified-pkts":"0","mpls-mismatch-linktype-pkts":"0","wred-pkts":"0","ipv6-badsource-pkts":"0","lisp-disabled-pkts":"0","choice-oce-octets":"0","ipv6-acl-lookup-miss-octets":"0","bad-adj-pkts":"0","min-tu-octets":"0","nat-out2in-pkts":"0","unsupport-linktype-null0-octets":"0","firewall-invalid-zone-pkts":"0","lisp-failed-to-punt-dynmaic-eid-config-octets":"0","attn-invalid-spid-pkts":"0","not-enabled-octets":"0","fia-error-pkts":"0","bad-ip-checksum-pkts":"0","ipsec-ike-indicate-octets":"0","sdwan-app-route-policy-pkts":"0","ipv6-toobigpacket-octets":"0","ipv6-formaterr-octets":"0","ipv4mc-no-route-pkts":"0","mpls-frag-req-octets":"0","vdevice-dataKey":"169.254.10.12-","lookup-oce-should-drop-pkts":"0","cts-not-enable-octets":"0","loadbalance-null0-octets":"0","frr-oce-invalid-state-pkts":"0","tcp-pkts":"0","ipv6-acl-pkts":"0","nat-in2out-pkts":"0","ipv6-badhop-pkts":"0","ipv6-badsource-octets":"0","inv-hdr-err-octets":"0","tcp-badfrag-octets":"0","ipv4-mtr-octets":"0","ipsec-ted-indicate-pkts":"0","ipsec-output-octets":"0","nat66-out2in-octets":"0","lisp-misconfiguration-octets":"0","ipsec-output-pkts":"0","cts-not-enable-pkts":"0","mlp-octets":"0","qos-actions-octets":"0","iphc-octets":"0","disabled-octets":"403111","unknown-ext-header-pkts":"0","mpls-mismatch-linktype-octets":"0","ipv6-no-adj-octets":"456","fia-error-octets":"0","gre-bad-options-octets":"0","reass-overlap-pkts":"0","vfr-tail-drop-octets":"0","sdwan-acl-octets":"0","ipv4-null0-octets":"0","unresolved-pkts":"0","invalid-queue-octets":"0","sdwan-implicit-acl-octets":"55011","ipv4-routing-err-octets":"0","inject-err-pkts":"0","punt-policer-drop-octets":"0","reass-no-frag-info-low-octets":"0","min-tu-pkts":"0","ipsec-input-pkts":"17","perf-lic-policer-hi-octets":"0","mac-acl-lookup-miss-octets":"0","ipv6-no-route-pkts":"3","cts-format-pkts":"0","ipsec-deny-drop-octets":"0","ip-bad-options-octets":"0","frag-tail-drop-octets":"0","frr-oce-no-backup-octets":"0","internal-ctl-pkts":"0","flow-queue-failure-id-pkts":"0","unconfigured-mpls-fia-octets":"0","ip-ttl-exceeded-octets":"0","unsupported-oce-pkts":"0","sdwan-acl-pkts":"0","no-gpm-memory-err-pkts":"0","perf-lic-policer-hi-pkts":"0","nat64-v6tov4-pkts":"6","unsupport-linktype-null0-pkts":"0","ipv4mc-ttl-threshold-chk-failed-octets":"0","glean-adj-unsupport-linktype-pkts":"0","firewall-l4-insp-pkts":"0","mpass-invalid-fs-vector-octets":"0","inv-l2-hdr-octets":"0","mpls-frag-req-pkts":"0","internal-ctl-octets":"0","identity-cft-error-octets":"0","sdwan-pkts":"0","reass-no-frag-info-pkts":"0","mpls-octets":"0","sdwan-interface-policy-octets":"0","frag-tail-drop-pkts":"0","ip-acl-err-octets":"0","discard-pkts":"0","sdwan-tunnel-lkup-pkts":"0","not-enabled-pkts":"0","choice-oce-pkts":"0","lookup-oce-unsupport-linktype-pkts":"0","sdwan-app-route-policy-octets":"0","lisp-misconfiguration-pkts":"0","bad-uidb-sub-idx-octets":"0","reass-timeout-octets":"0","tunnel-decap-too-many-times-octets":"0","vdevice-host-name":"vm5","icmp-octets":"0","ipv4-adj-drop-pkts":"0","tunnel-invalid-protocol-pkts":"0","wred-octets":"0","lisp-sfltr-octets":"0","ipv6-no-route-octets":"168","unconfigured-ipv6-fia-octets":"5564369","for-us-octets":"0","vfr-tail-drop-pkts":"0","frfab-wred-drop-pkts":"0","ipsec-invalid-sa-pkts":"0","ipv6-null0-octets":"0","ipv4-acl-octets":"0","firewall-nonsession-pkts":"0","ipsec-tail-drop-pkts":"0","tunnel-misconfiguration-octets":"0","bfd-pkts":"0","ipv4mc-invalid-replica-record-octets":"0","ip-acl-err-pkts":"0","ipsec-ike-indicate-pkts":"0","idle-packet-octets":"0","unconfigured-ipv4-fia-octets":"0","ipv6-toobigpacket-pkts":"0","idle-packet-pkts":"0","ipv4mc-rpf-failed-pkts":"0","ip-frag-err-pkts":"0","sdwan-interface-policy-pkts":"0","vfr-err-pkts":"0","unknown-encap-octets":"0","ipv4mc-no-route-octets":"0","unsupported-oce-octets":"0","unconfigured-fia-pkts":"0","sdwan-tloc-ext-octets":"0","qos-policing-octets":"0","sdwan-implicit-acl-pkts":"607","internal-intf-err-pkts":"0","firewall-l4-insp-octets":"0","mac-acl-octets":"0","no-mem-pkts":"0","ipv4-mtr-pkts":"0","internal-intf-err-octets":"0","invalid-wred-octets":"0","ipsec-tail-drop-octets":"0","lisp-elig-oce-pkts":"0","layer2-no-route-pkts":"0","ipv6-routing-err-pkts":"0","ext-drop-path-pkts":"0","unsupport-linktype-no-route-octets":"0","mac-acl-lookup-miss-pkts":"0","ipv4-fpm-pkts":"0","nat-in2out-octets":"0","ipv6-adj-drop-octets":"0","ipv4-no-adj-octets":"20728","ipv4-fpm-octets":"0","punt-global-policer-drop-pkts":"0","ipv4-pbr-octets":"0","nat66-in2out-octets":"0","nat66-out2in-pkts":"0","nat66-in2out-pkts":"0","ipv6-formaterr-pkts":"0","vfr-err-octets":"0","mac-acl-pkts":"0","ipv6-truncatedpkts-pkts":"0","tunnel-pkt-sb-missed-pkts":"0","qos-policing-pkts":"0","gpm-tx-len-exceed-octets":"0","layer2-no-route-octets":"0","perf-lic-policer-lo-pkts":"0","null-jib-hdr-tbl-pkts":"0","ipv6-badhop-octets":"0","udp-pkts":"0","unknown-encap-pkts":"0","ipv4-unclassified-pkts":"0","tunnel-bad-gre-checksum-pkts":"0","tunnel-invalid-protocol-octets":"0","reass-no-frags-left-octets":"0","tunnel-sec-chk-fail-pkts":"0","ipv4mc-rpf-failed-octets":"0","lisp-failed-to-punt-lsb-mismatch-octets":"0","inject-err-octets":"0","iphc-pkts":"0","discard-octets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/sdwan-stats":{"get":{"tags":["Real-Time Monitoring - SDWAN Statistics"],"description":"Get SD-WAN statistics detail from device (Real Time)","operationId":"getSDWanStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD-WAN statistics":{"description":"SD-WAN statistics","value":{"data":[{"ipv4-acl-out-drop-action-drop":"0","ipv4-acl-in-drop-action-drop":"0","ipv6-acl-in-drop-action-drop":"0","ipv4-acl-in-prior-implicit-acl-disallow-drop":"607","vdevice-name":"169.254.10.12","app-route-sla-strict-drop":"0","data-policy-in-drop-action-drop":"0","ipv6-acl-in-prior-implicit-acl-disallow-drop":"0","data-policy-out-drop-action-drop":"0","vdevice-host-name":"vm5","ipv4-acl-in-implicit-acl-allow-service-accept":"9484","ipv4-acl-out-police-exceed-drop":"0","ipv6-acl-out-police-exceed-drop":"0","ipv4-acl-in-police-exceed-drop":"0","ipv6-acl-in-police-exceed-drop":"0","vdevice-dataKey":"169.254.10.12-","ipv6-acl-out-drop-action-drop":"0","ipv6-acl-in-implicit-acl-allow-service-accept":"0","lastupdated":1645691843259,"data-policy-in-set-remote-tloc-fail-drop":"0","app-route-matched-none-drop":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/security/information":{"get":{"tags":["Real-Time Monitoring - Security"],"description":"Get security information from devices","operationId":"createSessionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Security information":{"description":"Security information","value":{"data":[{"authentication-type":"deprecated","replay-window":"512","rekey":"86400","lastupdated":1642754840126,"vdevice-dataKey":"169.254.10.12","vdevice-host-name":"vm5","fips-mode":"Disabled","vdevice-name":"169.254.10.12"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/sfp/detail":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP detail","operationId":"getDetail","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ge0/0","vdevice-name":"169.254.10.10","ifname":"ge0/0","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/1","vdevice-name":"169.254.10.10","ifname":"ge0/1","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/2","vdevice-name":"169.254.10.10","ifname":"ge0/2","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/3","vdevice-name":"169.254.10.10","ifname":"ge0/3","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/4","vdevice-name":"169.254.10.10","ifname":"ge0/4","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/5","vdevice-name":"169.254.10.10","ifname":"ge0/5","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/6","vdevice-name":"169.254.10.10","ifname":"ge0/6","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/7","vdevice-name":"169.254.10.10","ifname":"ge0/7","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sfp/diagnostic":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP diagnostic","operationId":"getDiagnostic","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ge0/0","vdevice-name":"169.254.10.10","ifname":"ge0/0","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/1","vdevice-name":"169.254.10.10","ifname":"ge0/1","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/2","vdevice-name":"169.254.10.10","ifname":"ge0/2","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/3","vdevice-name":"169.254.10.10","ifname":"ge0/3","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/4","vdevice-name":"169.254.10.10","ifname":"ge0/4","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/5","vdevice-name":"169.254.10.10","ifname":"ge0/5","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/6","vdevice-name":"169.254.10.10","ifname":"ge0/6","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/7","vdevice-name":"169.254.10.10","ifname":"ge0/7","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sfp/diagnosticMeasurementAlarm":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP diagnostic measurement alarm","operationId":"getDiagnosticMeasurementAlarm","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-name":"169.254.10.10","vdevice-host-name":"vm1","ifname":"ge0/3","measurement":"Rx power","low-alarm-alarm":"Y","low-warning-alarm":"Y","high-warning-alarm":"N","high-alarm-alarm":"N","lastupdated":1661322671947,"vdevice-dataKey":"169.254.10.10-ge0/3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sfp/diagnosticMeasurementValue":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP diagnostic measurement value","operationId":"getDiagnosticMeasurementValue","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-name":"169.254.10.10","vdevice-host-name":"vm1","ifname":"ge0/3","measurement":"Rx power","unit-value":"mW","low-alarm-value":"0.010","low-warning-value":"0.016","high-warning-value":"1.585","high-alarm-value":"1.778","current-value":"0.000","lastupdated":1661324101365,"vdevice-dataKey":"169.254.10.10-ge0/3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sig/getSigTunnelList":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"get Sig TunnelList","operationId":"getSigTunnelList","parameters":[{"name":"pageSize","in":"query","description":"Page Size","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Page offset","schema":{"type":"string"}},{"name":"lastNHours","in":"query","description":"last n hours","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/getSigTunnelTotal":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"get Sig Tunnel Total coount","operationId":"getSigTunnelTotal","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":{"count":"0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/tunnelDashboard":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"Get SIG Zscaler tunnels from device","operationId":"tunnelDashboard","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/umbrella/tunnels":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"Get SIG Umbrella tunnels from device","operationId":"getSigUmbrellaTunnels","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Umbrella tunnels":{"description":"Sig Umbrella tunnels","value":[{"lastupdated":1649242617635,"tunnel-if-name":"Tunnel100512","tunnel-id":"94075","tunnel-name":"128.107.85.118","tunnel-state":"active","fsm-state":"fsm-state","http-resp-code":"200","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","last-http-req":"activate-req","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/zscaler/tunnels":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"Get SIG Zscaler tunnels from device","operationId":"getSigZscalerTunnels","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":[{"tunnel-if-name":"Tunnel100512","tunnel-fsm-state":"gre-add-tunnel","vdevice-name":"172.16.255.15","fqdn":"n/a","vdevice-host-name":"vm5","tunnel-id":"94075","last-http-req":"activate-req","vdevice-dataKey":"172.16.255.15","http-resp-code":"200","tunnel-name":"128.107.85.118","location-id":"43551040","lastupdated":1649242617635,"location-fsm-state":"location-init-state"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/smu":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device","operationId":"createSmuList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","smu-compatible-with":"16.6.1.0","package-state":"Not Installed","defect":"CSCxxXXXXX","smu-type":"reload","lastupdated":1661330128299,"vdevice-dataKey":"172.16.254.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/smu/synced":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device synchronously","operationId":"createSyncedSmuList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","smu-compatible-with":"16.6.1.0","package-state":"Not Installed","defect":"CSCxxXXXXX","smu-type":"reload","lastupdated":1661330128299,"vdevice-dataKey":"172.16.254.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/software":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device","operationId":"getAAAUcreateSoftwareListsers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"default":"true","vdevice-dataKey":"169.254.10.10-20.6.2-432","software":true,"vdevice-name":"169.254.10.10","active":"true","lastupdated":1643356263821,"version":"20.6.2-432","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/software/synced":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device synchronously","operationId":"createSyncedSoftwareList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-name":"172.16.255.11","software":true,"createTimeStamp":1647315989838,"active":"true","version":"20.9.999-1787","vdevice-host-name":"vm1","default":"true","vdevice-dataKey":"172.16.255.11-20.9.999-1787","@rid":1084,"vmanage-system-ip":"172.16.255.11","lastupdated":1647315989833}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/sslproxy/statistics":{"get":{"tags":["Real-Time Monitoring - Sslproxy"],"description":"Get ssl proxy statistics from device","operationId":"getSslProxyStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Ssl proxy statistics":{"description":"Ssl proxy statistics","value":{"data":[{"exception":"0","app-ocsp-req-int-error":"0","decrypt-fail-mode":"0","ps-pkt-rec-from-client":"0","tot-client-cert-val-req":"0","c2s-fin-rec-from-sc":"0","tot-req-tls1-1-flows":"0","ocsp-stap-unknown-resp":"0","tot-failed-renego":"0","s2c-fin-rec":"0","pc-pkt-rec-from-server":"0","s2c-cn-rec":"0","c2s-fin-rec":"0","tot-client-cert-untrusted":"0","c2s-cn-rec-from-sc":"0","s2c-cn-rec-from-sc":"0","tot-ssl-renego":"0","s2c-fin-rec-from-sc":"0","drop-mempool-get-fail":"0","drop-load-key-packet-fail":"0","nodecrypt-unsup-cipher":"0","max-conc-non-proxied-conn":"0","pc-clr-pkt-rec-from-sc":"0","c2s-rst-generated":"0","pc-pkt-sent-to-server":"0","che-bypass":"0","s2c-rst-rec":"0","c2s-rst-rec":"0","che-pushdown":"0","client-ocsp-res":"0","ocsp-stap-reqs":"0","tot-server-cert-untrusted":"0","alert-genrtd-c2s":"0","vdevice-name":"169.254.10.12","alert-genrtd-s2c":"0","pc-rst-rec-from-sc":"0","c2s-cn-sent-to-sc":"0","lwssl-send-msg-toism-fail":"0","c2s-rst-rec-from-sc":"0","c2s-fin-sent":"0","ps-clr-pkt-to-client":"0","s2c-rst-rec-from-sc":"0","client-ocsp-reqs":"0","tot-ssl-resump-ses-tkt":"0","s2c-rst-sent":"0","drop-null-ch-buf":"0","non-proxied-conn":"0","hs-unsupported":"0","app-ocsp-good":"0","s2c-fin-rec-during-hs":"0","drop-inv-evt-in-fsm-state":"0","drop-unable-to-get-pr-cert":"0","lastupdated":1645776582193,"ism-sem-post-failed":"0","s2c-fin-rec-after-hs":"0","app-ocsp-res":"0","c2s-rst-sent-to-sc":"0","s2c-rst-sent-to-sc":"0","app-ocsp-unknown":"0","c2s-cn-rec":"0","ism-flow-create-fail":"0","c2s-cn-sent":"0","s2c-cn-sent":"0","ps-clr-pkt-rec-from-sc":"0","tot-client-cert-val-succes":"0","pc-pkt-rec-from-sc":"0","rm-session-alloc-success":"0","unsup-ssl-version":"0","ps-pkt-sent-to-sc":"0","alert-recvd-c2s":"0","alert-recvd-s2c":"0","endpoint-alert":"0","mem-alloc-fail":"0","ocsp-stap-valid-resp":"0","client-ocsp-revoked":"0","min-tls-version":"0","ssl-parse-failure":"0","s2c-fin-rec-non-ssl":"0","ism-flow-create":"0","rm-session-alloc-failures":"0","ps-lwssl-flow-delete":"0","drop-ssl-parse-abort":"0","drop-unsup-prot-vers":"0","tot-select-tls1-1-flows":"0","client-ocsp-failures":"0","pc-clr-pkt-rec-from-server":"0","pc-clr-pkt-sent-to-sc":"0","c2s-pkt-drop-deny-verdict":"0","decrypt-untrusted-cert":"0","peer-pd":"0","tot-server-cert-expired":"0","vdevice-dataKey":"169.254.10.12","pc-fin-rec-from-sc":"0","drop-untrusted-cert":"0","ocsp-stap-resp":"0","tcp-close-before-hs":"0","nodecrypt-unsup-prot-vers":"0","c2s-fin-rec-non-ssl":"0","tot-select-tls1-0-flows":"0","s2c-pkt-drop-deny-verdict":"0","c2s-fin-sent-to-sc":"0","s2c-fin-sent-to-sc":"0","client-ocsp-req-int-error":"0","client-ocsp-unknown":"0","app-ocsp-timeout":"0","tot-full-ssl-hs":"0","rm-session-free-success":"0","tot-req-sslv2-flows":"0","ps-cn-sent":"0","tot-ssl-hs-completed":"0","ps-clr-pkt-sent-to-sc":"0","ism-flow-delete":"0","tot-client-cert-expired":"0","drop-unknown-status":"0","clear-conn":"0","active-non-proxied-conn":"0","pc-lwssl-flow-create":"0","che-process":"0","client-ocsp-good":"0","tot-select-tls1-2-flows":"0","tot-ssl-hs-started":"0","drop-mem-access-issue":"0","app-ocsp-failures":"0","unknown-reasons":"0","tot-ssl-resump-ses-id":"0","app-ocsp-reqs":"0","tot-conn":"0","drop-null-ssl-rec":"0","drop-ocsp-cert-verify-fail":"0","drop-de-handle-data-fail":"0","ism-fifo-enqueue-failed":"0","unsup-cipher":"0","drop-fail-mode":"0","drop-invalid-fsm-evt":"0","drop-invalid-fs-type":"0","pc-fs-mem-alloc-fail":"0","error-state":"0","tot-server-cert-val-req":"0","vdevice-host-name":"vm5","s2c-cn-sent-to-sc":"0","drop-invalid-ssl-rec":"0","ps-clr-pkt-rec-from-client":"0","pc-lwssl-flow-delete":"0","tot-server-cert-val-succes":"0","c2s-fin-rec-during-hs":"0","drop-ism-flow-create-fail":"0","pc-cn-sent":"0","ps-lwssl-flow-create":"0","c2s-fin-rec-after-hs":"0","drop-expired-cert":"0","drop-key-pkt-snd-fail":"0","proxied-conn":"0","drop-other-side-key-pend":"0","active-proxied-conn":"0","max-conc-proxied-conn":"0","mem-access-issue":"0","unexpected-packet":"0","tot-ssl-resump":"0","ssl-error":"0","decrypt-exp-cert":"0","ps-pkt-sent-to-client":"0","rm-session-free-failures":"0","pc-clr-pkt-to-server":"0","drop-send-ism-hs-msg-fail":"0","ocsp-stap-revoked-resp":"0","client-ocsp-timeout":"0","ps-fin-rec-from-sc":"0","tot-req-sslv3-flows":"0","drop-invalid-msg-type":"0","che-strip":"0","active-clear-conn":"0","non-ssl-traffic":"0","drop-hs-unsupported":"0","max-conc-clear-conn":"0","ps-fs-mem-alloc-fail":"0","tot-req-tls1-0-flows":"0","pc-pkt-sent-to-sc":"0","s2c-rst-generated":"0","drop-unsup-cipher":"0","ocsp-stap-resp-val-fail":"0","tot-req-tls1-3-flows":"0","decrypt-unknown-status":"0","app-ocsp-revoked":"0","s2c-fin-sent":"0","tot-ssl-fb-full-hs":"0","drop-exp-cert":"0","drop-tcp-close-before-hs":"0","ps-pkt-rec-from-sc":"0","ism-msg-mem-alloc-failed":"0","tot-req-tls1-2-flows":"0","drop-endpoint-alert":"0","drop-mem-alloc-fail":"0","tot-closed-conn":"0","c2s-rst-sent":"0","drop-nop-read-fn":"0","ps-rst-rec-from-sc":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/sslproxy/status":{"get":{"tags":["Real-Time Monitoring - Sslproxy"],"description":"Get ssl proxy status from device","operationId":"getSslProxyStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Ssl proxy status":{"description":"Ssl proxy status","value":{"data":[{"failure-mode":"failure-mode-action-close","minimum-tls-version":"tls-ver-1","vdevice-name":"169.254.10.12","cert-lifetime-in-days":"730","unsup-cipher-suite":"unsup-mode-action-drop","expired-cert":"cert-valid-action-decrypt","untrusted-cert":"cert-valid-action-decrypt","ca-tp-label":"PROXY-SIGNING-CA","unknown-status":"cert-valid-action-drop","rsa-key-mod":"2048","clear-mode":"false","vdevice-host-name":"vm5","ec-key-type":"ec-key-p256","cert-revocation":"cert-rev-none","vdevice-dataKey":"169.254.10.12","ca-cert-bundle":"/bootflash/vmanage-admin/sslProxyDefaultCAbundle.pem","lastupdated":1645776060286,"unsup-protocol-version":"unsup-mode-action-drop"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/staticRouteTracker":{"get":{"tags":["Real-Time Monitoring - Static Route Tracker Service"],"description":"Get single static route tracker info from device","operationId":"getStaticRouteTrackerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Static route tracker info":{"description":"Static route tracker info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/stats":{"get":{"tags":["Monitoring - Device Details"],"description":"Get stats queue information","operationId":"getStatsQueues","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue status":{"description":"Queue status","value":{"ProcessQueue-0":{"syncing":[],"queued":[],"stuck":{}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/status":{"get":{"tags":["Monitoring - Device Details"],"description":"Get devices status for vSmart,vBond,vEdge, and cEdge","operationId":"getAllDeviceStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device status list":{"description":"Device status list","value":{"header":{"generatedOn":1635236849570},"data":[{"type":"vSmart","name":"vSmart","image":"images/vsmart.png","count":3,"detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart","statusList":[{"status":"error","name":"Error","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=error","color":"fa7c7d","icon":"images/device/device-error.png","count":0},{"status":"warning","name":"Warning","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=warning","color":"f2ce60","icon":"images/device/device-warning.png","count":0},{"status":"normal","name":"Normal","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=normal","color":"b0e276","icon":"images/device/device-normal.png","count":3},{"status":"new","name":"Discovered device","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=new","color":"7c8afa","icon":"images/device/device-new.png","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/sxpConnections":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec SXP Connections information from device","operationId":"getSxpConnections","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec SXP Connections information":{"description":"TrustSec SXP Connections information","value":{"data":[{"listener-duration":"23","vdevice-dataKey":"172.16.255.15-vm5-10.1.16.116-Default","vdevice-name":"172.16.255.15","source-ip":"10.1.15.15","listener-state":"state-off","peer-ip":"10.1.16.116","vrf-name":"Default","lastupdated":1652319406421,"speaker-state":"state-off","vdevice-host-name":"vm5","local-mode":"con-mode-both","speaker-duration":"35008"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/sync_status":{"get":{"tags":["Monitoring - Device Details"],"description":"Get list of currently syncing devices","operationId":"listCurrentlySyncingDevices","parameters":[{"name":"groupId","in":"query","description":"Group Id","required":true,"schema":{"type":"string","default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"List of currently syncing devices":{"description":"List of currently syncing devices","value":{"header":{"generatedOn":1635237704919},"data":[{"name":"vedge-C8500-12X4QC","templateClass":"cedge","displayName":"C8500-12X4QC","deviceType":"vedge","isCliSupported":true,"templateSupported":true,"deviceClass":"cisco-router","cpuCountAttribute":{"enable":true,"attributeField":"total_cpu_count"},"interfaces":{"wan":["GigabitEthernet","TenGigabitEthernet","Loopback"],"lan":["GigabitEthernet","TenGigabitEthernet","Loopback"],"mgmt":["GigabitEthernet","TenGigabitEthernet","Loopback"],"day0":["GigabitEthernet0/0/0"]},"onboardCert":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/syncall/memorydb":{"post":{"tags":["Monitoring - Device Details"],"description":"Synchronize memory database for all devices","operationId":"syncAllDevicesMemDB","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/system/clock":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system clock","operationId":"getDeviceSystemClock","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system clock":{"description":"Device system clock","value":{"data":[{"current_date/date-time-string":"Tue Mar 15 16:46:40 UTC 2022"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/system/info":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device information list","operationId":"createDeviceInfoList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"array","example":"169.254.10.10","items":{"type":"string","example":"169.254.10.10"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device info":{"description":"Device info","value":{"data":[{"device-model":"vedge-cloud","statusOrder":4,"total_cpu_count":"2","max-controllers":"0","groupId":["none"],"certificate-not-valid-before":"Jan 29 00:19:35 2022 GMT","fp_cpu_count":"1","deviceId":"169.254.10.10","uuid":"bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e","syncScheduled":1644759037120,"chassis-serial-number":"None","cpuLoad":1.46,"state_description":"All daemons up","vsmart-list-version":"9223372036854775807","vbond":"10.103.135.135","ompPeersUp":2,"syncQueued":1644759037119,"isDeviceGeoData":false,"device-type":"vedge","state":"green","firmwareVersion":"---","organization-name":"vIPtela Inc Regression-Apple Inc","longitude":"-122.777023","syncCompleted":1644759039647,"domain-id":"1","downloadedServices":[],"availableServices":[],"expectedControlConnections":2,"memUsageDisplay":"24.1","model_sku":"None","sp-organization-name":"vIPtela Inc Regression","version":"20.6.2-440","firmwareAvailablePackages":"[]","layoutLevel":4,"bootloader_version":"Not applicable","fips_mode":"enabled","name":"169.254.10.10","controlConnectionsUp":3,"controlConnectionsToVsmarts":"2","number-vbond-peers":"1","defaultVersion":"20.6.2-440","status":"normal","ompPeers":"2","memState":"normal","chassis-number":"bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e","board_type":"Sim","device-os":"next","local-system-ip":"172.16.254.2","timezone":"UTC","latitude":"37.666684","system-ip":"169.254.10.10","site-id":"3","certificate-not-valid-after":"Jan 29 00:19:35 2023 GMT","downloadedImages":[],"platform":"x86_64","hardwareState":"normal","board-serial":"12345708","@rid":2493,"personality":"vedge","memUsage":24.1,"lastDataSyncTime":1644801887955,"certificate-status":"Installed","reachability":"reachable","controlConnections":"3","linux_cpu_count":"1","controlConnectionsDown":0,"availableVersions":[],"number-vsmart-peers":2,"connectedVManages":["169.254.10.3"],"testbed_mode":true,"syncState":"Completed","firmwareAvailableVersions":[],"host-name":"vm3","bfdSessionsDown":0,"tcpd_cpu_count":"0","uptime":"15 days 13 hrs 52 min 15 sec","token":"Invalid","cpuLoadDisplay":"1.46","certificate-validity":"Valid","cpuState":"normal","number-vsmart-control-connections":2,"vmanage-system-ip":"169.254.10.10","ompPeersDown":0,"bfdSessions":"5","tenantId":"c2c6093d-a33c-400a-90e8-1f549fe7a12c","vmanageConnectionState":"connected","build_number":"440\n","lastupdated":1644759039485,"device-category":"vedge","device-groups":["No groups"],"hasGeoData":true,"uptime-date":1643413080000,"isMultiStepUpgradeSupported":false,"bfdSessionsUp":5}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/system/statistics":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system stats list (Real Time)","operationId":"createDeviceSystemStatsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"tx_gre_pkts":132344,"tx_arp_replies":1700,"rx_icmp_port_unreach":303,"rx_window_drops_tc6":0,"rx_window_drops_tc7":0,"tx_arp_reqs":43535,"rx_window_drops_tc4":0,"rx_window_drops_tc5":0,"pko_wred_drops":0,"rx_window_drops_tc2":0,"rx_window_drops_tc3":0,"rx_window_drops_tc0":0,"rx_window_drops_tc1":0,"bfd_rx_non_ip":0,"ip_fwd_mcast_invalid_iif":0,"route_to_host":0,"tx_pkts":55508251,"arp_add_fail":51,"tx_ipsec_policer_drops":0,"tx_fragment_drops":0,"ip_fwd_from_cpu_non_local":0,"ip_fwd_null_mcast_group":0,"buf_alloc_fails":0,"fragment_df_drops":0,"rx_drops":0,"tx_fragment_fail":0,"bfd_lkup_fail":0,"rx_icmp_network_unreach":9,"vdevice-name":"169.254.10.10","tx_icmp_fragment_required":0,"cflowd_pkts":0,"tx_fragment_alloc_fail":0,"rx_replay_integrity_drops_tc3":0,"rx_replay_integrity_drops_tc4":0,"rx_replay_integrity_drops_tc5":0,"rx_sa_ipsec_drops":0,"rx_replay_integrity_drops_tc6":0,"openssl_aes_encrypt":0,"rx_replay_integrity_drops_tc7":0,"to_cpu_policer_drops":3173,"rx_icmp_redirect":0,"tx_no_tunn_pre_ipsec_drops":0,"tx_icmp_src_quench":0,"rx_icmp_ttl_expired":0,"rx_replay_integrity_drops_tc0":1,"rx_replay_integrity_drops_tc1":0,"rx_arp_reqs":1333,"rx_replay_integrity_drops_tc2":0,"tx_icmp_ttl_expired":0,"ip_fwd_mirror_pkts":0,"rx_non_ip_drops":1469202,"rx_icmp_bad_ip_hdr":0,"tx_ip6_ipsec_drops":0,"nat_xlate_outbound_drops":0,"rx_err_pad_ipsec_drops":0,"rx_pre_ipsec_pkts":0,"lastupdated":1644814365917,"tx_icmp_policer_drops":0,"mirror_drops":0,"rx_ipsec_bad_inner":0,"rx_ip_errs":0,"ip_fwd_null_nhop":132344,"tx_bcast":2353,"bfd_rx_parse_err":0,"rx_bcast":185,"rx_icmp_echo_requests":0,"tx_if_not_preferred":1197705,"tx_icmp_dst_unreach_other":0,"rx_invalid_port":0,"split_horizon_drops":0,"rx_icmp_other_types":5458,"rx_arp_replies":43098,"tx_no_out_sa_pre_ipsec_drops":0,"invalid_back_ptr":0,"rx_pkts":31444972,"rx_invalid_qtags":244,"ip_fwd_to_cpu_nat_drops":0,"tx_gre_drops":0,"rx_icmp_src_quench":0,"rx_gre_policer_drops":0,"cbf_discards":0,"tx_gre_policer_drops":0,"rx_arp_non_local_drops":161199,"ip_fwd_unknown_nh_type":0,"tx_arp_req_fail":0,"tx_icmp_echo_requests":486552,"ip_fwd_to_egress":22866794,"tx_ipsec_encap":16205725,"rx_tunneled_pkts":0,"bfd_tx_record_changed":374,"rx_mcast_mirror_fwd_drops":0,"rx_unexpected_replay_drops_tc1":0,"rx_unexpected_replay_drops_tc2":0,"rx_unexpected_replay_drops_tc3":0,"rx_invalid_ipsec_pkt_size":0,"rx_unexpected_replay_drops_tc4":0,"ip_disabled_tx":0,"rx_unexpected_replay_drops_tc0":0,"rx_ipsec_policer_drops":0,"rx_unexpected_replay_drops_tc5":0,"rx_unexpected_replay_drops_tc6":0,"rx_unexpected_replay_drops_tc7":0,"rx_replay_drops_tc7":0,"rx_replay_drops_tc5":0,"ip_fwd_to_cpu_nat_xlates":0,"rx_replay_drops_tc6":0,"vdevice-dataKey":"169.254.10.10","rx_replay_drops_tc3":0,"rx_replay_drops_tc4":0,"rx_replay_drops_tc1":0,"rx_ipsec_decap":16201636,"rx_replay_drops_tc2":0,"rx_spi_ipsec_drops":0,"rx_replay_drops_tc0":0,"rx_host_mirror_drops":0,"rx_gre_drops":0,"ip_fwd_nat_on_tunnel":0,"rx_cp_non_local":0,"ip_fwd_to_cpu":6893414,"bfd_rx_record_invalid":0,"no_nat_nexthop":0,"tx_fragment_needed":0,"ip_fwd_mcast_life_exceeded_drops":0,"rx_pre_ipsec_decap":0,"ip_fwd":46077192,"rx_unexpected_replay_drops":0,"bfd_rec_down":0,"tunnel_pmtu_lowered":0,"filter_drops":0,"rx_icmp_protocol_unreach":0,"tx_queue_exceeded":0,"nat_xlate_inbound_fail":0,"tx_icmp_bad_ip_hdr":0,"nat_xlate_inbound":0,"rx_arp_rate_limit_drops":0,"bfd_rec_invalid":1,"rx_implicit_acl_drops":869,"ip_disabled_rx":0,"rx_mac_compare_ipsec_drops":0,"tx_ipsec_pkts":16205725,"rx_mcast_threshold_exceeded":0,"bfd_timer_add_fail":0,"openssl_aes_decrypt":0,"nat_xlate_outbound":0,"tx_ipsec_mcast_encap":0,"rx_gre_decap":0,"tx_errors":0,"bfd_tx_pkts":16142569,"service_label_fwd":0,"unknown_nh_type":0,"rx_mcast_policy_fwd_drops":0,"rx_pre_ipsec_drops":0,"tx_icmp_host_unreach":0,"vdevice-host-name":"vm3","rx_icmp_host_unreach":0,"rx_icmp_dst_unreach_other":0,"tx_icmp_redirect":0,"rx_mcast_link_local":17935,"rx_host_local_pkt":0,"tx_fragments":0,"tx_icmp_port_unreach":50,"icmp_redirect":0,"rx_mcast":18682,"tx_mcast":55760,"tx_mcast_fragment_needed":0,"rx_replay_integrity_drops":1,"rx_mcast_filter_to_cpu":0,"ip_fwd_rx_gre":0,"tx_icmp_protocol_unreach":0,"port_disabled_rx":9018,"ttl_expired":0,"tx_gre_encap":132344,"bfd_rx_pkts":16138479,"ip_fwd_arp":1187,"tx_icmp_network_unreach":0,"ip_fwd_invalid_tun_oil":0,"ip_fwd_rx_ipsec":16202760,"tx_icmp_other_types":654,"rx_no_tun_if":0,"app_route_policy_discards":0,"tx_no_out_sa_ipsec_drops":0,"rx_bad_label":0,"tx_pre_ipsec_pkts":16205725,"rx_mcast_filter_to_cpu_and_fwd":0,"tx_pre_ipsec_policer_drops":0,"rx_next_hdr_ipsec_drops":0,"bfd_tx_fail":0,"rx_ip6_ipsec_drops":0,"tunnel_loop_drops":0,"tx_arp_rate_limit_drops":0,"bfd_alloc_fail":0,"tx_pre_ipsec_encap":16205725,"ip_v6_mcast_drops":0,"port_disabled_tx":193,"ecmp_discards":0,"tx_icmp_echo_replies":0,"rx_icmp_fragment_required":0,"ip_fwd_from_cpu_nat_xlates":0,"rx_icmp_echo_replies":486048,"tx_no_tunn_ipsec_drops":0,"tx_no_arp_drop":0,"tx_vsmart_drop":0,"rx_policer_drops":0,"ip_fwd_invalid_oil":0,"rx_replay_drops":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/system/status":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system status list (Real Time)","operationId":"createDeviceSystemStatusList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system status":{"description":"Device system status","value":{"data":[{"mem_used":"954024","procs":"244","disk_avail":"7015M","disk_mount":"/","board_type":"Sim","vdevice-name":"169.254.10.10","total_cpu_count":"2","mem_cached":"740972","reboot_type":"Not Applicable","disk_fs":"/dev/root","fp_cpu_count":"1","chassis-serial-number":"None","min1_avg":"1.06","state_description":"All daemons up","personality":"vedge","disk_used":"174M","disk_use":"2","disk_status":"enabled","state":"green","config_date/date-time-string":"Mon Feb 14 04:47:05 UTC 2022","linux_cpu_count":"1","cpu_user":"5.53","testbed_mode":"1","min15_avg":"1.08","disk_size":"7615M","cpu_idle":"91.96","mem_buffers":"82140","model_sku":"None","cpu_system":"2.51","version":"20.6.2-440","min5_avg":"1.10","tcpd_cpu_count":"0","vdevice-host-name":"vm3","mem_total":"3906816","uptime":"16 days 05 hrs 08 min 45 sec","vdevice-dataKey":"169.254.10.10","mem_free":"2129680","bootloader_version":"Not applicable","fips_mode":"enabled","build_number":"440\n","lastupdated":1644814027189,"loghost_status":"disabled","uptime-date":1643413080000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/device/system/synced/status":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system stats list synchronously","operationId":"createSyncedDeviceSystemStatusList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"vdevice-name":"172.16.255.11","board_type":"Sim","total_cpu_count":"2","reboot_type":"NotApplicable","fp_cpu_count":"1","chassis-serial-number":"None","state_description":"Alldaemonsup","@rid":1175,"personality":"vedge","disk_status":"enabled","state":"green","linux_cpu_count":"1","testbed_mode":"1","createTimeStamp":1647316043522,"model_sku":"None","version":"20.9.999-1787","tcpd_cpu_count":"0","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11","vmanage-system-ip":"172.16.255.11","bootloader_version":"Notapplicable","fips_mode":"enabled","lastupdated":1647316042867,"build_number":"1787\n","loghost_status":"disabled","uptime-date":1647312840000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/tcpopt/activeflows":{"get":{"tags":["Real-Time Monitoring - TCP Optimization"],"description":"Get TCP optimized active flows from device (Real Time)","operationId":"getActiveTCPFlows","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TCP optimized active flow":{"description":"TCP optimized active flow","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","src-ip":"10.20.24.17","dest-ip":"10.20.25.18","src-port":53723,"dest-port":22,"start-time":"Fri Mar 17 13:21:02 2022","egress-intf-name":"loop0.3","ingress-intf-name":"ge0_4","tx-bytes":"153","rx-bytes":"64","tcp-state":"In progress","unopt-reason":"-","delete-reason":"-","proxy-identity":"Client-Proxy","lastupdated":0,"vdevice-dataKey":"172.16.254.1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/tcpopt/expiredflows":{"get":{"tags":["Real-Time Monitoring - TCP Optimization"],"description":"Get TCP optimized expired flows from device (Real Time)","operationId":"getExpiredTCPFlows","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TCP optimized expired flow":{"description":"TCP optimized expired flow","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","src-ip":"10.20.24.17","dest-ip":"10.20.25.18","src-port":53722,"dest-port":22,"start-time":"Fri Mar 17 13:16:26 2022","end-time":"Fri Mar 17 13:17:51 2022","tx-bytes":"4113","rx-bytes":"4333","tcp-state":"Optimized","unopt-reason":"-","proxy-identity":"Client-Proxy","delete-reason":"Closed","vdevice-dataKey":"169.254.10.9","lastupdated":1659327030348}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/tcpopt/summary":{"get":{"tags":["Real-Time Monitoring - TCP Optimization"],"description":"Get TCP optimization summary from device (Real Time)","operationId":"getTCPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TCP optimization summary":{"description":"TCP optimization summary","value":{"data":[{"flows-expired":"0","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","flows-optimized":"0","lastupdated":1644816147644,"flows-passthrough":"0","vdevice-host-name":"vm3","flows-in-progress":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/tcpproxy/statistics":{"get":{"tags":["Real-Time Monitoring - Tcpproxy"],"description":"Get tcp proxy statistics from device","operationId":"getTcpProxyStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tcp proxy statistics":{"description":"Tcp proxy statistics","value":{"data":[{"syn-purged-enq":"0","tot-fin-processed":"0","enable-rx-called":"0","tot-ev-tx-enable-process":"0","tot-send-fail":"0","tot-ssl-trig-rst-wkq-fail":"0","tcpp-aoim-sync-done":"0","tot-tcp-buf-sent":"0","tot-ssl-pause-called":"0","tot-ssl2svc-buf-enq":"0","tcp-flow-stats-del-fail":"0","enable-rx-queued":"0","tot-tcp-buf-rcvd":"0","tot-bytes-read-less-512":"0","tot-dre-resume-to-be-sent":"0","sync-fail-marked-cleanup":"0","sync-fail-entry-invalid":"0","tot-clean-server-data-q":"0","tot-ssl-resume-done":"0","ssl-init-failure":"0","tot-bytes-read-less-1024":"0","tot-tcp-buf-alloc":"0","pre-list-enq-failed":"0","tot-actual-pause-done":"0","tot-tcp-flow-clean-done":"0","tot-sc-reset-rcvd":"0","tot-rx-ssl-pause-process":"0","tot-async-event-send":"0","tot-bytes-read-less-4096":"0","vpath-cleanup-from-nmrx":"0","tcp-flow-entries-created":"0","tot-ssl-pause-done":"0","tot-tx-async-event-proc":"0","tcp-flow-stats-add-fail":"0","unif-logg-deq-no-space":"0","vdevice-name":"169.254.10.12","tot-snort-resume-done":"0","tot-pause-count-buf":"0","tot-snort-reset-init":"0","tot-buf-128k-alloc-failed":"0","unified-logging-msg-recvd":"0","tot-bytes-read-less-2048":"0","wcapi-svc-flow-delete-f":"0","sync-flow-mismatch":"0","num-stack-cb-null-ctx":"0","tot-tcp-buf-128k-alloc":"0","tot-clean-flow-ign":"0","cur-rx-epoll-count":"0","cur-tx-epoll-count":"0","curr-val-tcp-flow-entries":"0","unified-logg-deq-succ":"0","tx-enq-failure-count":"0","tot-reset-processed":"0","vpath-cleanup-from-evlib":"0","tot-en-rx-sock-stk-cl-svr":"0","tot-rx-dre-pause-process":"0","unified-logg-data-too-long":"0","sync-fail-nat-entry-null":"0","tot-tcp-reset-rcvd":"0","current-conn-count":"0","tot-ssl-fin-rcvd":"0","tot-tcp-buf-16k-alloc":"0","tot-buf-16k-alloc-failed":"0","tot-ssl-server-init":"0","vdevice-host-name":"vm5","tot-sc-fin-rcvd":"0","sync-fail-entry-null":"0","tot-ssl-buf-free":"0","tot-buff-drop-sock-closed":"0","enable-rx-done":"0","tot-page-alloc-retry":"0","tot-resume-count-buf":"0","lastupdated":1646012087379,"tx-enqueue-drops-close":"0","unified-logg-enq-succ":"0","proxy-cleanup-enq":"0","tot-ssl-reset-init":"0","tot-buff-drop-sock-not-av":"0","conn-failed":"0","tot-dre-resume-done":"0","tcpp-aoim-sync-error":"0","timer-expire-cleanup-enq":"0","tcp-flow-inv-entries":"0","other-cleanup-enq":"0","tot-page-alloc-failed":"0","tot-ssl2tcp-buf-enq":"0","tot-clean-add-wk-q-fail":"0","tot-dre-resume-msg-sent":"0","tot-uhi-munmap":"2768","pre-list-enq":"0","tot-fin-ign-fd-close":"0","tot-buf-32k-alloc-failed":"0","flow-drop-sn-gbl-health-y":"0","stack-cleanup-enq":"0","pre-remove-cleanup":"0","tot-en-rx-sock-stk-cl-clnt":"0","total-conns":"0","tot-ev-resume-process":"0","tot-svc2ssl-buf-enq":"0","tot-page-free":"0","conn-in-progress":"0","tot-dre-close-init":"0","clean-req-watcher-called":"1104871","tot-async-event-process":"0","tot-svc-reset-processed":"0","tot-page-alloc-fail-size":"0","flows-drop-wcapi-health-y":"0","tot-rx-snort-pause-proc":"0","pre-remove-err-timer":"0","tot-uhi-mmap":"88936","tot-page-alloc":"0","tot-cleanup-add-to-wk-q":"0","stack-cleanup-enq-failed":"0","pre-remove-accept":"0","tot-tcp2ssl-buf-enq":"0","tot-ssl-clean-addwkq-fail":"0","tot-ssl-buf-alloc":"0","tot-actual-resume-done":"0","tot-pause-count":"0","wcapi-svc-flow-create-f":"0","enable-rx-enq-failed":"0","flow-drop-sn-inst-health-y":"0","max-conns":"0","proxy-cleanup-enq-failed":"0","tot-ssl-reset-rcvd":"0","pre-rem-err-accept":"0","tot-ssl-reset-rcvd-sc":"0","wcapi-svc-flow-close-f":"0","other-cleanup-enq-failed":"0","tot-ssl-fin-rcvd-sc":"0","tot-tcp-buf-free":"0","tot-resume-count":"0","tot-tcp-fin-rcvd":"0","tot-tcp-buf-32k-alloc":"0","tot-clean-msg-rcvd":"0","tot-clean-client-data-q":"0","enable-rx-failed":"0","curr-tcp-flow-entries":"0","syn-purge-enq-failed":"0","tot-tx-async-event-send":"0","wcapi-svc-data-send-f":"0","tcp-flow-entries-deleted":"0","timer-ex-clean-enq-failed":"0","pre-clean-time-update":"0","vdevice-dataKey":"169.254.10.12","tot-ssl-buf-alloc-failed":"0","tot-ssl-resume-called":"0","tcpp-aoim-sync-started":"0","tot-dre-pause-done":"0","tot-tcp-buf-alloc-failed":"0","tot-snort-pause-done":"0","sync-fail-entry-inuse":"0","syncache-add-done":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/tcpproxy/status":{"get":{"tags":["Real-Time Monitoring - Tcpproxy"],"description":"Get tcp proxy status from device","operationId":"getTcpProxyStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tcp proxy status":{"description":"Tcp proxy status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","oper-state":"running","sng-name":"SNG-APPQOE","lastupdated":1646011762240,"sng-addr":"192.168.2.2","vdevice-host-name":"vm5","vpg-name":"VirtualPortGroup2","vpg-addr":"192.168.2.1","vpg-netmask":"255.255.255.0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/tier":{"get":{"tags":["Monitoring - Device Details"],"description":"getTiers","operationId":"getTiers","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Device Details"],"description":"add tier","operationId":"addTier","parameters":[{"name":"addTier","in":"path","description":"addTier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/device/tier/{tierName}":{"delete":{"tags":["Monitoring - Device Details"],"description":"deleteTier","operationId":"deleteTier","parameters":[{"name":"tierName","in":"path","description":"deletetier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tloc":{"get":{"tags":["Monitoring - Device Details"],"description":"Get TLOC status list","operationId":"getDeviceTlocStatus","parameters":[{"name":"deviceId","in":"query","schema":{"type":"string"}},{"name":"color","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTlocDataWithBFD"},"examples":{"Tloc Status":{"description":"Tloc Status","value":[{"color":"default","system-ip":"172.16.255.22","expectedControlConnections":2,"controlConnectionsUp":8,"controlConnectionsToVsmarts":2,"controlConnectionsDown":0},{"color":"default","system-ip":"172.16.255.20","expectedControlConnections":1,"controlConnectionsUp":15,"controlConnectionsToVsmarts":1,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.21","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.21","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"red","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"gold","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.14","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":10,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.16","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":10,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.16","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":9,"controlConnectionsDown":0},{"color":"default","system-ip":"172.16.255.19","expectedControlConnections":1,"controlConnectionsUp":15,"controlConnectionsToVsmarts":1,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.15","bfdSessionsDown":0,"controlConnectionsUp":3,"bfdSessionsUp":9,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.15","bfdSessionsDown":0,"controlConnectionsUp":2,"bfdSessionsUp":10,"controlConnectionsDown":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tlocutil":{"get":{"tags":["Monitoring - Device Details"],"description":"Get TLOC list","operationId":"getDeviceTlocUtil","parameters":[{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TLOC list":{"description":"TLOC list","value":{"header":{"generatedOn":1635311915500,"title":"Transport Interface Distribution","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-TlocUtilization"},"columns":[{"title":"Percentage Distribution","property":"percentageDistribution","dataType":"string"},{"title":"Value","property":"value","dataType":"number"}],"fields":[{"property":"percentageDistribution","dataType":"string"},{"property":"value","dataType":"number"}]},"data":[{"name":"less_than_10_mbps","percentageDistribution":"< 10 Mbps","detailsURL":"/dataservice/device/tlocutil/detail?util=lessthan10mbps","value":0},{"name":"10_mbps_100_mbps","percentageDistribution":"10 Mbps - 100 Mbps","detailsURL":"/dataservice/device/tlocutil/detail?util=10mbps100mbps","value":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tlocutil/detail":{"get":{"tags":["Monitoring - Device Details"],"description":"Get detailed TLOC list","operationId":"getDeviceTlocUtilDetails","parameters":[{"name":"util","in":"query","description":"Tloc util","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Detailed TLOC list":{"description":"Detailed TLOC list","value":{"header":{"generatedOn":1635314596057,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-TlocUtilizationDetails"},"columns":[{"title":"Average","property":"average","hideable":false,"dataType":"number"}],"fields":[{"property":"system-ip","dataType":"string"},{"property":"average","dataType":"number"}]},"data":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Generate admin tech logs","operationId":"createAdminTech","requestBody":{"description":"Admin tech generation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechCreateReq"},"examples":{"Generate Admin tech log":{"description":"Generate Admin tech log","value":{"deviceIP":"10.3.0.1","device-type":"vmanage","exclude-cores":true,"exclude-tech":false,"exclude-logs":true}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech/copy":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"copy admin tech logs","operationId":"copyAdminTechOnDevice","requestBody":{"description":"Admin tech copy request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechReq"},"examples":{"Copy Admin tech log":{"description":"Copy Admin tech log","value":{"deviceIP":"10.3.0.1","fileName":"10.3.0.1-20200522-102611-admin-tech.tar.gz"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech/delete":{"delete":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"delete admin tech logs","operationId":"deleteAdminTechOnDevice","requestBody":{"description":"Admin tech delete request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechReq"},"examples":{"Delete Admin tech log":{"description":"Delete Admin tech log","value":{"deviceIP":"10.3.0.1","fileName":"10.3.0.1-20200522-102611-admin-tech.tar.gz"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech/download/{filename}":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Download admin tech logs","operationId":"downloadAdminTechFile","parameters":[{"name":"filename","in":"path","description":"Admin tech file","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech/{requestID}":{"delete":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Delete admin tech logs","operationId":"deleteAdminTechFile","parameters":[{"name":"requestID","in":"path","description":"Request Id of admin tech generation request","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintechlist":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"List admin tech logs","operationId":"listAdminTechsOnDevice","requestBody":{"description":"Admin tech listing request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechListReq"},"examples":{"List Admin tech log":{"description":"List Admin tech log","value":{"deviceIP":"10.3.0.1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdminTechListRes"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintechs":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Get device admin-tech information","operationId":"listAdminTechs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechsRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintechs/inprogress":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Get device admin-tech InProgressCount","operationId":"getInProgressCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InProgressCount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintechs/upload":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"upload admin tech to SR","operationId":"uploadAdminTech","requestBody":{"description":"Admin tech upload request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechsUploadReq"},"examples":{"upload Admin tech log":{"description":"upload Admin tech log","value":"{\n \"sr_number\":\"69131837254\",\n \"token\":\"9b42986QTUc\",\n \"vpn\":\"VPN 0\",\n \"requestTokenId\":\"ea8cb172-61c4-47e0-8957-ac83b384f53e\",\n}"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/factoryreset":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Device factory reset","operationId":"factoryReset","requestBody":{"description":"Device factory reset","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device factory reset":{"description":"Device factory reset","value":{"deviceIP":"172.16.255.16","resetOption":"full-wipe/retain-license"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/netstat":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get device tool net stat","operationId":"getDeviceToolsNetstat","parameters":[{"name":"vpn","in":"query","description":"VPN","schema":{"type":"string","enum":["0","512"]}},{"name":"options","in":"query","description":"Options","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tools netstat Data Example":{"description":"Tools netstat Data Example","value":"{{\n \"rawOutput\": [\n \"Active Internet connections (w/o servers)\",\n \"Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name\",\n \"tcp 0 0 vm1:ssh 10.0.1.1:54932 ESTABLISHED 8964/sshd: admin [p\",\n \"Active UNIX domain sockets (w/o servers)\",\n \"Proto RefCnt Flags Type State I-Node PID/Program name Path\",\n \"unix 3 [ ] STREAM CONNECTED 1154465 3283/ftmd /var/run/.ftmd.512\",\n \"unix 3 [ ] STREAM CONNECTED 767015 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 1154461 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 767017 2181/cfgmgr /var/run/quagga/zebra_protobuf_notify.api.512\",\n \"unix 3 [ ] STREAM CONNECTED 1177839 8966/0 \",\n \"unix 2 [ ] STREAM CONNECTED 1177830 8964/sshd: admin [p \",\n \"unix 3 [ ] STREAM CONNECTED 1177840 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 1177838 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 766216 2519/zebra \"\n ]\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/nping/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"NPing device","operationId":"npingDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NPing parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"NPing parameter":{"description":"NPing parameter","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/nslookup":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get device tool nslookup","operationId":"getDeviceToolsNSlookup","parameters":[{"name":"vpn","in":"query","description":"VPN","required":true,"schema":{"type":"string","enum":["0","512"]}},{"name":"dns","in":"query","description":"DNS","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"8.8.8.8"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device tool nslookup data":{"description":"Device tool nslookup data","value":{"rawOutput":["Server: 10.0.1.1","Address 1: 10.0.1.1","","Name: 8.8.8.8","Address 1: 8.8.8.8"]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/ping/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Ping device","operationId":"pingDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ping parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Ping parameter":{"description":"Ping parameter","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/porthopcolor/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Request port hop color","operationId":"processPortHopColor","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device port hop color","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device port hop color":{"description":"Device port hop color","value":{"color":"mpls"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/realtimeinfo":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get hardware real time info from device","operationId":"getRealTimeinfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"hardware real time info data":{"description":"hardware real time info data","value":"{\t\"hardware-info\" : \"Hardware Information\\n---------------------------------\\n\nBaseboard Details:\\nboard type : ISR1100-4G\\nboard serial number:\nISR1100-4G-FCH2414L04T\\n-------------------------------\\nTPM Details:\\nAikido FPGA : 07250006\\n---------------------------------------------------------\\nBootloader version:\\nBIOS Version:17.7(1r)\\nBootloader Source: Upgrade\nBIOS\\n----------------------------------------------------------------\\nTemperature threshold history:\\n\",\n\"Kernel-log\" : \"Critical Kernel Logs:\"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/reset/interface/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Reset device interface","operationId":"processInterfaceReset","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device interface","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"vpnId":"512","ifname":"GigabitEthernet1"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/resetuser/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Request reset user","operationId":"processResetUser","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device user reset","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device user reset":{"description":"Device user reset","value":{"user":"admin"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/servicepath/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Service path","operationId":"servicePath","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Service path parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service path parameter":{"description":"Service path parameter","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/ss":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get device tool ss","operationId":"getDeviceToolsSS","parameters":[{"name":"vpn","in":"query","description":"VPN","schema":{"type":"string","enum":["0","512"]}},{"name":"options","in":"query","description":"Options","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device tool SS data ":{"description":"Device tool SS data ","value":{"rawOutput":["Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process ","u_str ESTAB 0 0 * 767015 * 0 users:((\"zebra\",pid=2519,fd=13)) ","u_str ESTAB 0 0 /var/run/quagga/zebra_protobuf_notify.api.512 767017 * 0 users:((\"cfgmgr\",pid=2181,fd=30)) ","u_str ESTAB 0 0 * 1154461 * 0 users:((\"zebra\",pid=2519,fd=16)) ","u_str ESTAB 0 0 /var/run/.ftmd.512 1154465 * 0 users:((\"ftmd\",pid=3283,fd=58)) ","u_str ESTAB 0 0 * 1177830 * 0 users:((\"sshd\",pid=8966,fd=6),(\"sshd\",pid=8964,fd=6)) ","u_str ESTAB 0 0 * 1177839 * 0 users:((\"sshd\",pid=8966,fd=5)) ","u_str ESTAB 0 0 * 1177840 * 0 users:((\"sshd\",pid=8964,fd=7)) ","u_dgr ESTAB 0 0 * 766216 * 0 users:((\"zebra\",pid=2519,fd=3)) ","u_dgr ESTAB 0 0 * 1177838 * 0 users:((\"sshd\",pid=8966,fd=3),(\"sshd\",pid=8964,fd=3)) ","tcp ESTAB 0 0 10.0.1.11:ssh 10.0.1.1:54932 users:((\"sshd\",pid=8966,fd=4),(\"sshd\",pid=8964,fd=4)) "]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/system-netfilter":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get system netfilter info from device","operationId":"getSystemNetfilter","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"System Netfilter info":{"description":"System Netfilter info","value":{"ipv4":"Chain POLICE_PROT (2 references)\n pkts bytes target prot opt in out source destination \n 113K 16M ACCEPT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT tcp -- * * 0.0.0.0/0 172.16.255.11 tcp dpt:830\n 0 0 ACCEPT icmp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT 89 -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:22\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:179\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT udp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 udp spt:67 dpt:68\nChain INPUT (policy ACCEPT 760K packets, 433M bytes)\n pkts bytes target prot opt in out source destination \n 113K 16M POLICE_PROT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 LOGGING tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 921K 494M ACCEPT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 ctstate ESTABLISHED\n 0 0 POLICE_PROT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \n 0 0 LOGGING all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 \nChain LOGGING (2 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all -- * * 0.0.0.0/0 0.0.0.0/0 ","ipv6":"Chain INPUT (policy ACCEPT 90 packets, 5040 bytes)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT all ge0_2 * ::/0 ::/0 ctstate ESTABLISHED\n 30 1680 POLICE_PROT all ge0_2 * ::/0 ::/0 \n 0 0 LOGGING all ge0_2 * ::/0 ::/0 \nChain POLICE_PROT (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 ACCEPT tcp * * ::/0 ::/0 tcp dpt:830\n 30 1680 ACCEPT icmpv6 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT 89 ge0_2 * ::/0 ::/0 \n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:22\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:179\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:830\n 0 0 ACCEPT udp ge0_2 * ::/0 ::/0 udp spt:547 dpt:546\nChain LOGGING (1 references)\n pkts bytes target prot opt in out source destination \n 0 0 DROP all * * ::/0 ::/0 "}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/traceroute/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Traceroute","operationId":"tracerouteDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Traceroute parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Traceroute parameter":{"description":"Traceroute parameter","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/tunnelpath/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"TunnelPath","operationId":"tunnelPath","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TunnelPath parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"TunnelPath parameter":{"description":"TunnelPath parameter","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/transport/connection":{"get":{"tags":["Real-Time Monitoring - Transport"],"description":"Get transport connection list from device","operationId":"createTransportConnectionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Transport connection list":{"description":"Transport connection list","value":{"data":[{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"0","lastupdated":1644816647932,"source":"0.0.0.0","time":"Fri Feb 11 18:19:43 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"1","lastupdated":1644816647933,"source":"0.0.0.0","time":"Fri Feb 11 18:16:58 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"2","lastupdated":1644816647933,"source":"0.0.0.0","time":"Fri Feb 4 18:19:51 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"3","lastupdated":1644816647933,"source":"0.0.0.0","time":"Fri Feb 4 18:17:06 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"4","lastupdated":1644816647934,"source":"0.0.0.0","time":"Thu Feb 3 18:23:58 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"5","lastupdated":1644816647934,"source":"0.0.0.0","time":"Thu Feb 3 18:21:13 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"6","lastupdated":1644816647935,"source":"0.0.0.0","time":"Wed Feb 2 18:19:38 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"7","lastupdated":1644816647935,"source":"0.0.0.0","time":"Wed Feb 2 18:16:47 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"8","lastupdated":1644816647935,"source":"0.0.0.0","time":"Tue Feb 1 18:19:56 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"9","lastupdated":1644816647936,"source":"0.0.0.0","time":"Tue Feb 1 18:17:11 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/tunnel/bfd_statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel BFD statistics all devices","operationId":"createBfdStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tunnel BFD statistics":{"description":"Tunnel BFD statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"bfd-echo-rx-pkts":0,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":0,"bfd-echo-tx-octets":0,"bfd-pmtu-rx-octets":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","bfd-pmtu-tx-pkts":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","lastupdated":1644817628460,"source-ip":"10.0.3.3","bfd-echo-tx-pkts":0,"bfd-pmtu-rx-pkts":0,"bfd-echo-rx-octets":0},{"dest-ip":"10.101.2.2","source-port":12366,"bfd-echo-rx-pkts":427365,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":307216,"bfd-echo-tx-octets":71583641,"bfd-pmtu-rx-octets":307216,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":376,"dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":427365,"bfd-pmtu-rx-pkts":376,"bfd-echo-rx-octets":71583634},{"dest-ip":"10.101.4.4","source-port":12366,"bfd-echo-rx-pkts":427523,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":307090,"bfd-echo-tx-octets":71610106,"bfd-pmtu-rx-octets":305818,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":375,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":427523,"bfd-pmtu-rx-pkts":375,"bfd-echo-rx-octets":71610099},{"dest-ip":"10.102.5.5","source-port":12366,"bfd-echo-rx-pkts":449468,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":531622,"bfd-echo-tx-octets":75208785,"bfd-pmtu-rx-octets":2835599,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":2157,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":449468,"bfd-pmtu-rx-pkts":2157,"bfd-echo-rx-octets":75362995},{"dest-ip":"10.102.6.6","source-port":12366,"bfd-echo-rx-pkts":449575,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":531622,"bfd-echo-tx-octets":75226641,"bfd-pmtu-rx-octets":2835599,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":2157,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":449575,"bfd-pmtu-rx-pkts":2157,"bfd-echo-rx-octets":75380984},{"dest-ip":"10.102.16.16","source-port":12366,"bfd-echo-rx-pkts":449641,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":531622,"bfd-echo-tx-octets":75237437,"bfd-pmtu-rx-octets":2835599,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":2157,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":449641,"bfd-pmtu-rx-pkts":2157,"bfd-echo-rx-octets":75392298}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/fec_statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel fec statistics","operationId":"createFecStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"tunnel fec statistics":{"description":"tunnel fec statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","fec-tx-data-pkts":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.0.3.3","fec-dynamic":"false"},{"dest-ip":"10.101.2.2","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.101.4.4","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.102.5.5","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.102.6.6","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.102.16.16","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/gre-keepalives":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get GRE keep alive information","operationId":"createGreKeepalivesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"GRE keep alive":{"description":"GRE keep alive","value":{"data":[{"dest-ip":"30.30.30.30","vdevice-name":"169.254.10.10","rx-packets":0,"rx-errors":0,"oper-state":"down","tx-errors":0,"admin-state":"up","vpn-id":"10","vdevice-host-name":"vm3","ka-enabled":"true","remote-tx-packets":0,"if-name":"gre1","vdevice-dataKey":"169.254.10.10-10-gre1","tx-packets":81366,"remote-rx-packets":0,"lastupdated":1644817234436,"source-ip":"10.0.3.3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/ipsec_statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel IPSec statistics all devices","operationId":"createIpsecStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tunnel IPSec statistics":{"description":"Tunnel IPSec statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","vdevice-name":"169.254.10.10","lastupdated":1644818093996,"source-ip":"10.0.3.3","vdevice-host-name":"vm3","tunnel-protocol":"gre"},{"dest-ip":"10.101.2.2","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","ipsec-decrypt-inbound":428675,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":428675},{"dest-ip":"10.101.4.4","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","ipsec-decrypt-inbound":428832,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":428832},{"dest-ip":"10.102.5.5","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","ipsec-decrypt-inbound":452605,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":452605},{"dest-ip":"10.102.6.6","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","ipsec-decrypt-inbound":452712,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":452712},{"dest-ip":"10.102.16.16","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","ipsec-decrypt-inbound":452777,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":452777}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/packet-duplicate":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel statistics packet duplication statistics","operationId":"createPacketDuplicateStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"tunnel statistics packet duplication stats":{"description":"tunnel statistics packet duplication stats","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.0.3.3","pktdup-tx-other":0},{"dest-ip":"10.101.2.2","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.101.4.4","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.102.5.5","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.102.6.6","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.102.16.16","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel statistics all devices","operationId":"createStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tunnel statistics":{"description":"Tunnel statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"vdevice-name":"169.254.10.10","rx_pkts":0,"tcp-mss-adjust":1392,"tx_octets":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","tx_pkts":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","rx_octets":0,"tunnel-mtu":1476,"lastupdated":1644819414066,"source-ip":"10.0.3.3"},{"dest-ip":"10.101.2.2","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":431317,"system-ip":"172.16.254.1","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":72492445,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":431317,"dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","rx_octets":72492438,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.101.4.4","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":431474,"system-ip":"172.16.254.3","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":72518784,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":431474,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","rx_octets":72517505,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.102.5.5","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":455393,"system-ip":"172.16.254.4","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":76373141,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":455393,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","rx_octets":78844158,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.102.6.6","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":455504,"system-ip":"172.16.254.5","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":76391653,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":455504,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","rx_octets":78862831,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.102.16.16","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":455567,"system-ip":"172.16.254.16","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":76401957,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":455567,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","rx_octets":78873632,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/ucse/stats":{"get":{"tags":["Real-Time Monitoring - Ucse"],"description":"Get UCSE stats entry from device","operationId":"createUcseStats","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{" UCSE stats entry":{"description":" UCSE stats entry","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.254.15","lastupdated":1646031617468,"slot-num":"0","subslot-num":"1","shutdown-count":"1","status-count":"0","server-raid-password-reset-count":"1","server-bios-password-reset-count":"2","server-reload-count":"1","server-reset-count":"1","server-start-count":"1","server-stop-count":"1","imc-password-reset-count":"1","imc-vlan-count":"1","imc-access-port-count":"1","imc-ip-count":"1","stats-start-time":"13:59:27 PDT Jun 5 2022"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/umbrella/device-registration":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella device registration from device","operationId":"getUmbrellaDevReg","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella device registration":{"description":"Umbrella device registration","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vdevice-dataKey":"169.254.10.9","vpn-id":"1","intf-name":"GigabitEthernet1/0/1","state":"SUCCESS","deviceID":"010a9b2b0d5cb21f","org-id":1892929,"retry-count":10,"tag":"vpn29","label":"-","http-response-code":200,"http-response-text":"SUCCESS","last-error":"-","last-code":"-","last-code-text":"-","lastupdated":1659327030348}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/dnscrypt":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella DNScrypt information from device","operationId":"getUmbrellaDNSCrypt","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella DNScrypt information":{"description":"Umbrella DNScrypt information","value":{"data":[{"vdevice-name":"169.254.10.10","index":0,"serial-num":0,"vdevice-host-name":"vm3","certificate-valid-from":"Jan 01 00:00:00 1970 GMT","client-magic":"0:0:0:0","vdevice-dataKey":"169.254.10.10-0","certificate-validity":"Invalid","client-public-key":"B40F:FA9A:31BB:690:C9F:7FEF:60A6:7FF5:286A:F519:64B2:586B:E35E:E4F0:E496:7FEE","certificate-state":"Init","resolver-public-key":"0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0","certificate-valid-till":"Jan 01 00:00:00 1970 GMT","lastupdated":1644823735329,"certificate-last-refresh-time":"Jan 01 00:00:00 1970 GMT","resolver-address":"208.67.222.222"},{"vdevice-name":"169.254.10.10","index":1,"serial-num":0,"vdevice-host-name":"vm3","certificate-valid-from":"Jan 01 00:00:00 1970 GMT","client-magic":"0:0:0:0","vdevice-dataKey":"169.254.10.10-1","certificate-validity":"Invalid","client-public-key":"97A1:BCCD:92FE:7FCE:2EC7:CEBC:B6CB:7589:9E63:D830:5D56:FEFD:301E:56C3:D9EF:1851","certificate-state":"Init","resolver-public-key":"0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0","certificate-valid-till":"Jan 01 00:00:00 1970 GMT","lastupdated":1644823735329,"certificate-last-refresh-time":"Jan 01 00:00:00 1970 GMT","resolver-address":"208.67.220.220"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/dp-stats":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella dp-stats from device","operationId":"getUmbrellaDpStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella dp-stats":{"description":"Umbrella dp-stats","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","local-domain-bypass-pkts":"0","dnscrypt-dec-rcvd":"0","redirect-pkts":"0","dnscrypt-enc-sent":"0","dnscrypt-errors":"0","parser-errors":"0","lastupdated":1659327030348,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/overview":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella overview from device","operationId":"getUmbrellaOverview","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella overview":{"description":"Umbrella overview","value":{"data":[{"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","registrations-requested":"0","registrations-completed":"0","lastupdated":1644823908956,"dnscrypt":"true","vdevice-host-name":"vm3","last-success-attempt":"0000-00-00T00:00:00+00:00"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/umbrella-config":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella configuration from device","operationId":"getUmbrellaConfig","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella configuration":{"description":"Umbrella configuration","value":{"data":[{"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","ldb-status":"-N/A-","public-key":"B0E1:6D15:C32D:4E8C:996B:635A:FA90:05B9","lastupdated":1644823464208,"DNSCrypt":"Enabled","vdevice-host-name":"vm3","resolver-address":"208.67.222.222, 208.67.220.220"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/unclaimed/vedges":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get unclaimed vEdges from vbond","operationId":"getUnclaimedVedges","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Unclaimed vEdges":{"description":"Unclaimed vEdges","value":{"data":[{"vdevice-name":"172.16.255.15","chassis-number":"07a08f05-ad1d-4ccc-b383-dc608f4eb2a3","serial-number":"E66DC14C154D4861","subject-serial-number":"E66DC14C154D4861","org":"viptela.local"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/unconfigured":{"get":{"tags":["Monitoring - Device Details"],"description":"Get wan edge devices not configured by vManage (that is, those in CLI mode)","operationId":"getUnconfigured","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Device"}},"examples":{"Unconfigured devices":{"description":"Unconfigured devices","value":[{"uuid":"3e314ce8-cbaf-4fc7-882b-bacd16bd9a33","systemIp":"172.16.255.11","deviceType":"vedge"},{"uuid":"a9d47933-ee30-4e9f-bee6-a2ac81a0b284","systemIp":"172.16.255.21","deviceType":"vedge"},{"uuid":"e417ea1d-43dd-4285-8077-f7e20975568a","systemIp":"172.16.255.14","deviceType":"vedge"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/unreachable":{"get":{"tags":["Monitoring - Device Details"],"description":"Get list of unreachable devices","operationId":"listUnreachableDevices","parameters":[{"name":"personality","in":"query","description":"Device personality (vedge OR vsmart OR vbond... )","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"List of unreachable devices":{"description":"List of unreachable devices","value":{"header":{"generatedOn":1635316653935,"viewKeys":{"uniqueKey":["system-ip"],"preferenceKey":"grid-vManage Control Connections"},"columns":[{"title":"Reachability","property":"reachability","colorProperty":"reachability","color":[{"key":"reachable","value":"616161"},{"key":"unreachable","value":"ef5350"},{"key":"auth-failed","value":"ffb300"}],"width":100,"minWidth":90,"dataType":"string"},{"title":"Hostname","property":"host-name","display":"iconAndText","iconProperty":"device-type","hideable":false,"icon":[{"key":"vmanage","value":"images/vmanage_table.png"},{"key":"vedge","value":"images/vedge_table.png"},{"key":"vedge-vbond","value":"images/vedge-vbond_table.png"},{"key":"vsmart","value":"images/vsmart_table.png"},{"key":"vbond","value":"images/vbond_table.png"}],"width":150,"dataType":"string"}],"fields":[{"property":"board-serial","dataType":"string"},{"property":"lastupdated","dataType":"date"}]},"data":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/unreachable/{deviceIP}":{"delete":{"tags":["Monitoring - Device Details"],"description":"Delete unreachable device","operationId":"removeUnreachableDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/users":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get users from device (Real Time)","operationId":"getUsersFromDevice","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Users":{"description":"Users","value":[{"from":"10.0.1.1","proto":"ssh","login-time":"2022-01-26T07:36:15+00:00","auth-group":"netadmin log ","lastupdated":1644914131016,"vdevice-dataKey":"172.16.255.11-28","session":"28","user":"admin","context":"cli","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/users/list":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get all users from device","operationId":"getAllDeviceUsers","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Users":{"description":"Users","value":{"data":[{"user":"admin"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write,Tools-read,Tools-write"}},"/device/utd/dataplane-config":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane config from Device","operationId":"getUTDDataplaneConfig","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane config":{"description":"UTD data plane config","value":{"data":[{"sn-redirect":"fail-open","vdevice-name":"172.16.255.15","context-flag":"8847361","defense-mode":"IPS","context-id":"0","redirect-type":"divert","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15-0","threat-inspection":"enabled","engine":"Standard","domain-filtering":"not-enabled","url-filtering":"not-enabled","lastupdated":1659514008513,"state":"enabled","all-interface":"enabled"},{"sn-redirect":"fail-open","vdevice-name":"172.16.255.15","context-flag":"13041665","defense-mode":"IPS","context-id":"3","redirect-type":"divert","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15-3","threat-inspection":"enabled","engine":"Standard","domain-filtering":"not-enabled","url-filtering":"enabled","lastupdated":1659514008513,"state":"enabled","all-interface":"enabled"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/dataplane-global":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane global from Device","operationId":"getUTDDataplaneGlobal","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane global":{"description":"UTD data plane global","value":{"data":[{"utd-appnav-dereg-failed":"0","utd-appnav-health-down":"0","vdevice-name":"172.16.255.15","utd-appnav-health-yellow":"0","init-service-plane-failed":"0","sn-threads":"12","cft-utd-fo-id":"4","cft-feat-id":"4","sn-health":"green","nat64":"disabled","utd-appnav-health-green":"1","multi-tenancy":"enabled","max-flows":"165000","cft-utd-fo-chunk-id":"12","utd-appnav-health-unknown":"0","utd-appnav-health-red":"1","vdevice-host-name":"vm5","dp-initialized":"yes","vdevice-dataKey":"172.16.255.15","cft-id":"0","utd-appnav-register":"0","utd-appnav-deregister":"0","utd-appnav-reg-failed":"0","lastupdated":1659514090144,"drop-pkts":"disabled"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/dataplane-stats":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane stats from Device","operationId":"getUTDDataplaneStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane stats":{"description":"UTD data plane stats","value":{"data":[{"cft-ager-del-fo":"0","utd-appnav-decaps-icmp-no-payload-err":"0","utd-drop-cft-lookup-flow":"0","utd-pkts-enter-divert":"0","utd-appnav-encaps-debug-err":"0","utd-appnav-decaps-ip-unsup-ver":"0","cft-ager-del-fo-failed":"0","utd-flow-bypass":"0","utd-packets-reinjected":"0","utd-sn-drop":"0","utd-drop-cft-get-fo":"0","utd-appnav-decaps-icmp-v6-tcp-err":"0","utd-df-blacklist-match":"0","utd-drop-appnav-decaps-class-event-err":"0","pkt-skip-invalid-iuidb":"0","pkt-skip-for-us":"0","utd-appnav-decaps-icmp-no-inner-flow":"0","utd-appnav-encap-fail":"0","utd-appnav-encaps-fail":"0","pkt-skip-unsupport-prot":"0","utd-appnav-decaps-icmp-udp-err":"0","utd-drop-msg-logged":"0","utd-appnav-decaps-no-fo":"0","utd-drop-bad-ip-ver":"0","utd-drop-cft-alloc-fo":"0","utd-drop-nat64-int-lookup-fail":"0","utd-drop-appnav-encaps-debug":"0","pkt-no-inspect-divert-intf":"4516","utd-drop-divert-down":"0","pkt-policy-inspected":"87657","min-utd-drop-cause":"0","pkt-nat-dropped-pkt":"0","utd-appnav-decaps-icmp-tcp-err":"0","utd-df-gray-flows":"0","vdevice-name":"172.16.255.15","utd-drop-ipv6-frag":"0","init-cft-inst-get-failed":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-decaps-del-term":"0","pkt-skip-new-pkt":"0","init-vfr-unreg-failed":"0","utd-drop-appnav-encaps-vrf":"0","utd-appnav-decaps-tlv-len-err":"0","utd-appnav-decaps-icmp-no-inner-fo":"0","utd-appnav-decaps-icmp-v6-udp-err":"0","utd-appnav-redirect-fail":"0","utd-drop-cft-attach-fo":"0","utd-appnav-decaps-not-icmp-v6":"0","utd-appnav-decaps-icmp-v6-no-payload-err":"0","utd-pm-udpconns":"0","flow-setup-failed":"0","utd-df-whitelist-match":"0","utd-drop-appnav-encaps-service-add":"0","vdevice-host-name":"vm5","utd-drop-appnav-encaps-not-enuf":"0","utd-appnav-decaps-del-unknown":"0","utd-drop-cft-no-fo":"0","utd-drop-appnav-encaps-conn-handle-err":"0","skp-no-divert-needed":"0","utd-drop-was-vfr":"0","lastupdated":1659514165829,"utd-df-blacklisted-flows":"0","utd-appnav-decaps":"0","utd-appnav-decaps-icmp-unsup-proto":"0","utd-drop-appnav-encaps-no-fo":"0","utd-appnav-encaps":"0","utd-active-conns":"0","utd-appnav-decaps-no-flow":"0","utd-bypass-drop":"0","utd-appnav-decaps-ipv6-parse-err":"0","init-cft-del-cb-reg-failed":"0","utd-appnav-encaps-conn-est-err":"0","utd-drop-appnav-divert":"0","utd-drop-no-uidb":"0","pkt-skip-inspected":"4516","utd-appnav-decaps-unsupported-tlv":"0","utd-drop-appnav-encaps-no-classified":"0","pkt-fo-free-err":"0","utd-drop-appnav-unhealthy":"0","utd-drop-appnav-encaps-first-pkt-fail":"0","utd-reinject-no-ctx":"0","pkt-skip-no-ctx":"0","pkt-skip-inspected-no-divert":"0","utd-flow-notify-offload":"0","utd-appnav-decaps-not-icmp-err":"0","utd-drop-no-fib":"0","utd-pkts-dropped":"0","utd-pkt-entry-sp":"0","utd-drop-appnav-decaps-no-flow-tuple":"0","context-id":"0","utd-df-whitelisted-flows":"0","utd-drop-no-divert-intf":"0","utd-appnav-redirect":"0","pkt-skip-mpls-non-ip":"0","utd-appnav-decaps-not-icmp-v6-err":"0","utd-drop-no-oce-chain":"0","pkt-skip-l2-glean-adj":"0","utd-appnav-decaps-icmp-v6-unsup-proto":"0","utd-pm-icmpconns":"0","utd-appnav-reinject":"0","cft-flow-responder-seen":"0","utd-drop-appnav-decaps-conn-est":"0","utd-drop-no-egress-intf":"0","utd-appnav-decaps-del-req":"0","utd-appnav-unhealthy":"0","utd-drop-appnav-encaps-no-mem":"0","pkt-fo-alloc":"0","utd-drop-ips":"0","pkt-fo-free":"0","init-vfr-reg-failed":"0","utd-packets-diverted":"0","utd-drop-appnav-decaps-delete":"0","utd-drop-ipv4-frag":"0","utd-drop-appnav-decaps-pass-err":"0","utd-drop-sn-request":"0","utd-appnav-encaps-vrf-err":"0","utd-drop-reinject":"0","utd-pkts-skipped":"0","utd-packets-failed-divert":"0","utd-appnav-decaps-no-conn-tlv-flow":"0","vdevice-dataKey":"172.16.255.15-0","pkt-skip-invalid-ouidb":"0","utd-appnav-decaps-del-resource":"0","utd-appnav-decaps-del-idle":"0"},{"cft-ager-del-fo":"0","utd-appnav-decaps-icmp-no-payload-err":"0","utd-drop-cft-lookup-flow":"0","utd-pkts-enter-divert":"0","utd-appnav-encaps-debug-err":"0","utd-appnav-decaps-ip-unsup-ver":"0","cft-ager-del-fo-failed":"0","utd-flow-bypass":"0","utd-packets-reinjected":"0","utd-sn-drop":"0","utd-drop-cft-get-fo":"0","utd-appnav-decaps-icmp-v6-tcp-err":"0","utd-df-blacklist-match":"0","utd-drop-appnav-decaps-class-event-err":"0","pkt-skip-invalid-iuidb":"0","pkt-skip-for-us":"0","utd-appnav-decaps-icmp-no-inner-flow":"0","utd-appnav-encap-fail":"0","utd-appnav-encaps-fail":"0","pkt-skip-unsupport-prot":"0","utd-appnav-decaps-icmp-udp-err":"0","utd-drop-msg-logged":"0","utd-appnav-decaps-no-fo":"0","utd-drop-bad-ip-ver":"0","utd-drop-cft-alloc-fo":"0","utd-drop-nat64-int-lookup-fail":"0","utd-drop-appnav-encaps-debug":"0","pkt-no-inspect-divert-intf":"0","utd-drop-divert-down":"0","pkt-policy-inspected":"0","min-utd-drop-cause":"0","pkt-nat-dropped-pkt":"0","utd-appnav-decaps-icmp-tcp-err":"0","utd-df-gray-flows":"0","vdevice-name":"172.16.255.15","utd-drop-ipv6-frag":"0","init-cft-inst-get-failed":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-decaps-del-term":"0","pkt-skip-new-pkt":"0","init-vfr-unreg-failed":"0","utd-drop-appnav-encaps-vrf":"0","utd-appnav-decaps-tlv-len-err":"0","utd-appnav-decaps-icmp-no-inner-fo":"0","utd-appnav-decaps-icmp-v6-udp-err":"0","utd-appnav-redirect-fail":"0","utd-drop-cft-attach-fo":"0","utd-appnav-decaps-not-icmp-v6":"0","utd-appnav-decaps-icmp-v6-no-payload-err":"0","utd-pm-udpconns":"0","flow-setup-failed":"0","utd-df-whitelist-match":"0","utd-drop-appnav-encaps-service-add":"0","vdevice-host-name":"vm5","utd-drop-appnav-encaps-not-enuf":"0","utd-appnav-decaps-del-unknown":"0","utd-drop-cft-no-fo":"0","utd-drop-appnav-encaps-conn-handle-err":"0","skp-no-divert-needed":"0","utd-drop-was-vfr":"0","lastupdated":1659514165829,"utd-df-blacklisted-flows":"0","utd-appnav-decaps":"0","utd-appnav-decaps-icmp-unsup-proto":"0","utd-drop-appnav-encaps-no-fo":"0","utd-appnav-encaps":"0","utd-active-conns":"0","utd-appnav-decaps-no-flow":"0","utd-bypass-drop":"0","utd-appnav-decaps-ipv6-parse-err":"0","init-cft-del-cb-reg-failed":"0","utd-appnav-encaps-conn-est-err":"0","utd-drop-appnav-divert":"0","utd-drop-no-uidb":"0","pkt-skip-inspected":"0","utd-appnav-decaps-unsupported-tlv":"0","utd-drop-appnav-encaps-no-classified":"0","pkt-fo-free-err":"0","utd-drop-appnav-unhealthy":"0","utd-drop-appnav-encaps-first-pkt-fail":"0","utd-reinject-no-ctx":"0","pkt-skip-no-ctx":"0","pkt-skip-inspected-no-divert":"0","utd-flow-notify-offload":"0","utd-appnav-decaps-not-icmp-err":"0","utd-drop-no-fib":"0","utd-pkts-dropped":"0","utd-pkt-entry-sp":"0","utd-drop-appnav-decaps-no-flow-tuple":"0","context-id":"3","utd-df-whitelisted-flows":"0","utd-drop-no-divert-intf":"0","utd-appnav-redirect":"0","pkt-skip-mpls-non-ip":"0","utd-appnav-decaps-not-icmp-v6-err":"0","utd-drop-no-oce-chain":"0","pkt-skip-l2-glean-adj":"0","utd-appnav-decaps-icmp-v6-unsup-proto":"0","utd-pm-icmpconns":"0","utd-appnav-reinject":"0","cft-flow-responder-seen":"0","utd-drop-appnav-decaps-conn-est":"0","utd-drop-no-egress-intf":"0","utd-appnav-decaps-del-req":"0","utd-appnav-unhealthy":"0","utd-drop-appnav-encaps-no-mem":"0","pkt-fo-alloc":"0","utd-drop-ips":"0","pkt-fo-free":"0","init-vfr-reg-failed":"0","utd-packets-diverted":"0","utd-drop-appnav-decaps-delete":"0","utd-drop-ipv4-frag":"0","utd-drop-appnav-decaps-pass-err":"0","utd-drop-sn-request":"0","utd-appnav-encaps-vrf-err":"0","utd-drop-reinject":"0","utd-pkts-skipped":"0","utd-packets-failed-divert":"0","utd-appnav-decaps-no-conn-tlv-flow":"0","vdevice-dataKey":"172.16.255.15-3","pkt-skip-invalid-ouidb":"0","utd-appnav-decaps-del-resource":"0","utd-appnav-decaps-del-idle":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/dataplane-stats-summary":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane stats summary","operationId":"getUTDDataplaneStatsSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane stats summary":{"description":"UTD data plane stats summary","value":{"data":[{"utd-active-conns":"0","vdevice-name":"172.16.255.15","utd-drop-sn-request":"0","utd-pm-udpconns":"0","utd-pkts-dropped":"0","context-id":"0","utd-pkts-skipped":"0","vdevice-host-name":"vm5","utd-packets-reinjected":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-unhealthy":"0","vdevice-dataKey":"172.16.255.15-0","utd-pm-icmpconns":"0","lastupdated":1659514169760,"utd-packets-diverted":"0","utd-flow-notify-offload":"0"},{"utd-active-conns":"0","vdevice-name":"172.16.255.15","utd-drop-sn-request":"0","utd-pm-udpconns":"0","utd-pkts-dropped":"0","context-id":"3","utd-pkts-skipped":"0","vdevice-host-name":"vm5","utd-packets-reinjected":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-unhealthy":"0","vdevice-dataKey":"172.16.255.15-3","utd-pm-icmpconns":"0","lastupdated":1659514169760,"utd-packets-diverted":"0","utd-flow-notify-offload":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/engine-instance-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD engine instance status from device (Real Time)","operationId":"getUTDEngineInstanceStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD engine instance status":{"description":"UTD engine instance status","value":{"data":[{"utd-engine-instance-status-running":"true","vdevice-dataKey":"172.16.255.15-1","vdevice-name":"172.16.255.15","utd-engine-instance-status-id":"1","utd-engine-instance-status-status":"utd-oper-status-green","lastupdated":1659499440216,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/engine-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD engine status from device (Real Time)","operationId":"getUTDEngineStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD engine status":{"description":"UTD engine status","value":{"data":[{"vdevice-dataKey":"172.16.255.15","utd-engine-status-version":"1.0.6_SV2.9.18.1_XE17.9","vdevice-name":"172.16.255.15","utd-engine-status-memory-status":"utd-oper-status-green","lastupdated":1659514314427,"utd-engine-status-status":"utd-oper-status-green","utd-engine-status-memory-usage":"8.9","vdevice-host-name":"vm5","utd-engine-status-profile":"Cloud-Low"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/file-analysis-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD file analysis status from device (Real Time)","operationId":"getUTDFileAnalysisStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD file analysis status":{"description":"UTD file analysis status","value":{"data":[{"utd-file-analysis-status-status":"tg-client-stat-unknown","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","lastupdated":1645768248935,"utd-file-analysis-status-backoff-interval":"0","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/file-reputation-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD file reputation status from device (Real Time)","operationId":"getUTDFileReputationStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD file reputation status":{"description":"UTD file reputation status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","utd-file-reputation-status-status":"utd-file-repu-stat-process-unknown","vdevice-name":"169.254.10.12","lastupdated":1645773049060,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/ips-update-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD IPS update status from device (Real Time)","operationId":"getUTDIpsUpdateStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD IPS update status":{"description":"UTD IPS update status","value":{"data":[{"ips-update-status-last-update-time":"1970-01-01T00:00:00+00:00","vdevice-dataKey":"172.16.255.15","vdevice-name":"172.16.255.15","lastupdated":1659499361542,"ips-update-status-last-update-status":"utd-update-status-unknown","vdevice-host-name":"vm5","ips-update-status-last-successful-update-time":"1970-01-01T00:00:00+00:00"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/signature/version/details":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD Signature version information from Device","operationId":"getSignatureVersionInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD Signature version":{"description":"UTD Signature version","value":{"data":[{"last-updated":"-","ips-version":"29.0.c"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/urlf-con-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD URLF Connection status from device (Real Time)","operationId":"getUTDUrlfConnectionStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD URLF connection status":{"description":"UTD URLF connection status","value":{"data":[{"vdevice-dataKey":"172.16.255.15","vdevice-name":"172.16.255.15","lastupdated":1659499167268,"vdevice-host-name":"vm5","last-attempt-time":"1970-01-01T00:00:00+00:00","status":"utd-con-unknown"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/utd/urlf-update-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD URLF update status from device (Real Time)","operationId":"getUTDUrlfUpdateStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD URLF update status":{"description":"UTD URLF update status","value":{"data":[{"urlf-update-status-last-successful-update-time":"1970-01-01T00:00:00+00:00","vdevice-dataKey":"null","urlf-update-status-last-update-status":"utd-update-status-unknown","vdevice-name":"172.16.255.15","urlf-update-status-last-update-time":"1970-01-01T00:00:00+00:00","lastupdated":1659499288353,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/version-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD version status from device (Real Time)","operationId":"getUTDVersionStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD version status":{"description":"UTD version status","value":{"data":[{"utd-version-status-supported":"false","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","utd-version-status-recommended-version":"1.11.1_SV2.9.18.1_XEmain","lastupdated":1645756283937,"vdevice-host-name":"vm5","utd-version-status-supported-regex":"^1\\.11\\.([0-9]+)_SV(.*)_XEmain$"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/coLineSpecificStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service line bonding stats from device","operationId":"getCoLineSpecificStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service line bonding stats":{"description":"VDSL service line bonding stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","slot-num":"0","line-num":"4","trellis-state":"ON","sra-enabled":"disabled","sra-count":"0","bit-swap-enabled":"enabled","bit-swap-count":"0","line-attenuation":"0.9dB","signal-attenuation":"1.8dB","noise-margin":"18.6dB","attainable-rate":"138139 kbits/s","actual-power":"14.1dBm","total-fecc":"302690","total-es":"295","total-ses":"161","total-loss":"14","total-uas":"87189","total-lprs":"0","total-lofs":"80","total-lols":"0","speed":"27547","sra-previous-speed":"0","previous-speed":"128857","reed-solomon-ec":"0","crc-errors":"24722","header-errors":"8","interleave":"7.00","actual-inp":"1.00","gfast-fra-count":"57","gfast-rpa-count":"45","gfast-tiga-count":"76","gfast-rtx-uc":"0","gfast-rtx-tx":"0","gfast-attainable-exp-thru":"0","gfast-error-free-thru":"0","atm-total-cells":"11338923","atm-user-cells":"0","vdsl2-la-band-d1":"0.2","vdsl2-la-band-d2":"0.9","vdsl2-la-band-d3":"1.7","vdsl2-sa-band-d1":"0.2","vdsl2-sa-band-d2":"0.9","vdsl2-sa-band-d3":"1.7","vdsl2-snr-band-d1":"27.7","vdsl2-snr-band-d2":"16.9","vdsl2-snr-band-d3":"10.9","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/coStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get CO stats from device","operationId":"getCoStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CO stats":{"description":"CO stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","chip-vendor":"BDCM","line-attenuation":"0.9dB","noise-margin":"18.6dB","attainable-rate":"138139kbits/s","actual-power":"14.1dBm","speed":"128857","slot-num":"0","subslot-num":"0","modem-serial":"FCH2234TH6R C927-4P 15.8(3)M1","chip-vendor-specific":"0xB11F","chip-vendor-country":"0xB500","modem-vendor-id":"CSCO","modem-vendor-specific":"0x4602","modem-vendor-country":"0xB500","modem-version":"15.8(3)M1","lastupdated":1642581869106,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/cpeLineSpecificStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service CPE line specific stats from device","operationId":"getCpeLineSpecificStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service CPE line specific stats":{"description":"VDSL service CPE line specific stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","slot-num":"0","line-num":"4","trellis-state":"ON","sra-enabled":"disabled","sra-count":"0","bit-swap-enabled":"enabled","bit-swap-count":"0","line-attenuation":"0.9dB","signal-attenuation":"1.8dB","noise-margin":"18.6dB","attainable-rate":"138139 kbits/s","actual-power":"14.1dBm","total-fecc":"302690","total-es":"295","total-ses":"161","total-loss":"14","total-uas":"87189","total-lprs":"0","total-lofs":"80","total-lols":"0","speed":"27547","sra-previous-speed":"0","previous-speed":"128857","reed-solomon-ec":"0","crc-errors":"24722","header-errors":"8","interleave":"7.00","actual-inp":"1.00","gfast-fra-count":"57","gfast-rpa-count":"45","gfast-tiga-count":"76","gfast-rtx-uc":"0","gfast-rtx-tx":"0","gfast-attainable-exp-thru":"0","gfast-error-free-thru":"0","atm-total-cells":"11338923","atm-user-cells":"0","vdsl2-la-band-d1":"0.2","vdsl2-la-band-d2":"0.9","vdsl2-la-band-d3":"1.7","vdsl2-sa-band-d1":"0.2","vdsl2-sa-band-d2":"0.9","vdsl2-sa-band-d3":"1.7","vdsl2-snr-band-d1":"27.7","vdsl2-snr-band-d2":"16.9","vdsl2-snr-band-d3":"10.9","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/cpeStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get CPE stats from device","operationId":"getCpeStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CPE stats":{"description":"CPE stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","chip-vendor":"BDCM","line-attenuation":"0.9dB","noise-margin":"18.6dB","attainable-rate":"138139kbits/s","actual-power":"14.1dBm","speed":"128857","slot-num":"0","subslot-num":"0","modem-serial":"","chip-vendor-specific":"FCH2234TH6R C927-4P 15.8(3)M1","chip-vendor-country":"0xB500","modem-vendor-id":"CSCO","modem-vendor-specific":"0x4602","modem-vendor-country":"0xB500","modem-version":"15.8(3)M1","lastupdated":1642581869106,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/lineBondingStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service line bonding stats from device","operationId":"getLineBondingStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service line bonding stats":{"description":"VDSL service line bonding stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","slot-num":"0","ports-supported":"0","port-0-link-status":"up","port-1-link-status":"down","aggregate-us-rate":"87957 kbits/s","aggregate-ds-rate":"138139 kbits/s","lastupdated":0,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/lineSpecificStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service line specific stats from device","operationId":"getLineSpecificStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service line specific stats":{"description":"VDSL service line specific stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15","slot-num":"0","line-number":"4","modem-status":"TC Sync (Showtime!)","trained-mode":"G.992.5 (ADSL2+) Annex A","profile-30a-enabled":"enabled","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/vdslInfo":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL info from device","operationId":"getVdslInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL info":{"description":"VDSL info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","state":"UP","mode":"AUTO","modem-status":"TC Sync (Showtime!)","trained-mode":"G.993.2 (VDSL2) Profile 17a","firmware-version":"4.14L.04","phy-version":"A2pv6F039x8.d26d","slot-num":"0","subslot-num":"0","dsl-config-mode":"AUTO","delt-configuration-enabled":"disabled","delt-state":"not running","failed-full-inits":"15","short-inits":"8","failed-short-inits":"7","modem-phy-source":"embedded","training-log-state":"Stopped","training-log-filename":"flash:vdsllog.bin","lastupdated":1642581869106,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vedgeinventory/detail":{"get":{"tags":["Monitoring - Device Details"],"description":"Get detailed vEdge inventory","operationId":"getVedgeInventory","parameters":[{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VedgeInventoryData"},"examples":{"vEdge Inventory":{"description":"vEdge Inventory","value":[{"site-id":"400","serialNumber":"12346576","validity":"valid","host-name":"vm4","deviceType":"vedge","local-system-ip":"172.16.255.14","chasisNumber":"59414e3c-24cd-44de-8072-261224224c25","system-ip":"172.16.255.14"},{"site-id":"100","serialNumber":"12346568","validity":"valid","host-name":"vm11","deviceType":"vedge","local-system-ip":"172.16.255.21","chasisNumber":"63e8518c-e76f-4d5f-a4c7-28ffb669526b","system-ip":"172.16.255.21"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/vedgeinventory/summary":{"get":{"tags":["Monitoring - Device Details"],"description":"Get vEdge inventory","operationId":"getVedgeInventorySummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vEdge inventory":{"description":"vEdge inventory","value":{"header":{"generatedOn":1635390164998,"title":"WAN Edge Inventory","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-vedgeInventory"},"columns":[{"title":"Inventory List","property":"list","dataType":"string"}],"fields":[{"property":"list","dataType":"string"}]},"data":[{"name":"Total","list":"Total","value":0,"detailsURL":"/dataservice/device/vedgeinventory/detail"},{"name":"Authorized","list":"Authorized","detailsURL":"/dataservice/device/vedgeinventory/detail?status=authorized","value":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/virtualApplication/te":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get ThousandEyes app list from device","operationId":"createTeList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Te apps list":{"description":"Te apps list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","version":"1.0.16_SV2.9.16.1_XE17.3","active":"true","previous":"true","timestamp":"2022-09-01T13:29:43-00:00","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/virtualApplication/utd":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get Utd apps list from device","operationId":"createUtdList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Utd apps list":{"description":"Utd apps list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","version":"1.0.16_SV2.9.16.1_XE17.3","active":"true","previous":"true","timestamp":"2022-09-01T13:29:43-00:00","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/virtualApplication/waas":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get Waas apps list from device","operationId":"createWaasList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Waas apps list":{"description":"Waas apps list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","version":"1.0.16_SV2.9.16.1_XE17.3","active":"true","previous":"true","timestamp":"2022-09-01T13:29:43-00:00","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/vm/nics":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get vbranch vm lifecycle state (NIC)","operationId":"getVbranchVMLifecycleNics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vBranch VM lifecycle state (NIC)":{"description":"vBranch VM lifecycle state (NIC)","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"int-mgmt-net-subnet","vnic-id":"1","network":"int-mgmt-net","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vm/notifications":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get CloudDock vm lifecycle state","operationId":"getCloudDockVMLifecycleNics","parameters":[{"name":"userGroup","in":"query","description":"userGroup Name","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudDock VM lifecycle state ":{"description":"CloudDock VM lifecycle state ","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","depname":"SystemAdminTena_isrv1_0_72619ffd-df8e-4c32-b24a-3d7b03a31303","eventTime":"600","hostname":"nfvis","type":"local","vmid":"1","vmName":"ISR","status_message":"active","status_code":"200","user-group":"router1","category":"Sample_Category_0001","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vm/oper/state":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get vbranch vm lifecycle state","operationId":"getVbranchVMLifecycle","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vBranch VM lifecycle state":{"description":"vBranch VM lifecycle state","value":{"data":[{"vdevice-dataKey":"172.16.255.15","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"int-mgmt-net-subnet","state":"Active","lastupdated":1642581869106,"vcpus":"2","memory-mb":"4096","color":"default","root-disk-mb":"8192"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vm/state":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get vm lifecycle state","operationId":"getVMLifeCycleState","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VM lifecycle state":{"description":"VM lifecycle state","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","deployment_name":"dep1","deployment_id":"SystemAdminTenantIdisrv1","name":"router1","state":"Active"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vmanage":{"get":{"tags":["Monitoring - Device Details"],"description":"Get vManage system IP","operationId":"getVManageSystemIP","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceVmanageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/voice/dspActive":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm Active DSP info from device","operationId":"getDspActive","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm Active DSP info":{"description":"DSPFarm Active DSP info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","dsp-num":2,"dsp-status":"up","rsc-id":1,"bridge-id":9,"pkts-txed":228,"pkts-rxed":119,"lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/phoneInfo":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get phone registration info from device","operationId":"getPhoneInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VOIP call info":{"description":"VOIP call info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","pool-tag":"1","id-network":"10.1.10.217","reg-state":"yes","dialpeer-tag":"100","address":"10.64.86.70","dir-number":"5550111","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/profiles":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm Profiles info from device","operationId":"getDSPFarmProfiles","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm Profiles info":{"description":"DSPFarm Profiles info","value":{"data":[{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-mtp","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"1","rsc-status":"rsc-group-state-none","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-9","rsc-provider":"rsc-prov-none","profile-id":"9","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"},{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-mtp","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"2","rsc-status":"rsc-group-state-none","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-52","rsc-provider":"rsc-prov-none","profile-id":"52","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"},{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-mtp","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"3","rsc-status":"rsc-group-state-none","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-183","rsc-provider":"rsc-prov-none","profile-id":"183","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"},{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-transcode","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"4","rsc-status":"rsc-group-state-up","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-711","rsc-provider":"rsc-prov-flex-dsprm","profile-id":"711","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/sccpCcmGroups":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm SCCP CCM Groups info from device","operationId":"getSccpCcmGroups","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm SCCP CCM Groups info":{"description":"DSPFarm SCCP CCM Groups info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","ccm-group-id":5,"description":"boston office","switchover-method":"GRACEFUL","switchback-method":"GRACEFUL_GUARD","ccm-id":1,"ccm-priority":1,"profile-id":6,"reg-name":"MTP123456789988","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/sccpConnections":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm SCCP Connections info from device","operationId":"getSccpConnections","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm SCCP Connections info":{"description":"DSPFarm SCCP Connections info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","conn-id":16777409,"sess-id":16777222,"stype":"secure-xcode","mode":"sendrecv","codec":"g729b","rmt-ipaddr":"10.3.56.120","rmt-port":"16772","src-port":"19354","dtmf-method":"enabled","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/voiceCalls":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get voice call info from device","operationId":"getVoiceCalls","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Voice call info":{"description":"Voice call info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","key-id":"0312341111","call-id":"24","voice-port-id":"1/015","codec-type":"g729r8","vad":"disabled","dsp-id":"010","dsp-type":"C549","dsp-abort-packet-cnt":0,"dsp-tx-packet-cnt":67400,"dsp-rx-packet-cnt":67400,"lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/voipCalls":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get VOIP call info from device","operationId":"getVoipCalls","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VOIP call info":{"description":"VOIP call info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","call-index":3917844,"call-setuptime":126640,"call-id":5554071,"codec":"g711ulaw","remote-ip-address":"10.128.136.58","remote-media-port":17602,"transmit-packets":2246,"receive-packets":2246,"call-duration":"00:00:50","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voiceisdninfo/isdnstatus":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Retrieve Voice ISDN Status from device","operationId":"getT1e1IsdnStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device voice ISDN status":{"description":"Device voice ISDN status","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","key-id":0,"intf-name":"Serial0:23","switch-type":"primary-5ess","l1-status":"ACTIVE","l2-status":"MULTIPLE_FRAME_ESTABLISHED","num-active-calls":1,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voicet1e1controllerinfo/current15minstats":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Retrieve T1E1 controller last 15 min stats from device (Real Time)","operationId":"getControllerT1e1InfoCurrent15MinStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"T1E1 controller status":{"description":"T1E1 controller status","value":{"data":[{"vdevice-name":"32.32.32.17","vdevice-host-name":"vm5","slot-num":"6","subslot-num":"3","port-num":"0","state":"up","type":"t1","clocking":"internal","vdevice-dataKey":"32.32.32.17-711","lcvs":136,"pcvs":63,"csss":0,"sefss":6,"less":4,"dms":0,"ess":7,"bess":1,"sess":6,"uass":458,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voicet1e1controllerinfo/totalstats":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Retrieve T1E1 controller total stats from device (Real Time)","operationId":"getControllerT1e1InfoTotalStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"T1E1 controller status":{"description":"T1E1 controller status","value":{"data":[{"vdevice-name":"32.32.32.17","vdevice-host-name":"vm5","slot-num":"6","subslot-num":"3","port-num":"0","state":"up","type":"t1","clocking":"internal","vdevice-dataKey":"32.32.32.17-711","lcvs":136,"pcvs":63,"csss":0,"sefss":6,"less":4,"dms":0,"ess":7,"bess":1,"sess":6,"uass":458,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/vpn":{"get":{"tags":["Real-Time Monitoring - VPN"],"description":"Get VPN instance list from device (Real Time)","operationId":"getVPNInstances","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPN instance list ":{"description":"VPN instance list ","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":"10","if-name":"ge0/1","ip-address":"10.0.0.2 255.255.255.0","color":"mpls","shutdown":"no shutdown","lastupdated":1660890739250,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/vrrp":{"get":{"tags":["Real-Time Monitoring - VRRP"],"description":"Get VRRP interface list from device","operationId":"getVRRPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VRRP interface":{"description":"VRRP interface","value":{"data":[{"omp-state":"up","group-id":"123","if-name":"ge0/0","virtual-mac":"00:00:5e:00:01:7b","lastupdated":1650878690993,"vpn-id":"10","vdevice-dataKey":"169.254.10.9-10-ge0/0-123","advertisement-timer":"1","last-state-change-time":"0000-00-00T00:00:00+00:00","vdevice-host-name":"vm2","vrrp-state":"init","vdevice-name":"169.254.10.9","priority":"101"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/wireless/client":{"get":{"tags":["Real-Time Monitoring - Wireless"],"description":"Get wireless clients from device","operationId":"getWirelessClients","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wireless client":{"description":"Wireless client","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","wlan-id":"1","mac-address":"24:77:03:89:9b:f8","ssid":"rf4k3ap","band":"band-24ghz","status":"0","ip-address":"192.168.1.1","device-type":"Android","vdevice-dataKey":"172.16.255.15","rssi":-51,"lastupdated":1660894960587}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/wireless/radio":{"get":{"tags":["Real-Time Monitoring - Wireless"],"description":"Get wireless Radios from device","operationId":"getWirelessRadios","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wireless Radio":{"description":"Wireless Radio","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","band":"band-24ghz","channel":11,"channel-bandwidth":"chan-bw-160mhz","client-count":110,"lastupdated":1660898493410,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/wireless/ssid":{"get":{"tags":["Real-Time Monitoring - Wireless"],"description":"Get wireless SSID from device","operationId":"getWirelessSsid","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wireless SSID":{"description":"Wireless SSID","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","wlan-id":"1","ssid":"rf4k3ap","vlan-id":1,"band":"band-24ghz","admin-up":"true","oper-up":"true","client-count":110,"max-client-count":200,"lastupdated":1660910032581,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/wlan/clients":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN client from device","operationId":"getWLANClients","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN client":{"description":"WLAN client","value":{"data":[{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","client-id":"0","mac":"50:50:50:50:50:50","mode":"802.11ac","band":"5 GHz","channel":"36","channel-bandwidth":"80","data-security":"none","rx-rate":"175","rssi":"11","assoc-time":"00:11:43","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9"},{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","client-id":"1","mac":"50:50:50:50:50:53","mode":"802.11ac","band":"5 GHz","channel":"36","channel-bandwidth":"80","data-security":"none","rx-rate":"175","rssi":"11","assoc-time":"00:11:43","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9"},{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","client-id":"2","mac":"50:50:50:50:50:56","mode":"802.11ac","band":"5 GHz","channel":"36","channel-bandwidth":"80","data-security":"none","rx-rate":"175","rssi":"11","assoc-time":"00:11:43","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/wlan/interfaces":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN interface from device","operationId":"getWLANInterfaces","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN interface":{"description":"WLAN interface","value":{"data":[{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","ssid":"tb31_pm6_5ghz_vap0","bssid":"80:b7:09:08:b7:6a","data-security":"wpa/wpa2-enterprise","mgmt-security":"optional","band":"5 GHz","mode":"802.11ac","description":"-","bit-rate":"1300","tx-power":"25","admin-status":"Up","oper-status":"Up","max-clients":"50","num-clients":"8","lastupdated":0,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/wlan/radios":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN Radios from device","operationId":"getWLANRadios","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN Radios":{"description":"WLAN Radios","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vdevice-dataKey":"169.254.10.9","radio-name":"wifi0","mode":"802.11ac","band":"5 GHz","mac":"80:b7:09:08:b7:6a","country":"United States","channel":"36","channel-bandwidth":"80","frequency":"5180","guard-interval":"400","vaps":"4","lastupdated":1658194642863}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/wlan/radius":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN RADIUS authentication from device","operationId":"getWLANRadius","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN RADIUS authentication":{"description":"WLAN RADIUS authentication","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vap-ifname":"vap1","preference":"-","ip-address":"10.20.24.15","vpn-id":"1","priority":"0","source-interface":"-","source-address":"-","tag":"tag_dummy1","vdevice-dataKey":"169.254.10.9","auth-port":"1812","auth-active":"true","auth-rtt":"0","auth-requests":"0","auth-retrans":"0","auth-accepts":"0","auth-rejects":"0","auth-challenges":"0","auth-mal-resp":"0","auth-bad-auth":"0","auth-pend-reqs":"0","auth-timeouts":"0","auth-unk-types":"0","auth-pkts-drop":"0","acct-port":"0","acct-active":"false","acct-rtt":"0","acct-requests":"0","acct-retrans":"0","acct-responses":"0","acct-mal-resp":"0","acct-bad-auth":"0","acct-pend-reqs":"0","acct-timeouts":"0","acct-unk-types":"0","acct-pkts-drop":"0","lastupdated":1658194642863}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device_authorization/{regionBaseUri}/{clientId}":{"post":{"tags":["Monitoring - SecureX Integration"],"description":"User authorization for Cisco vManage SecureX integration","operationId":"deviceAuthorization","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Codes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/diagnostics/dbschema":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get the current database schema","operationId":"getDBSchema","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DBSchema"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/diagnostics/threadpools":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get information on the threadpools","operationId":"getThreadPools","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreadpoolsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/activate":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Activate cluster to start working as primary","operationId":"activate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/clusterInfo":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery cluster info","operationId":"getClusterInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR cluster info":{"description":"DR cluster info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/dbrestore":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Signal vManage to initiate configuration-db restore operation","operationId":"restoreConfigDb","requestBody":{"description":"Config-db meta payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Config-db meta payload":{"description":"Config-db meta payload","value":{"compressed_db":"db_bkp.tar.gz","destinationIP":"10.0.1.32","replicationToken":"38400000-8cf0-11bd-b23e-10b96e4ef00d"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/dbrestorestatus":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Config-db restore status","operationId":"getConfigDBRestoreStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Config-db Restore Status":{"description":"Config-db Restore Status","value":{"currentState":"DOWNLOADING"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/deleteLocalDataCenter":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Delete local data center","operationId":"deleteLocalDC","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request status":{"description":"Request status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/deleteRemoteDataCenter":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Delete data center","operationId":"deleteDC","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request status":{"description":"Request status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/deregister":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Delete disaster recovery","operationId":"delete_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/details":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery details","operationId":"getDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR details":{"description":"DR details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/download/backup/{token}/db_bkp.tar.gz":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Downloading stats file","operationId":"download","parameters":[{"name":"token","in":"path","description":"Token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/download/{token}/{fileName}":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Download replication data","operationId":"downloadReplicationData","parameters":[{"name":"token","in":"path","description":"Token","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Property replication info":{"description":"Property replication info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/drstatus":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Disaster recovery status","operationId":"getDisasterRecoveryStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DR status":{"description":"DR status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/history":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery switchover history","operationId":"getHistory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR switchover history":{"description":"DR switchover history","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/localLatestHistory":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery local switchover history","operationId":"getLocalHistory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR local switchover history":{"description":"DR local switchover history","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/localdc":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get local data center details","operationId":"getLocalDataCenterState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Local datacenters detail":{"description":"Local datacenters detail","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/password":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update data centers and vBonds passwords for disaster recovery","operationId":"update","requestBody":{"description":"Datacenter/vBond password update request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter/vBond password update request":{"description":"Datacenter/vBond password update request","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR setting updated":{"description":"DR setting updated","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pause":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR","operationId":"pauseDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pauseLocalArbitrator":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR for Local Arbitrator","operationId":"pauseLocalArbitrator","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pauseLocalDC":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR for Local datacenter","operationId":"pauseLocalDCForDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pauseLocalReplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR replication for Local datacenter","operationId":"pauseLocalDCReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/disasterrecovery/pausereplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR data replication","operationId":"disasterRecoveryPauseReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/register":{"put":{"tags":["Configuration - Disaster Recovery"],"description":"Update data centers for disaster recovery","operationId":"update_1","requestBody":{"description":"Datacenter registration request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter registration request":{"description":"Datacenter registration request","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR setting updated":{"description":"DR setting updated","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"},"post":{"tags":["Configuration - Disaster Recovery"],"description":"Register data centers for disaster recovery","operationId":"register","requestBody":{"description":"Datacenter registration request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter registration request":{"description":"Datacenter registration request","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/remoteDcState":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Gets remote data center member state","operationId":"getRemoteDCMembersState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Remote DC member details":{"description":"Remote DC member details","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/remotePassword":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update disaster recovery information with updated password to remote data center","operationId":"updateDisasterRecoveryState_1","requestBody":{"description":"Datacenter registration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Disaster recovery information with updated password to remote data center":{"description":"Disaster recovery information with updated password to remote data center","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/remotedc":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get remote data center details","operationId":"getRemoteDataCenterState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Remote datacenters detail":{"description":"Remote datacenters detail","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"},"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update complete disaster recovery information to remote data center","operationId":"updateDisasterRecoveryState","requestBody":{"description":"Datacenter registration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter registration":{"description":"Datacenter registration","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/remotedc/swversion":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get remote data center vManage version","operationId":"getRemoteDataCenterVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage version":{"description":"vManage version","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/disasterrecovery/requestimport":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Replication Request message sent from primary","operationId":"disasterRecoveryReplicationRequest","requestBody":{"description":"DR request","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR request":{"description":"DR request","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/restartDataCenter":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Restart data center","operationId":"restartDataCenter","requestBody":{"description":"Datacenter registration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter registration":{"description":"Datacenter registration","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/schedule":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery local replication schedule","operationId":"getDisasterRecoveryLocalReplicationSchedule","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR replication schedule":{"description":"DR replication schedule","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/status":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery status","operationId":"getdrStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR status":{"description":"DR status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write,Template Deploy-read,Template Deploy-write"}},"/disasterrecovery/unpause":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR","operationId":"unpauseDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/unpauseLocalArbitrator":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR for Local Arbitrator","operationId":"unpauseLocalArbitrator","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/unpauseLocalDC":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR for Local datacenter","operationId":"unpauseLocalDCForDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/unpauseLocalReplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR replication for local datacenter","operationId":"unpauseLocalDCReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/disasterrecovery/unpausereplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Un-Pause DR data replication","operationId":"disasterRecoveryUnPauseReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/updateDRConfigOnArbitrator":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update arbitrator with primary and secondary states cluster","operationId":"updateDrState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request status":{"description":"Request status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/updateReplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update DR replication status","operationId":"updateReplication","requestBody":{"description":"Replication status","content":{"application/json":{"schema":{"type":"object"},"examples":{"Replication status":{"description":"Replication status","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/usernames":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Fetch data centers and vBonds usernames for disaster recovery","operationId":"get","requestBody":{"description":"Datacenter/vBond password update request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter/vBond password update request":{"description":"Datacenter/vBond password update request","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR setting updated":{"description":"DR setting updated","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/validateNodes":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Validate a list of nodes","operationId":"getReachabilityInfo","requestBody":{"description":"Node list","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Node list":{"description":"Node list","value":[]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Node reachability list":{"description":"Node reachability list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/entityownership/list":{"get":{"tags":["System - Cloud Service"],"description":"List all entity ownership info","operationId":"listEntityOwnershipInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Entity ownership":{"description":"Entity ownership","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/entityownership/tree":{"get":{"tags":["System - Cloud Service"],"description":"Entity ownership info grouped by buckets","operationId":"entityOwnershipInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Entity ownership":{"description":"Entity ownership","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event":{"get":{"tags":["Monitoring - Events"],"description":"Get stats raw data","operationId":"getStatDataRawData_25","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Events"],"description":"Gets lists of events along with the raw event data of each.","operationId":"getRawEventData","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Event query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Event query string":{"description":"Event query string","value":"{\n \"query\":{\n \"condition\":\"AND\",\n \"rules\":[\n {\n \"value\":[\n \"2020-05-10T01:00:00 UTC\",\n \"2020-05-10T01:30:00 UTC\"\n ],\n \"field\":\"entry_time\",\n \"type\":\"date\",\n \"operator\":\"between\"\n },\n {\n \"value\":[\n \"172.16.255.11\"\n ],\n \"field\":\"system_ip\",\n \"type\":\"string\",\n \"operator\":\"in\"\n },\n ]\n }\n}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Events":{"description":"Events","value":{"data":[{"system_ip":"172.16.255.11","vmanage_system_ip":"172.16.255.11","tenant":"default","device_type":"vedge","entry_time":1666259117528,"statcycletime":1666259117528,"eventname":"bfd-state-change","component":"BFD","severity_level":"major","host_name":"vm1","event":"{\"bfd-state-change\":{\"src-ip\":\"10.0.5.11\",\"dst-ip\":\"10.1.16.16\",\"local-system-ip\":\"172.16.255.11\",\"src-port\":12347,\"system-ip\":\"172.16.255.11\",\"dst-port\":12346,\"remote-color\":\"lte\",\"host-name\":\"vm1\",\"remote-system-ip\":\"172.16.255.16\",\"severity-level\":\"major\",\"local-color\":\"lte\",\"xmlns\":\"http://viptela.com/bfd\",\"deleted\":false,\"flap-reason\":\"na\",\"proto\":\"ipsec\",\"new-state\":\"down\"}}","details":"host-name=vm1; src-ip=10.0.5.11; dst-ip=10.1.16.16; proto=ipsec; src-port=12347; dst-port=12346; local-system-ip=172.16.255.11; local-color=lte; remote-system-ip=172.16.255.16; remote-color=lte; new-state=down; deleted=false; flap-reason=na","id":"xh_I9IMBLPMz2to0aA3r"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/event/aggregation":{"get":{"tags":["Monitoring - Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_26","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_27","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/event/app-agg/aggregation":{"post":{"tags":["Monitoring - Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_25","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/event/component/keyvalue":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve components as key/value pairs","operationId":"getComponentsAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/csv":{"get":{"tags":["Monitoring - Events"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_25","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/event/doccount":{"get":{"tags":["Monitoring - Events"],"description":"Get response count of a query","operationId":"getCount_26","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Events"],"description":"Get response count of a query","operationId":"getCountPost_26","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/enable/fileprocess":{"get":{"tags":["Monitoring - Events"],"description":"Set enable events from file flag","operationId":"enableEventsFromFile","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSchema"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/fields":{"get":{"tags":["Monitoring - Events"],"description":"Get fields and type","operationId":"getStatDataFields_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/getEventsByComponent":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve components as key/value pairs","operationId":"getEventsByComponent","parameters":[{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ComponentEventMapping"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/listeners":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve listener information","operationId":"getListenersInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/page":{"get":{"tags":["Monitoring - Events"],"description":"Get stats raw data","operationId":"getStatBulkRawData_26","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Events"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_25","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/event/query/fields":{"get":{"tags":["Monitoring - Events"],"description":"Get query fields","operationId":"getStatQueryFields_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/query/input":{"get":{"tags":["Monitoring - Events"],"description":"Create query configuration","operationId":"createEventsQueryConfig","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventQueryInputResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/severity":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve events","operationId":"findEvents","parameters":[{"name":"severity-level","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"deviceId","in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSeverityResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/severity/summary":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve severity histogram","operationId":"getSeverityHistogram","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeveritySummary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/types/keyvalue":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve event types as key/value pairs","operationId":"getEventTypesAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/featurecertificate/certificate":{"get":{"tags":["Configuration - Feature Certificate"],"description":"Get feature cert from cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getDeviceCertificate","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device feature cert":{"description":"Device feature cert","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"},"put":{"tags":["Configuration - Feature Certificate"],"description":"Upload feature cert for cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"installFeatureCertificate","requestBody":{"description":"Install feature cert request for cEdge","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature cert request":{"description":"Feature cert request"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/featurecertificate/devicecsr":{"get":{"tags":["Configuration - Feature Certificate"],"description":"Get CSR from cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getDeviceCsr","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device CSR":{"description":"Device CSR","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"},"put":{"tags":["Configuration - Feature Certificate"],"description":"Create CSR for cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"genDeviceCsr","requestBody":{"description":"CSR request for cEdge","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR request":{"description":"CSR request"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/featurecertificate/revoke":{"put":{"tags":["Configuration - Feature Certificate"],"description":"Revoke feature cert from cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"revokeFeatureCertificate","requestBody":{"description":"Revoking feature cert request for cEdge","content":{"application/json":{"schema":{"type":"object"},"examples":{"Revoking feature cert request":{"description":"Revoking feature cert request"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/featurecertificate/syslogconfig":{"get":{"tags":["Configuration - Feature Certificate"],"description":"Get Feature CA state
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getFeatureCaState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature CA state":{"description":"Feature CA state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/fedramp/dnssec/actions":{"get":{"tags":["Deployment Mode"],"description":"Request DNS-Sec actions","operationId":"requesDNSSecActions","parameters":[{"name":"action","in":"query","description":"DNS-Sec action","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DNS-Sec action status":{"description":"DNS-Sec action status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/fedramp/dnssec/config":{"post":{"tags":["Deployment Mode"],"description":"Configure DNS-Sec","operationId":"configureDNSSec","requestBody":{"description":"DNS sec config request","content":{"application/json":{"schema":{"type":"object"},"examples":{"DNS sec config request":{"description":"DNS sec config request","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,FedRamp-write"}},"/fedramp/dnssec/status":{"get":{"tags":["Deployment Mode"],"description":"Get DNS-Sec status","operationId":"getDNSSecStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DNS-Sec status":{"description":"DNS-Sec status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/fedramp/status":{"post":{"tags":["Deployment Mode"],"description":"Set network deployment mode","operationId":"configFedrampMode","requestBody":{"description":"Network deployment mode","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network deployment mode":{"description":"Network deployment mode","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,FedRamp-write"}},"/fedramp/wazuh/actions":{"get":{"tags":["Deployment Mode"],"description":"Wazuh agent action","operationId":"requestWazuhActions","parameters":[{"name":"action","in":"query","description":"Wazhuh Action","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Wazhug agent action status":{"description":"Wazhug agent action status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/fedramp/wazuh/config":{"post":{"tags":["Deployment Mode"],"description":"Configure Wazuh agent","operationId":"configureWazuhClient","requestBody":{"description":"Wazhuh configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wazhuh configuration request":{"description":"Wazhuh configuration request","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,FedRamp-write"}},"/fedramp/wazuh/status":{"get":{"tags":["Deployment Mode"],"description":"Get Wazuh agent status","operationId":"getWazuhAgentStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Wazhug agent status":{"description":"Wazhug agent status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/group":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve device group list","operationId":"listDeviceGroupList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/device":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve device groups","operationId":"listDeviceGroups","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/devices":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve devices in group","operationId":"listGroupDevices","parameters":[{"name":"groupId","in":"query","schema":{"type":"string"}},{"name":"ssh","in":"query","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/map/devices":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve group devices for map","operationId":"listGroupDevicesForMap","parameters":[{"name":"groupId","in":"query","schema":{"$ref":"#/components/schemas/GroupId"}},{"name":"vpnId","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/map/devices/links":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve devices in group for map","operationId":"listGroupLinksForMap","parameters":[{"name":"groupId","in":"query","schema":{"$ref":"#/components/schemas/GroupId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/health/devices":{"get":{"tags":["Monitoring - Health"],"description":"get the devices health properties","operationId":"getDevicesHealth","parameters":[{"name":"page","in":"query","description":"Page Number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Page Size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Sort By Property","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Sort Order","schema":{"type":"string"}},{"name":"startingDeviceId","in":"query","description":"Optional device ID to start first page","schema":{"type":"string"}},{"name":"siteId","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}},{"name":"group_id","in":"query","description":"Optional group ID to filter devices","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"Optional group ID to filter devices","schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}},{"name":"reachable","in":"query","schema":{"type":"boolean"}},{"name":"controlStatus","in":"query","schema":{"type":"string"}},{"name":"personality","in":"query","schema":{"type":"string"}},{"name":"health","in":"query","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID list to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices health properties":{"description":"devices health properties","value":{"total_devices":3,"devices":[{"name":"vm3","personality":"vedge","uuid":"04a116f8-9a16-4bf6-9f1f-f58e2619312d","reachability":"reachable","longitude":"-122.777023","latitude":"37.666684","health":"green","qoe":10,"location":"lat: 37.666684, long: -122.777023","site_id":"3","system_ip":"169.254.10.10","device_type":"vedge","local_system_ip":"172.16.254.2","device_model":"vEdge Cloud","software_version":"20.6.0-231","cpu_load":1.32,"memory_utilization":25.0,"control_connections":3,"control_connections_up":3,"sdra_ipsec_anyconnect":120,"sdra_ipsec_soho":60,"sdra_ipsec_unknown":30,"sdra_sslvpn_anyconnect":0,"has_geo_data":true,"uptime_date":1629963840000,"device_groups":["No groups"],"connected_vmanages":["169.254.10.3"],"bfd_sessions_up":5,"bfd_sessions":5,"omp_peers":2,"omp_peers_up":2,"board_serial_number":"12345708","chassis_number":"04a116f8-9a16-4bf6-9f1f-f58e2619312d","vpn_ids":null}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/health/devices/overview":{"get":{"tags":["Monitoring - Health"],"description":"gets devices health overview","operationId":"getDevicesHealthOverview","parameters":[{"name":"vpn_id","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices health overview":{"description":"devices health overview","value":{"good":3,"fair":3,"poor":0}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/hsec/activate":{"post":{"tags":["Hsec Activate"],"description":"Activate Hsec licenses on devices","operationId":"activateHsecLicenses","requestBody":{"description":"Tenant List","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant List":{"description":"Tenant List","value":[]}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-write"}},"/hsec/assign":{"post":{"tags":["HSEC License"],"description":"hsec ","operationId":"hsecassign","requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/assignSlac":{"post":{"tags":["HSEC"],"description":"Assign Hsec License to devices from uploaded SLAC file","operationId":"assignSlac","requestBody":{"description":"SLAC File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/uploadHSECAuthFile"},"examples":{"License":{"description":"License","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device":{"description":"Device","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write"}},"/hsec/devices":{"get":{"tags":["HSEC"],"description":"Give list of HSEC license devices","operationId":"device Summmary_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/devices/install":{"get":{"tags":["HSEC"],"description":"Give list of HSEC license devices","operationId":"device Summmary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/download":{"post":{"tags":["HSEC"],"description":"Download SLAC Request file for CSSM","operationId":"downloadSlacRequestFile","requestBody":{"description":"Device List","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device":{"description":"Device","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device":{"description":"Device","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write"}},"/hsec/fetchaccounts":{"get":{"tags":["HSEC"],"description":"Authenticate User and Sync Licenses","operationId":"fetchSAVAAccounts","parameters":[{"name":"username","in":"query","schema":{"type":"string"}},{"name":"pwd","in":"query","schema":{"type":"string"}},{"name":"mode","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["HSEC"],"description":"Authenticate User and Sync Licenses","operationId":"fetchAccounts_1","requestBody":{"description":"Hsec License sync request payload","content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/uploadAuth":{"post":{"tags":["HSEC"],"description":"upload SLAC File and fetch device summary","operationId":"uploadSlacFile","requestBody":{"description":"SLAC File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/uploadHSECAuthFile"},"examples":{"License":{"description":"License","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device":{"description":"Device","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write"}},"/ise/connect":{"get":{"tags":["Configuration - Ise Server"],"description":"test connection to ise instance","operationId":"connect_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials":{"get":{"tags":["Configuration - Ise Server"],"description":"Get Ise server credentials","operationId":"getIseServerCredentials","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IseServer"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Ise Server"],"description":"update Ise server credentials","operationId":"updateIseServerCredentials","requestBody":{"description":"Ise Server with possibly new values for properties","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IseServer"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Ise Server"],"description":"Add Ise server credentials","operationId":"addIseServerCredentials","requestBody":{"description":"Ise Server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IseServer"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/iseandpxgrid":{"delete":{"tags":["Configuration - Ise Server"],"description":"Delete PxGrid and Ise information on vManage. Also Deletes PxGrid Client on ISE","operationId":"deleteIseAndPxGridAccount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/pxgrid":{"get":{"tags":["Configuration - Ise Server"],"description":"Get PxGrid account","operationId":"getPxGridAccount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PxGridInfo"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Ise Server"],"description":"Delete PxGrid account information","operationId":"deletePxGrid","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/pxgrid/cert":{"get":{"tags":["Configuration - Ise Server"],"description":"Retrieves Pxgrid Certificate","operationId":"getPxgridCert","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Cert":{"description":"Cert","value":"-----BEGIN CERTIFICATE-----\r\nMIIF7zCCA9egAwIBAgIQZiToABE+v71LjsuIg3EjqTANBgkqhkiG9w0BAQ0FADCB\r\niTELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNh\r\nbiBKb3v/3QMfoLFz004vv7vBf4VcpQQ8Bc\r\nTATYW0iy5jt+YNgvZj2HjYiOhwpMalGqlhBJMgljgNmupReAccQyw01hbPIG9vBK\r\nxWMSk/AFVb1Ctv7Q3MUV/1mZyTM14TUZbtDd1/lxIHBR7LKhMJqcjOOcNBFlkdXO\r\n6BaP2RPL6dw2x92ddnRtzpAPfx2c1R51rELPpenX0SNLoS0=\r\n-----END CERTIFICATE-----\r\n"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/vsmart/sync":{"post":{"tags":["Configuration - Ise Server"],"description":"sync pxgrid and ise config with vSmarts","operationId":"syncVsmart","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VsmartSyncResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/pxgrid/activate":{"post":{"tags":["Configuration - Ise Server"],"description":"pxGrid Account Activate","operationId":"accountActivate","requestBody":{"description":"description for pxgrid node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/pxgrid/approve":{"put":{"tags":["Configuration - Ise Server"],"description":"pxGrid Account Approve","operationId":"approve","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/pxgrid/create":{"post":{"tags":["Configuration - Ise Server"],"description":"pxGrid Account Create","operationId":"accountCreate","requestBody":{"description":"name for pxgrid node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/localization/supportedLocales":{"get":{"tags":["Locale"],"description":"Get Supported locales","operationId":"Get Supported locales","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"locales":[{"code":"en_US","displayName":"English (US)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/attachDevices/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP attached devices","operationId":"Retrieve MDP attached devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Multidomain Policy"],"description":"Edit attached devices","operationId":"Edit attached devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"deviceList","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices":{"description":"devices","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Multidomain Policy"],"description":"Share devices with MDP","operationId":"Attach devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"deviceList","content":{"application/json":{"schema":{"type":"object"},"examples":{"Devices":{"description":"Devices","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/detachDevices/{nmsId}":{"post":{"tags":["Configuration - Multidomain Policy"],"description":"Disconnect devices from mpd controller","operationId":"Detach devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"deviceList","content":{"application/json":{"schema":{"type":"object"},"examples":{"Onboard":{"description":"Onboard","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/devices/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP supported devices","operationId":"Retrieve MDP supported devices ","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/disconnect/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"disconnect from mpd controller","operationId":"disconnect from mdp","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"status":{"description":"status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/onboard":{"post":{"tags":["Configuration - Multidomain Policy"],"description":"Start MDP onboarding operation","operationId":"onboardMDP","requestBody":{"description":"Onboard","content":{"application/json":{"schema":{"type":"object"},"examples":{"onboarding-payload":{"description":"onboarding-payload","value":{"controllerUUID":"fc335c24-fb30-46bb-81ff-fda84264eb58","name":"sdwane2e","description":"sdwan24","requestStream":"request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","responseStream":"response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","otp":"CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0","uri":"10.10.10.1:24038"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"nmsId":{"description":"nmsId","value":{"nmsId":"fc335c24-fb30-46bb-81ff-fda84264eb58"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/onboard/status":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Get MDP onboarding status","operationId":"Get MDP onboarding status","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"status":"completed"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/onboard/{nmsId}":{"put":{"tags":["Configuration - Multidomain Policy"],"description":"update MDP onboarding document","operationId":"updateOnboardingPayload","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Onboard","content":{"application/json":{"schema":{"type":"object"},"examples":{"onboarding-payload":{"description":"onboarding-payload","value":{"controllerUUID":"fc335c24-fb30-46bb-81ff-fda84264eb58","name":"sdwane2e","description":"sdwan24","requestStream":"request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","responseStream":"response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","otp":"CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0","uri":"10.10.10.1:24038"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"nmsId":{"description":"nmsId","value":{"nmsId":"fc335c24-fb30-46bb-81ff-fda84264eb58"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"},"delete":{"tags":["Configuration - Multidomain Policy"],"description":"offboard the mdp application","operationId":"offboard","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/policies/mdpconfig":{"put":{"tags":["Configuration - Multidomain Policy"],"description":"Add internal policy from vmanage","operationId":"addInternalPolicy","requestBody":{"description":"addInternalPolicy","content":{"application/json":{"schema":{"type":"object"},"examples":{"mdpConfig-payload":{"description":"mdpConfig-payload","value":{"controllerUUID":"fc335c24-fb30-46bb-81ff-fda84264eb58","name":"sdwane2e","description":"sdwan24","requestStream":"request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","responseStream":"response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","otp":"CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0","uri":"10.10.10.1:24038"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"deviceId":{"description":"deviceId","value":{"deviceId":"fc335c24-fb30-46bb-81ff-fda84264eb58"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/policies/mdpconfig/{deviceId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP ConfigObject","operationId":"Retrieve MDP ConfigObject","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"MdpConfig":{"description":"MdpConfig","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/policies/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP policies","operationId":"Retrieve MDP policies","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policies":{"description":"Policies","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Multidomain Policy"],"description":"update policy status","operationId":"update policy status","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"policyList","content":{"application/json":{"schema":{"type":"object"},"examples":{"policies":{"description":"policies","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/messaging/device/vmanage":{"get":{"tags":["Device - Messaging"],"description":"Create device vManage connection list","operationId":"createDeviceVmanageConnectionList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MessagingResp"}},"examples":{"Connection list":{"description":"Connection list","value":[{"deviceIP":"172.16.255.26","vmanages":["172.16.255.22"]}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/monitor/sdavccloudconnector/domain":{"get":{"tags":["SD AVC Domain-based App Rules"],"description":"Get SD_AVC App Rules based on Domain for O365","operationId":"getCloudConnectorDomainAppRules","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAVCCloudConnector"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/monitor/sdavccloudconnector/ipaddress":{"get":{"tags":["SD AVC IP Address based App Rules"],"description":"Get SD_AVC App Rules based on IP Address for O365","operationId":"getCloudConnectorIpAddressAppRules","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAVCCloudConnector"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/monitor/sdavccloudconnector/webex":{"get":{"tags":["SD AVC Webex App Rules"],"description":"Get SD_AVC App Rules for Webex","operationId":"getWebexAppData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SDAVCCloudConnector"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/devices":{"get":{"tags":["MSLA"],"description":"Retrieve list of devices and their subscription information","operationId":"getMSLADevices","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMslaDevicesPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MSLA"],"description":"Release licenses assigned to the devices","operationId":"releaseLicenses","requestBody":{"description":"List of devices for unassigning licenses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseLicensesRequest"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/licenses/sync":{"post":{"tags":["MSLA"],"description":"Retrieve MSLA subscription/licenses","operationId":"syncLicenses_2","requestBody":{"description":"Sync license","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sync license":{"description":"Sync license","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription license":{"description":"Subscription license","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-write"}},"/msla/monitoring/licensedDeviceCount":{"get":{"tags":["MSLA"],"description":"get license and device count","operationId":"get license and device count","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-read"}},"/msla/monitoring/licensedDistributionDetails":{"get":{"tags":["MSLA"],"description":"get license and device count","operationId":"get license and device count_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-read"}},"/msla/monitoring/packagingDistributionDetails":{"get":{"tags":["MSLA"],"description":"get packaging distribution details","operationId":"get packaging distribution details","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-read"}},"/msla/template":{"get":{"tags":["MSLA"],"description":"Retrieve all MSLA template","operationId":"getAllTemplate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-read"}},"/msla/template/licenses":{"post":{"tags":["MSLA"],"description":"Retrieve MSLA subscription/licenses","operationId":"getSubscriptions","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-write"}},"/msla/va/License":{"get":{"tags":["MSLA"],"description":"Retrieve MSLA subscription/licenses","operationId":"getSubscriptions_1","parameters":[{"name":"virtual_account_id","in":"query","description":"virtual_account_id","schema":{"type":"string"}},{"name":"licenseType","in":"query","description":"licenseType","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-read"}},"/multicloud/accounts":{"get":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"getAllCloudAccounts","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayEnabled","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetAccounts"}},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Accounts"],"description":"Add Cloud Account","operationId":"validateAccountAdd","requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccounts"},"examples":{"GCP Add Account request":{"description":"GCP Add Account request","value":[{"accountName":"pp-gcp","cloudGatewayEnabled":true,"cloudType":"GCP","description":"pp-test","gcpCredentials":{"value":{"auth_provider_x509_cert_url":"https://www.googleapis.com/test","auth_uri":"https://accounts.google.com/test","client_email":"gcp-pp@gcp.com","client_id":"1234","client_x509_cert_url":"https://www.googleapis.com/test","private_key":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCw7wLu5GWUYwV5\nA/NFvjXpz8fz2NpF2eBjC+6rLO4qxjxzXcZUGwsAFwzwT52n4D0WpLlSJNZOCtcSkK5beoPXUdPBd\nSTwn7uIrt5459tdsdfYkOIc=\n-----END PRIVATE KEY-----\n","private_key_id":"45678","project_id":"gcp-ppp-21471","token_uri":"https://oauth2.googleapis.com/test","type":"service_account"}},"serviceDiscoveryEnabled":false}]},"AWS Iam/AWS Iam GovCloud Add Account request":{"description":"AWS Iam/AWS Iam GovCloud Add Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsIamCredentials":{"roleArn":"arn101","externalId":"ext101"}}]},"AWS key/AWS key GovCloud Add Account request":{"description":"AWS key/AWS key GovCloud Add Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsKeyCredentials":{"apiKey":"key102","secretKey":"skey102"},"cloudGatewayEnabled":"true"}]},"Azure/Azure GovCloud Add Account request":{"description":"Azure/Azure GovCloud Add Account request","value":[{"cloudType":"AZURE","accountName":"azure_acct_102","description":"azure_acct_102 desc","azureCredentials":{"subscriptionId":"sub103","secretKey":"skey103","clientId":"clientid103","cloudTenantId":"clienttenant103"},"cloudGatewayEnabled":"true","azO365Enabled":"true"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccountsResponse"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/accounts/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get all Multicloud edge accounts","operationId":"getEdgeAccounts","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge accounts":{"description":"Edge accounts"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Authenticate edge account credentials","operationId":"validateEdgeAccountAdd","requestBody":{"description":"Multicloud edge account info","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Account info":{"description":"Edge Account info"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/accounts/edge/{accountId}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get edge account by account Id","operationId":"getEdgeAccountDetails","parameters":[{"name":"accountId","in":"path","description":"Edge Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Multicloud edge account","operationId":"updateEdgeAccount","parameters":[{"name":"accountId","in":"path","description":"Multicloud Edge Account Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud edge account info","content":{"application/json":{"schema":{"type":"object"},"examples":{"Account info":{"description":"Account info"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete edge account","operationId":"deleteEdgeAccount","parameters":[{"name":"accountId","in":"path","description":"Edge Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/accounts/edge/{accountId}/credentials":{"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Multicloud edge account credential","operationId":"validateEdgeAccountUpdateCredentials","parameters":[{"name":"accountId","in":"path","description":"Multicloud Edge Account Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud edge account info","content":{"application/json":{"schema":{"type":"object"},"examples":{"Account info":{"description":"Account info"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/accounts/{accountId}":{"get":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"getCloudAccountDetails","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccounts"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"updateAccount","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutAccounts"},"examples":{"GCP Update Account request":{"description":"GCP Update Account request","value":{"accountName":"priypat3-gcp-01","description":"priypat3-individual","serviceDiscoveryEnabled":false,"accountId":"gcp-priypat3gcp01-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"cloudType":"GCP"}},"AWS/AWS GovCloud Update Account request":{"description":"AWS/AWS GovCloud Update Account request","value":{"accountId":"123aws","accountName":"pp-aws","cloudGatewayEnabled":"true","cloudType":"AWS","description":"pp-aws"}},"Azure/Azure GovCloud Update Account request":{"description":"Azure/Azure GovCloud Update Account request","value":{"accountId":"123abcc","accountName":"pp-azure","cloudGatewayEnabled":"true","cloudType":"AZURE","description":"pp-azure"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"deleteAccount","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/accounts/{accountId}/credentials":{"put":{"tags":["MultiCloud - Accounts"],"description":"Update Cloud Account Credentials","operationId":"validateAccountUpdateCredentials","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccounts"},"examples":{"GCP Update Account request":{"description":"GCP Update Account request","value":[{"accountName":"pp-gcp","cloudGatewayEnabled":true,"cloudType":"GCP","description":"pp-test","gcpCredentials":{"value":{"auth_provider_x509_cert_url":"https://www.googleapis.com/test","auth_uri":"https://accounts.google.com/test","client_email":"gcp-pp@gcp.com","client_id":"1234","client_x509_cert_url":"https://www.googleapis.com/test","private_key":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCw7wLu5GWUYwV5\nA/NFvjXpz8fz2NpF2eBjC+6rLO4qxjxzXcZUGwsAFwzwT52n4D0WpLlSJNZOCtcSkK5beoPXUdPBd\nSTwn7uIrt5459tdsdfYkOIc=\n-----END PRIVATE KEY-----\n","private_key_id":"45678","project_id":"gcp-ppp-21471","token_uri":"https://oauth2.googleapis.com/test","type":"service_account"}},"serviceDiscoveryEnabled":false}]},"AWS Iam/AWS Iam GovCloud Update Account request":{"description":"AWS Iam/AWS Iam GovCloud Update Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsIamCredentials":{"roleArn":"arn101","externalId":"ext101"}}]},"AWS key/AWS key GovCloud Update Account request":{"description":"AWS key/AWS key GovCloud Update Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsKeyCredentials":{"apiKey":"key102","secretKey":"skey102"},"cloudGatewayEnabled":"true"}]},"Azure/Azure GovCloud Update Account request":{"description":"Azure/Azure GovCloud Update Account request","value":[{"cloudType":"AZURE","accountName":"azure_acct_102","description":"azure_acct_102 desc","azureCredentials":{"subscriptionId":"sub103","secretKey":"skey103","clientId":"clientid103","cloudTenantId":"clienttenant103"},"cloudGatewayEnabled":"true","azO365Enabled":"true"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccountsResponse"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\", \n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/audit":{"get":{"tags":["MultiCloud - General"],"description":"Call an audit with dry run","operationId":"auditDryRun","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudRegion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"In Sync":{"description":"In Sync","value":{"auditStatus":"IN_SYNC","canFix":true,"auditReport":[]}},"Out Of Sync":{"description":"Out Of Sync","value":{"auditStatus":"OUT_OF_SYNC","canFix":true,"auditReport":[{"status":"IN_SYNC","reportType":"GCR","region":"us-west1","name":"S2C_GCR","details":[]},{"status":"IN_SYNC","reportType":"GCR","region":"us-west1","name":"S2S_GCR","details":[]},{"status":"IN_SYNC","reportType":"CGW_ROUTER","region":"global","details":[]},{"status":"IN_SYNC","reportType":"HOSTVPC","region":"global","details":[]},{"status":"IN_SYNC","reportType":"NCC_HUB","region":"global","name":"s2c-hub","details":[]},{"status":"OUT_OF_SYNC_DRY_RUN","reportType":"NCC_HUB","region":"global","name":"s2s-hub","details":["Spoke s2s-spoke in region us-west1 is missing."]},{"status":"IN_SYNC","reportType":"MAPPING","details":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - General"],"description":"Call an audit","operationId":"audit","requestBody":{"description":"Audit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditFix"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Billing Accounts","operationId":"getEdgeBillingAccounts","parameters":[{"name":"edgeType","in":"path","description":"Interconnect Provider","required":true,"schema":{"type":"string","enum":["EQUINIX"]}},{"name":"edgeAccountId","in":"path","description":"Interconnect Provider Account ID","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Billing Accounts":{"description":"Edge Billing Accounts","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/cloudRoutersAndAttachments":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get all Cloud Routers and their Attachments","operationId":"getCloudRoutersAndAttachments","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}},{"name":"network","in":"query","description":"Network","schema":{"type":"string"}},{"name":"connectivityGatewayName","in":"query","description":"Connectivity Gateway Name","schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","description":"Cloud Gateway Name","schema":{"type":"string"}},{"name":"state","in":"query","description":"State","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud Router":{"description":"Cloud Router","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/cloudgateway":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateways","operationId":"getCgws","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"accountId","in":"query","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","schema":{"type":"string"}},{"name":"connectivityState","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudGatewayListResponse"}},"examples":{"Azure Cgw list":{"description":"Azure Cgw list","value":[{"resourceGroupName":"azure-rgp","cloudGatewayName":"az-test","accountName":"ramL","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"virtualRouterAsn":"65515","vhubName":"az-test","description":"","vwanName":"azure-vwan","connectivityStateUpdateTs":1655141135729,"accountId":"8b188c39-f358-4db6-a44f-84068541233a","cloudGatewayId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","cloudType":"AZURE","customSettings":false,"region":"westus2","connectivityState":"initialized","cloudGatewaySolution":"vhub","settings":{"softwareImageId":"17.6.01","skuScaleUnit":2,"ipSubnetPool":"10.0.0.0/16","instanceSize":2},"status":"normal","vpns":[],"connectedSites":1}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - CloudGateway"],"description":"Create cloud gateway","operationId":"createCgw","requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudGatewayPost"},"examples":{"GCP CGW Create request":{"description":"GCP CGW Create request","value":{"accountId":"gcp-project-nprd-312512","cloudType":"GCP","region":"us-west4","cloudGatewayName":"gcp-test","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"GCP post request","s2sPermitted":false,"mrfRouterRole":"border","siteName":"SITE_1"}},"AWS/AWS GovCloud CGW create request":{"description":"AWS/AWS GovCloud CGW create request","value":"{\n \"accountId\": \"238112874124\",\n \"cloudType\": \"AWS\",\n \"region\": \"us-east-1\",\n \"cloudGatewayName\": \"aws-test\",\n \"mrfRouterRole\": \"border\",\n \"siteName\": \"SITE_1\"\n \"devices\": [\n \"C8K-2F69B355-2B3D-2801-EB48-F44789422299\",\n \"C8K-53349F28-AB44-70C5-260B-096581250519\"\n ],\n \"description\": \"AWS/AWS_GOVCLOUD post request\"\n}"},"Azure/Azure GovCloud CGW create request":{"description":"Azure/Azure GovCloud CGW create request","value":{"accountId":"81k99acb9-1a58-b3b6-214f-840623g789a0","cloudType":"AZURE","region":"westus2","cloudGatewayName":"azure-test","mrfRouterRole":"border","siteName":"SITE_1","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"AZURE/AZURE_GOVCLOUD post request","azureProperties":{"resourceGroupName":"azureTestRGP","resourceGroupSource":"azure","vwanName":"azureTestVwan","vwanSource":"azure","vhubName":"azureTestVhub","vhubSource":"toBeCreated","nvaSource":"toBeCreated"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get NVA Security Rules","operationId":"getNvaSecurityRules","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NvaRulesResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - CloudGateway"],"description":"Update NVA Security Rules","operationId":"updateNvaSecurityRules","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update NVA security Rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NvaRulesListRequest"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/nvas":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Network Virtual Appliances","operationId":"getAzureNetworkVirtualAppliances","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AZURE","AZURE_GOVCLOUD"]}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]}},{"name":"vhubName","in":"query","required":true,"schema":{"type":"string"}},{"name":"vhubSource","in":"query","required":true,"schema":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NvasResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/nvasku":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get Azure NVA SKUs","operationId":"getAzureNvaSkuResources","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AZURE","AZURE_GOVCLOUD"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NvaSkuListResponse"},"examples":{"NVA Skus":{"description":"NVA Skus","value":[{"accountId":"112948124124","accountName":"test_account_name","cloudType":"AZURE","nvaSkuId":"ciscosdwan","nvaSkuName":"ciscosdwan","versionList":[["17.4.20201218","17.6.01","17.7.01"]],"scaleValueList":[[{"scaleUnit":10,"instanceType":"Standard_D4_v2","instanceCount":2},{"scaleUnit":2,"instanceType":"Standard_D4_v2","instanceCount":2},{"scaleUnit":4,"instanceType":"Standard_D4_v2","instanceCount":2}]]}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/resource":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Resource of CGW","operationId":"getCgwOrgResources","parameters":[{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CgwResourceResponse"}},"examples":{"Get CGW Resource":{"description":"Get CGW Resource","value":{"resourceType":"CGW","resourceId":"/subscriptions/9b188cb9-f358-4db6-a44f-8406854789a0/resourceGroups/uxtestrg","creationDate":"Not-Available","details":{"vwanName":"uxabc","vhubName":"AzureCGW","devices":[{"uuid":"C8K-f64c775a-f93a-4c6b-ac54-57448bdc304b","publicIp":"[1.2.193.149]"},{"uuid":"C8K-f64ca-f93a-4c6b-ac54-57448bdc304b","publicIp":"[13.78.223.149]"}],"virtualRouterAsn":"65275"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/resourceGroups":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Resource Groups","operationId":"getAzureResourceGroups","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AZURE","AZURE_GOVCLOUD"]}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceGroupsResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vhubs":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Virtual HUBs","operationId":"getAzureVirtualHubs","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AZURE","AZURE_GOVCLOUD"]}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]}},{"name":"vwanName","in":"query","required":true,"schema":{"type":"string"}},{"name":"vwanSource","in":"query","required":true,"schema":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VhubsListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vnetsNoofAttached":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Virtual HUBs","operationId":"getAzureVirtualVnetsAttached","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsVnetAttached"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vwans":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Virtual WANS","operationId":"getAzureVirtualWans","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AZURE","AZURE_GOVCLOUD"]}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VwanListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/{cloudGatewayName}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway by name","operationId":"getCgwDetails","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudGatewayAdjusted"},"examples":{"Get GCP CGW ":{"description":"Get GCP CGW ","value":{"cloudGatewayName":"gcp-test","accountName":"gcp-dev","devices":["C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1","C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B","C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"description":"","cloudProviderMgmtReference":"NA","connectivityStateUpdateTs":1654905819730,"s2sPermitted":true,"accountId":"gcp-project-nprd-31900","cloudProviderAsn":0,"sshKeyName":"","tunnelCidrBlocks":[],"cloudGatewayId":"s2c-hub-gcp-test, s2s-hub-gcp-test","cloudType":"GCP","customSettings":true,"cloudGatewaySolution":"gcp","region":"us-west4","connectivityState":"Successful","routeTableCount":"NA","settings":{"softwareImageId":"cisco-c8k-17-05-01a-cisco-public","instanceSize":"n1-standard-4","ipSubnetPool":"10.0.0.0/16","networkTier":"STANDARD"},"status":"error","vpns":[{"vpnId":"9"}],"connectedSites":0,"tunnels":[{"tunnelId":"C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}]}},"Get AWS/AWS GovCloud CGW ":{"description":"Get AWS/AWS GovCloud CGW ","value":{"cloudGatewayName":"aws-test","accountName":"aws-dev","devices":["C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C","C8K-C516558F-45CA-3486-38FD-5D0306E05999"],"description":"","cloudProviderMgmtReference":"","connectivityStateUpdateTs":1655144961158,"accountId":"759589527992","cloudProviderAsn":64520,"tunnelCidrBlocks":[],"cloudGatewayId":"tgw-0b6ac1173825c3663","cloudType":"AWS","customSettings":true,"cloudGatewaySolution":"tgw_tvpc","region":"us-east-1","connectivityState":"Successful","routeTableCount":"2","settings":{"softwareImageId":"Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4","instanceSize":"c5.large","ipSubnetPool":"11.0.0.0/16"},"status":"normal","vpns":[{"vpnId":"9"}],"connectedSites":2,"tunnels":[{"tunnelId":"C8K-C516558F-45CA-3486-38FD-5D0306E05999::9","tunnelInnerIps":["169.254.0.12/30","169.254.0.16/30"],"status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C::9","tunnelInnerIps":["169.254.0.4/30","169.254.0.8/30"],"status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}]}},"Get Azure/Azure GovCloud CGW":{"description":"Get Azure/Azure GovCloud CGW","value":{"resourceGroupName":"azure-rgp","cloudGatewayName":"az-test","accountName":"ramL","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"virtualRouterAsn":"65515","vhubName":"az-test","description":"","vwanName":"azure-vwan","connectivityStateUpdateTs":1655141135729,"accountId":"8b188c39-f358-4db6-a44f-84068541233a","cloudGatewayId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","cloudType":"AZURE","customSettings":false,"region":"westus2","connectivityState":"initialized","cloudGatewaySolution":"vhub","settings":{"softwareImageId":"17.6.01","skuScaleUnit":2,"ipSubnetPool":"10.0.0.0/16","instanceSize":2},"status":"normal","vpns":[],"connectedSites":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - CloudGateway"],"description":"Update cloud gateway","operationId":"updateCgw","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCgw"},"examples":{"GCP CGW CGW update":{"description":"GCP CGW CGW update","value":{"cloudType":"GCP","accountId":"gcp-project-nprd-31900","region":"us-west4","s2sPermitted":true,"mrfRouterRole":"border","deviceChanges":{"devicesAdded":["C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"devicesDeleted":[]}}},"AWS/AWS GovCloud CGW update":{"description":"AWS/AWS GovCloud CGW update","value":{"cloudType":"AWS","mrfRouterRole":"border","settings":{"tunnelCount":3}}},"AZURE/AZURE GovCloud CGW update":{"description":"AZURE/AZURE GovCloud CGW update","value":{"cloudType":"AZURE","accountId":"8b188c39-f358-4db6-a44f-84068541233a","region":"westus2","cloudGatewayName":"az-test","mrfRouterRole":"border","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-D4821270-27FF-A1B0-B902-12A321E3A550"],"description":"","resourceGroupName":"test-resource-group","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","settings":{"cloudType":"AZURE","name":"AZURE_CUSTOM_SETTINGS","ipSubnetPool":"10.0.0.0/16","skuScaleUnit":4,"softwareImageId":"17.6.01"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["MultiCloud - CloudGateway"],"description":"Delete cloud gateway","operationId":"deleteCgw","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}},{"name":"deleteAllResources","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/{cloudGatewayName}/site":{"get":{"tags":["MultiCloud - BranchConnect"],"description":"Get sites attached to CGW","operationId":"getCgwAttachedSites","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}},{"name":"systemIp","in":"query","schema":{"type":"string"}},{"name":"siteId","in":"query","schema":{"type":"string"}},{"name":"color","in":"query","schema":{"type":"string"}},{"name":"vpnTunnelStatus","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSitesResponse"},"examples":{"Sites":{"description":"Sites","value":{"uuid":"C8K-a165f574-e75e-11ec-8fea-0242ac120002","siteId":"10","hostname":"Branch-10","systemIp":"1.1.1.10","interface":"GigabitEthernet2","color":"red","privateIp":"10.11.2.248","publicIp":"3.109.26.54","attached":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - BranchConnect"],"description":"Update tunnel scaling and accelerated vpn parameter for a branch endpoint","operationId":"tunnelScaling","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Site Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelScallingRequestPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - BranchConnect"],"description":"Attach sites to Cloud Gateway","operationId":"attachSites","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Site Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachSitesRequestPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["MultiCloud - BranchConnect"],"description":"Detach sites from cloud gateway","operationId":"detachSites_1","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Site Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachSitesRequestPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateways/{cloudType}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get sites with connectivity to the cloud by cloud type","operationId":"getCloudGateways","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudGatewayListResponse"}},"examples":{" List of CGWs per cloudType ":{"description":" List of CGWs per cloudType ","value":[{"cloudGatewayName":"gcp-test","cloudGatewayId":"s2c-hub-gcptest, s2s-hub-gcptest","description":"","cloudType":"GCP","accountId":"gcp-project-nprd-31900","accountName":"gcp-dev","region":"us-west2","customSettings":true,"status":"normal"},{"cloudGatewayName":"gcp-test-west-4","cloudGatewayId":"s2c-hub-gcptest, s2s-hub-gcptest","description":"","cloudType":"GCP","accountId":"gcp-project-nprd-3190","accountName":"gcp-dev","region":"us-west4","customSettings":true,"status":"normal"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgatewaysetting/{cloudGatewayName}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway custom setting by cloud gateway name","operationId":"getCgwCustomSettingDetails","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSettings"},"examples":{"GCP Custom Custom Settings":{"description":"GCP Custom Custom Settings","value":{"cloudType":"GCP","instanceSize":"n1-standard-4","cgwCustomSettingName":"GCP_CUSTOM_SETTING_gcp-test","networkTier":"STANDARD","ipSubnetPool":"10.0.0.0/16","softwareImageId":"cisco-c8k-17-05-01a-cisco-public"}},"AWS/AWS_GOVCLOUD Custom Settings":{"description":"AWS/AWS_GOVCLOUD Custom Settings","value":{"cloudType":"AWS","ipSubnetPool":"10.0.0.0/16","instanceSize":"c5.large","cgwCustomSettingName":"AWS_CUSTOM_SETTING_aws-test","softwareImageId":"Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4"}},"AZURE/AZURE_GOVCLOUD Custom Settings":{"description":"AZURE/AZURE_GOVCLOUD Custom Settings","value":{"cloudType":"AZURE","ipSubnetPool":"10.0.0.0/16","skuScaleUnit":2,"cgwCustomSettingName":"AZURE_CUSTOM_SETTING_azure-test","softwareImageId":"17.6.01"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgatewaytype":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway types for specified cloudType","operationId":"getCgwTypes","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/connected-sites/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get sites with connectivity to the interconnect gateways by edge type","operationId":"getCloudConnectedSites_1","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Interconnect Gateway Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect connected sites":{"description":"Interconnect connected sites","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/connected-sites/{cloudType}":{"get":{"tags":["MultiCloud - General"],"description":"Get sites with connectivity to the cloud by cloud type","operationId":"getCloudConnectedSites","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectedSitesResponse"},"examples":{"Connected Device list":{"description":"Connected Device list","value":[{"uuid":"C8K-CA0D4066-0011-5A4E-D2F9-0F5E77BE2091","host-name":"gcp2","system-ip":"6.6.2.2","local-system-ip":"6.6.2.2","site-id":"5","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655169353069,"version":"17.06.02.0.2786","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"},{"uuid":"C8K-A24CE0EB-D7D4-6920-0129-F7BAB204252C","host-name":"gcp1","system-ip":"6.6.1.1","local-system-ip":"6.6.1.1","site-id":"5","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655166680400,"version":"17.06.02.0.2786","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"},{"uuid":"C8K-D4821270-27FF-A1B0-B902-12A321E3A550","host-name":"az1","system-ip":"5.1.5.5","local-system-ip":"5.1.5.5","site-id":"5","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655170239795,"version":"17.06.01a.0.298","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"},{"uuid":"C8K-2F69B355-2B3D-2801-EB48-F44789422299","host-name":"az2","system-ip":"5.6.6.6","local-system-ip":"5.6.6.6","site-id":"6","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655170234517,"version":"17.06.01a.0.298","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/connectivity/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Connectivity details","operationId":"getEdgeConnectivityDetails","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"connectivityName","in":"query","description":"Connectivity Name","schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Connectivity Type","schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Interconnect Gateway name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IC-GW Connectivity":{"description":"IC-GW Connectivity","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Interconnect connectivity","operationId":"updateEdgeConnectivity","requestBody":{"description":"Edge connectivity","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge connectivity":{"description":"Edge connectivity"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Interconnect connectivity","operationId":"createEdgeConnectivity","requestBody":{"description":"Edge connectivity","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge connectivity":{"description":"Edge connectivity"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivity/edge/{connectionName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Interconnect connectivity","operationId":"deleteEdgeConnectivity","parameters":[{"name":"connectionName","in":"path","description":"Edge connectivity name","required":true,"schema":{"type":"string"}},{"name":"deleteCloudResources","in":"query","description":"Delete Cloud Resources","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivity/edge/{connectivityName}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Connectivity by name","operationId":"getEdgeConnectivityDetailByName","parameters":[{"name":"connectivityName","in":"path","description":"IC-GW connectivity name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IC-GW Connectivity Name":{"description":"IC-GW Connectivity Name","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivitygateway":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get all Connectivity Gateways","operationId":"getConnectivityGateways","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Cloud Connectivity Type","schema":{"type":"string"}},{"name":"connectivityGatewayName","in":"query","description":"Connectivity Gateway Name","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}},{"name":"network","in":"query","description":"Network","schema":{"type":"string"}},{"name":"state","in":"query","description":"State","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}},{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge gateways":{"description":"Edge gateways","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Connectivity gateway","operationId":"createConnectivityGateway","requestBody":{"description":"Connectivity gateway","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connectivity gateway":{"description":"Connectivity gateway"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete all Connectivity Gateways in local DB","operationId":"cleanUpAllConnectivityGatewaysInLocalDB","parameters":[{"name":"deletionType","in":"query","description":"Deletion Type","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Connectivity Gateway","operationId":"deleteConnectivityGateway","parameters":[{"name":"cloudProvider","in":"path","description":"Cloud Provider","required":true,"schema":{"type":"string"}},{"name":"connectivityGatewayName","in":"path","description":"Connectivity gateway name","required":true,"schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Cloud Connectivity Type","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivitygatewaycreationoptions":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get connectivity gateway creation options","operationId":"getConnectivityGatewayCreationOptions","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Cloud Connectivity Type","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connectivity Gateway Creation options":{"description":"Connectivity Gateway Creation options","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/corenetworkpolicy":{"get":{"tags":["MultiCloud - General"],"description":"Get AWS Cloudwan core network policy","operationId":"getCwanCoreNetworkPolicy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoreNetworkPolicyResponse"},"examples":{"Core Network Policy Response":{"description":"Core Network Policy Response","value":"{\n\"coreNetworkId\": \"core-network-0008d82310d17b86b\",\n\"policyVersionId\": 19, \n\"policyAlias\": \"LIVE, LATEST\",\n\"description\": \"Core Network Policy\",\n\"createdAt\": \"Dec.16, 2022 04:16 UTC\",\n\"changeSetState\": \"EXECUTION_SUCCEEDED\",\n\"policyData\": { \"version\": \"2021.12\" }\" \n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/dashboard/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get interconnect edge gateway dashboard info","operationId":"getDashboardEdgeInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Dashboard edge info":{"description":"Dashboard edge info"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/device":{"get":{"tags":["MultiCloud - General"],"description":"Get available WAN edge devices","operationId":"getWanDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanEdgeDevicesResponse"},"examples":{"List of available WAN devices":{"description":"List of available WAN devices","value":[{"configuredHostname":"aws-test2","deviceModel":"vedge-C8000V","uuid":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1","configuredSystemIP":"9.1.1.3","isPaygUuid":false},{"configuredHostname":"aws-test","deviceModel":"vedge-C8000V","uuid":"C8K-1FCEF03D-1091-497B-3BA1-7FD24C4CE957","configuredSystemIP":"9.1.1.2","isPaygUuid":false}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/devicelink/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Device Links","operationId":"getDeviceLinks","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"deviceLinkName","in":"query","description":"Device Link Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Links":{"description":"Device Links","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Device Link","operationId":"updateDeviceLink","requestBody":{"description":"Device Link","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Link":{"description":"Device Link"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Device Link","operationId":"createDeviceLink","requestBody":{"description":"Device Link","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Link":{"description":"Device Link"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devicelink/edge/portspeed/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get supported port speed for Device Link","operationId":"getDlPortSpeed","parameters":[{"name":"edgeType","in":"path","description":"Interconnect Provider","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"port-speed":{"description":"port-speed","value":"{100, 200}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devicelink/edge/{deviceLinkName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Device Link","operationId":"deleteDeviceLink","parameters":[{"name":"deviceLinkName","in":"path","description":"Device Link Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devicelink/metroSpeed/edge":{"post":{"tags":["Configuration - Multi Cloud"],"description":"Get Device Link Metro Speed based on device link config","operationId":"getDeviceLinkMetroSpeed","requestBody":{"description":"Device Link","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Link":{"description":"Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"cisco_dev","deviceLinkName":"test","bandwidth":"50","deviceList":[{"deviceName":"test-dev-0"},{"deviceName":"test-dev-1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"dlMetroBandwidth":{"description":"dlMetroBandwidth","value":1000}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devices/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get cloud devices by cloud type","operationId":"getCloudDevices_1","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Edge Gateway Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud devices":{"description":"Cloud devices","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/devices/{cloudType}":{"get":{"tags":["MultiCloud - General"],"description":"Get cloud devices by cloud type","operationId":"getCloudDevices","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInfoExtendedResponse"},"examples":{"Device list for cloudType":{"description":"Device list for cloudType","value":[{"cloudGatewayName":"az-test","uuid":"C8K-2F69B355-2B3D-2801-EB48-F44789422299","host-name":"az2","system-ip":"5.6.6.6","local-system-ip":"5.6.6.6","site-id":"6","configuredSystemIP":"5.6.6.6","device-model":"vedge-C8000V","device-type":"vedge","configStatusMessage":"Out of Sync","reachability":"reachable","version":"17.06.01a.0.298","lastupdated":1655168711688,"uptime-date":1655165580000,"status":"normal"},{"cloudGatewayName":"az-test","uuid":"C8K-D4821270-27FF-A1B0-B902-12A321E3A550","host-name":"az1","system-ip":"5.1.5.5","local-system-ip":"5.1.5.5","site-id":"5","configuredSystemIP":"5.1.5.5","device-model":"vedge-C8000V","device-type":"vedge","configStatusMessage":"In Sync","reachability":"reachable","version":"17.06.01a.0.298","lastupdated":1655168712505,"uptime-date":1655164800000,"status":"normal"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/edge/{edgeType}/device":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get available WAN edge devices","operationId":"getEdgeWanDevices","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge devices":{"description":"Edge devices"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/gateway/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateways","operationId":"getIcgws","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}},{"name":"regionId","in":"query","description":"Region Id","schema":{"type":"string"}},{"name":"resourceState","in":"query","description":"Resource State","schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Edge gateway name","schema":{"type":"string"}},{"name":"billingAccountId","in":"query","description":"billing Account Id","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateways":{"description":"Interconnect Gateways","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Interconnect Gateway","operationId":"createIcgw","requestBody":{"description":"Interconnect Gateway","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway":{"description":"Interconnect Gateway"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateway/edge/setting/{edgeGatewayName}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateway custom setting by Interconnect Gateway name","operationId":"getIcgwCustomSettingDetails","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway custom setting":{"description":"Interconnect Gateway custom setting","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateway/edge/types":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateway type for specified Edge Provider","operationId":"getIcgwTypes","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway type":{"description":"Interconnect Gateway type","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateway/edge/{edgeGatewayName}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateway by name","operationId":"getIcgwDetails","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway":{"description":"Interconnect Gateway","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Interconnect Gateway","operationId":"updateIcgw","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Interconnect Gateway","operationId":"deleteIcgw","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateways/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get sites with connectivity to the interconnect gateways by edge type","operationId":"getEdgeGateways","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Gateways":{"description":"Edge Gateways","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/hostvpc":{"get":{"tags":["MultiCloud - Tagging"],"description":"Get all Host VPCs","operationId":"getHostVpcs","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"accountIds","in":"query","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"untagged","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HostVpcsResponse"}},"examples":{"AWS VPCs":{"description":"AWS VPCs","value":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1"}]},"Azure VNETs":{"description":"Azure VNETs","value":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","resourceGroups":"test-rg"}]},"GCP VPCs":{"description":"GCP VPCs","value":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/hostvpc/tags":{"get":{"tags":["MultiCloud - Tagging"],"description":"Get VPC Tags","operationId":"getVpcTags","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"tagName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HostVpcTagResponse"}},"examples":{"AWS VPC Tags":{"description":"AWS VPC Tags","value":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1","tag":"test-tag"}]},"Azure VNET Tags":{"description":"Azure VNET Tags","value":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","resourceGroups":"test-rg","tag":"test-tag","interconnectTag":"No"}]},"GCP VPC Tags":{"description":"GCP VPC Tags","value":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3","tag":"test-tag","interconnectTag":"No"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - Tagging"],"description":"Edit VPCs for a Tag","operationId":"editTag","requestBody":{"description":"Payload for updating VPCs for a Tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostVpcTagPut"},"examples":{"Edit AWS Tag":{"description":"Edit AWS Tag","value":{"tagName":"test-tag","interconnectTag":false,"hostVpcs":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1","id":"vpc-0fd1fbce44f9db86b","label":"vpc-0fd1fbce44f9db86b","interconnectTag":"No"},{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-089a6f8af08dacbf1","hostVpcName":"test-vpc-2","id":"vpc-089a6f8af08dacbf1","label":"vpc-089a6f8af08dacbf1","interconnectTag":"No"}]}},"Edit Azure Tag":{"description":"Edit Azure Tag","value":{"tagName":"test-azure-tag","interconnectTag":false,"vnets":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","vpcName":"test-vnet-1","resourceGroups":"test-rg","id":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","label":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","interconnectTag":"No","tag":"test-azure-tag"},{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-2","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-2","vpcName":"test-vnet-2","resourceGroups":"test-rg","id":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-2","label":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-2","interconnectTag":"No","tag":"test-azure-tag"}]}},"Edit GCP Tag":{"description":"Edit GCP Tag","value":{"tagName":"test-gcp-tag","interconnectTag":false,"hostVpcs":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3","tag":"test-tag","interconnectTag":"No","id":"8360972143511967399","label":"8360972143511967399"},{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"2261865283189378184","hostVpcName":"test-vpc-4","tag":"test-tag","interconnectTag":"No","id":"2261865283189378184","label":"2261865283189378184"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Tagging"],"description":"Tag a VPC","operationId":"hostVpcTagging","requestBody":{"description":"Payload for tagging a VPC","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostVpcTagPost"},"examples":{"Tag an AWS VPC":{"description":"Tag an AWS VPC","value":{"tagName":"test-tag","interconnectTag":false,"hostVpcs":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1","id":"vpc-0fd1fbce44f9db86b","label":"vpc-0fd1fbce44f9db86b"}]}},"Tag an Azure VNET":{"description":"Tag an Azure VNET","value":{"tagName":"test-azure-tag","interconnectTag":false,"vnets":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","vpcName":"test-vnet-1","resourceGroups":"test-rg","id":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","label":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1"}]}},"Tag a GCP VPC":{"description":"Tag a GCP VPC","value":{"tagName":"test-gcp-tag","interconnectTag":false,"hostVpcs":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3","tag":"test-tag","interconnectTag":"No","id":"8360972143511967399","label":"8360972143511967399"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/hostvpc/tags/rebalanceVnets":{"post":{"tags":["MultiCloud - Tagging"],"description":"Tag a VPC","operationId":"rebalanceVnets","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"tagName","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/hostvpc/tags/{tagName}":{"delete":{"tags":["MultiCloud - Tagging"],"description":"Delete a Tag","operationId":"unTag","parameters":[{"name":"tagName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/imagename/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge provider supported images","operationId":"getSupportedEdgeImageNames","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge provider images":{"description":"Edge provider images"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/instancesize":{"get":{"tags":["MultiCloud - Global Settings"],"description":"Get Transit VPC supported size","operationId":"getSupportedInstanceSize","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"accountId","in":"query","schema":{"type":"string"}},{"name":"cloudRegion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstanceSizeResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/instancesize/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge provider supported size","operationId":"getSupportedEdgeInstanceSize","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge provider size":{"description":"Edge provider size"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/interconnect/accounts":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get Interconnect provider accounts.","description":"API to retrieve Interconnect provider accounts.","operationId":"getInterconnectAccounts","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectAccount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Add an Interconnect provider account to vManage.","description":"API to associate an Interconnect provider account to vManage.","operationId":"addInterconnectAccount","requestBody":{"description":"Request Payload for Multicloud Interconnect Accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"},"examples":{"Interconnect Megaport Account":{"description":"Interconnect Megaport Account","value":{"edgeType":"MEGAPORT","edgeAccountName":"interconnect-mp-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Megaport account","megaportCredentials":{"username":"cisco@megaport.com","password":"XXXXX"}}},"Interconnect Equinix Account":{"description":"Interconnect Equinix Account","value":{"edgeType":"EQUINIX","edgeAccountName":"interconnect-eq-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Equinix account","equinixCredentials":{"clientId":"abcd-1234","clientSecret":"XXXX-XXXX-XXXX"}}}}}}},"responses":{"200":{"description":"Interconnect Provider Account Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/accounts/{interconnect-account-id}":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get associated Interconnect provider account by id.","description":"API to retrieve associated Interconnect provider account details by id.","operationId":"getInterconnectAccount","parameters":[{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Provider Account Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Edit associated Interconnect provider account name and description.","description":"API to edit associated Interconnect provider account name and description.","operationId":"updateInterconnectAccount","parameters":[{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"},"examples":{"Interconnect Megaport Account":{"description":"Interconnect Megaport Account","value":{"edgeType":"MEGAPORT","edgeAccountName":"interconnect-mp-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Megaport account","megaportCredentials":{"username":"cisco@megaport.com","password":"XXXXX"}}},"Interconnect Equinix Account":{"description":"Interconnect Equinix Account","value":{"edgeType":"EQUINIX","edgeAccountName":"interconnect-eq-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Equinix account","equinixCredentials":{"clientId":"abcd-1234","clientSecret":"XXXX-XXXX-XXXX"}}}}}}},"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Delete Interconnect provider account from vManage.","description":"API to disassociate Interconnect provider account from vManage.","operationId":"deleteInterconnectAccount","parameters":[{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/accounts/{interconnect-account-id}/credentials":{"put":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Edit associated Interconnect provider account credentials.","description":"API to edit associated Interconnect provider account credentials.","operationId":"updateInterconnectAccountCredentials","parameters":[{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"},"examples":{"Interconnect Megaport Account":{"description":"Interconnect Megaport Account","value":{"edgeType":"MEGAPORT","edgeAccountName":"interconnect-mp-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Megaport account","megaportCredentials":{"username":"cisco@megaport.com","password":"XXXXX"}}},"Interconnect Equinix Account":{"description":"Interconnect Equinix Account","value":{"edgeType":"EQUINIX","edgeAccountName":"interconnect-eq-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Equinix account","equinixCredentials":{"clientId":"abcd-1234","clientSecret":"XXXX-XXXX-XXXX"}}}}}}},"responses":{"200":{"description":"Interconnect Provider Account Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/audit":{"get":{"tags":["Multicloud Interconnect - Resource Audit"],"summary":"Get audit report for resources.","description":"API to generate audit report for resources.","operationId":"getAuditReport","parameters":[{"name":"interconnect-type","in":"query","schema":{"type":"string"}},{"name":"connection-type","in":"query","schema":{"type":"string"}},{"name":"cloud-type","in":"query","schema":{"type":"string"}},{"name":"device-links","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Audit Report Get Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditReport"},"examples":{"Interconnect Audit In-Sync":{"description":"Interconnect Audit In-Sync","value":{"auditStatus":"IN_SYNC","auditReport":[{"status":"IN_SYNC","errString":"","reportType":"Edge Gateway","resourceName":"MY-ICGW-1","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"}]}},"Interconnect Audit Out-Of-Sync":{"description":"Interconnect Audit Out-Of-Sync","value":{"auditStatus":"OUT_OF_SYNC","auditReport":[{"status":"IN_SYNC","errString":"","reportType":"Edge Gateway","resourceName":"MY-ICGW-1","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},{"status":"OUT_OF_SYNC_DRY_RUN","errString":"BGP Status down","reportType":"Edge Connection","resourceName":"test-az-conn-1","region":"New York Primary - New York - NY - USA"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/gcr-and-attachments":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Google Cloud Router and Attachments.","description":"API to get Google Cloud Router and Attachments.","operationId":"getGoogleCloudRouterAndAttachments","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectivity-gateway-name","in":"query","schema":{"type":"string"}},{"name":"cloud-gateway-name","in":"query","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"network","in":"query","schema":{"type":"string"}},{"name":"resource-state","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Google Cloud Router and Attachments Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20010"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vhubs":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Azure Virtual Hubs.","description":"API to retrieve Azure Virtual Hubs.","operationId":"getAzVirtualHubs","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}},{"name":"vwan-name","in":"query","schema":{"type":"string"}},{"name":"tag-name","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vwans":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Azure Virtual Wans.","description":"API to retrieve Azure Virtual Wans.","operationId":"getAzVirtualWans","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}},{"name":"vwan-name","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Azure Virtual Wan Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2009"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Create an Azure Virtual Wan.","description":"API to create an Azure Virtual Wan..","operationId":"createAzVirtualWan","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Azure Vwan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureVirtualWan"},"examples":{"Interconnect Azure VWAN":{"description":"Interconnect Azure VWAN","value":{"cloudType":"AZURE","accountId":"cloud-account-id","accountName":"my-cloud-account-name","name":"my-vwan-name","description":"string","region":"My Azure Region","resourceGroupName":"az-resource-group","tagList":[{"name":"string","value":"mytag"}],"virtualWanType":"optional vwan type","allowBranchToBranchTraffic":false,"vnetTovnetTrafficEnabled":false}}}}}},"responses":{"200":{"description":"Azure Virtual Wan Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2009"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vwans/{vwan-name}":{"delete":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Delete an Azure Virtual Wan.","description":"API to delete an Azure Virtual Wan.","operationId":"deleteAzVirtualWan","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"vwan-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get all Cloud Connectivity Gateways.","description":"API to retrieve all Cloud Connectivity Gateways.","operationId":"getCloudConnectivityGateways","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"query","schema":{"type":"string"}},{"name":"connectivity-gateway-name","in":"query","schema":{"type":"string"}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}},{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"network","in":"query","schema":{"type":"string"}},{"name":"resource-state","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2008"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Create a Cloud Connectivity Gateway.","description":"API to create a Cloud Connectivity Gateway such as Direct Connect Gateway, Express Route Circuit or Google Cloud routers.","operationId":"addCloudConnectivityGateway","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Cloud Connectivity Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudConnectivityGateway"},"examples":{"AWS Direct Connect Gateway":{"description":"AWS Direct Connect Gateway","value":"{\n\t\"gatewayName\": \"resource-name\",\n\t\"description\": \"This is my resource\",\n\t\"cloudType\": \"AWS\",\n\t\"cloudAccountId\": \"ABCD-1234-CDEF\",\n\t\"region\": \"My AWS region\",\n\t\"cloudGatewayName\": \"my-mc-cloud-gateway\",\n\t\"awsConnectivityGateway\": {\n\t\t\"awsConnectivityType\": \"DIRECT_CONNECT_GATEWAY\",\n\t\t\"directConnectGateway\": {\n\t\t\t\"amazonSideAsn\": 64515,\n\t\t}\n\t}\n}"},"AWS Virtual Private Gateway":{"description":"AWS Virtual Private Gateway","value":"{\n\t\"gatewayName\": \"resource-name\",\n\t\"description\": \"This is my resource\",\n\t\"cloudType\": \"AWS\",\n\t\"cloudAccountId\": \"ABCD-1234-CDEF\",\n\t\"region\": \"My AWS region\",\n\t\"cloudGatewayName\": \"my-mc-cloud-gateway\",\n\t\"awsConnectivityGateway\": {\n\t\t\"awsConnectivityType\": \"VIRTUAL_PRIVATE_GATEWAY\",\n\t\t\"virtualPrivateGateway\": {\n\t\t\t\"availabilityZone\": \"\",\n\t\t\t\"vpgType\": \"ipsec.1\",\n\t\t\t\"amazonSideAsn\": 64515\n\t\t},\n\t}\n}"},"AWS Transit Gateway":{"description":"AWS Transit Gateway","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AWS","cloudAccountId":"ABCD-1234-CDEF","region":"My AWS region","cloudGatewayName":"my-mc-cloud-gateway","awsConnectivityGateway":{"awsConnectivityType":"TRANSIT_GATEWAY","transitGateway":{"amazonSideAsn":64515}}}},"AZURE Express Route Circuit":{"description":"AZURE Express Route Circuit","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AZURE","cloudAccountId":"ABCD-1234-CDEF","region":"My Azure region","azureConnectivityGateway":{"azureConnectivityType":"EXPRESS_ROUTE_CIRCUIT","expressRouteCircuit":{"resourceGroupName":"az-resource-group","allowClassicOperations":true,"globalReachEnabled":true,"bandwidthInGbps":200,"sku":{"name":"resource-name","tier":"STANDARD","family":"METERED_DATA"},"serviceProviderProperties":{"serviceProviderName":"Equinix","peeringLocation":"New York","bandwidthInMbps":200}}}}},"AZURE Express Route Gateway":{"description":"AZURE Express Route Gateway","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AZURE","cloudAccountId":"ABCD-1234-CDEF","region":"My Azure region","azureConnectivityGateway":{"azureConnectivityType":"EXPRESS_ROUTE_GATEWAY","expressRouteGateway":{"resourceGroupName":"az-resource-group","vHubId":"vhub-1234"}}}},"AZURE Virtual Network Gateway":{"description":"AZURE Virtual Network Gateway","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AZURE","cloudAccountId":"ABCD-1234-CDEF","region":"My Azure region","azureConnectivityGateway":{"azureConnectivityType":"VIRTUAL_NETWORK_GATEWAY","virtualNetworkGateway":{"virtualNetworkGatewayType":"EXPRESS_ROUTE","enableBgp":true,"subnet":"192.168.10.0/24","publicIPAddress":"198.18.0.34/30","sku":{"name":"resource-name","tier":"STANDARD","capacity":100}}}}},"Google Cloud Router and Attachments":{"description":"Google Cloud Router and Attachments","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"GCP","cloudAccountId":"ABCD-1234-CDEF","region":"My GCP region","gcpConnectivityGateway":{"gcConnectivityType":"GCR_ATTACHMENT","routerInfo":{"name":"resource-name","region":"My GCP region","network":"my-vpc-network","attachmentDetails":[{"name":"resource-name","region":"My GCP region","secondaryZone":true}]}}}}}}}},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Delete Cloud Connectivity Gateways by type.","description":"API to delete Cloud Connectivity Gateways by type.","operationId":"deleteCloudConnectivityGateways","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways/create-options":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Cloud Connectivity Gateway create Options.","description":"API to retrieve Cloud Connectivity Gateway create options.","operationId":"getCloudConnectivityGatewayCreateOptions","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"query","schema":{"type":"string"}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Cloud Connectivity Gateway Create Options Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20013"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways/{connectivity-gateway-name}":{"delete":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Delete a Cloud Connectivity Gateway.","description":"API to delete a Cloud Connectivity Gateway.","operationId":"deleteCloudConnectivityGateway","parameters":[{"name":"connectivity-gateway-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/colors/{tunnel-type}":{"get":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Get supported Colors for Interconnect tunnel type.","description":"API to retrieve supported Colors for Interconnect tunnel type.","operationId":"getInterconnectColors","parameters":[{"name":"tunnel-type","in":"path","description":"Interconnect Loopback Tunnel Type","required":true,"schema":{"type":"string","enum":["loopbackTransit","loopbackCgw"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2002"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/connections":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get all Interconnect connectivity.","description":"API to retrieve all exisiting Interconnect connectivity.","operationId":"getInterconnectConnectivitys","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-gateway-name","in":"query","schema":{"type":"string"}},{"name":"connection-name","in":"query","schema":{"type":"string"}},{"name":"connection-type","in":"query","description":"Interconnect Connection Type","schema":{"type":"string","enum":["edge","cloud"]}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Create a private cross connection from an Interconnect Gateway.","description":"API to create a private transit or cloud connection on an Interconnect Gateway at an Interconnect Provider.","operationId":"createInterconnectConnectivity","requestBody":{"description":"Request Payload for Multicloud Interconnect Connections","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Connections - AWS Hosted Connection Private VPC":{"description":"Interconnect Connections - AWS Hosted Connection Private VPC","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-12345","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"aws-private-vif-hconn","connectivitySpeed":"2000","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},"destinationEnd":{"name":"AWS_Asia Pacific (Sydney) (ap-southeast-2)","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a2","productId":"87860c28-81ef-4e79-8cc7-cfc5a4c4bc86","regionId":"6","region":"Asia Pacific (Sydney) (ap-southeast-2)"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"AWS_MP","connectivityGwName":"test-dcg2","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"private","segments":["500"],"attachments":{"attachmentType":"vpc","vpcAttachments":["vpcTag1","vpcTag2"]}}]}}},"Interconnect Connections - AWS Hosted Connection Private CGW":{"description":"Interconnect Connections - AWS Hosted Connection Private CGW","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"test-icgw-v2-hc-private-cgw","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"0f7ad38f-0797-4b76-9dcb-0942e59e64b1","regionId":"68","region":"CoreSite VA1, Reston, VA, USA : Ashburn"},"destinationEnd":{"name":"AWSHC_US West (Oregon) (us-west-2) [DZ-RED], Location Id: 100 - Las Vegas - NV - USA","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a2","productId":"466b084f-6a52-44b2-b94d-7446b0e156c5","regionId":"100","region":"US West (Oregon) (us-west-2) [DZ-RED], Location Id: 100 - Las Vegas - NV - USA"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"TEAM_STRATA_AWS","connectivityGwName":"test-dcgw::5d08c579-ede3-4bf5-9e87-15b584ea52a0","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"private","attachments":{"attachmentType":"cgw","gatewayAttachments":[{"gatewayName":"CGW-US-WEST2"}]}}]}}},"Interconnect Connections - AWS Hosted Connection Transit VPC":{"description":"Interconnect Connections - AWS Hosted Connection Transit VPC","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"transit-hconn","connectivitySpeed":"1000","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},"destinationEnd":{"name":"AWSHC_Asia Pacific (Sydney) (ap-southeast-2) [DZ-BLUE]","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a2","productId":"b2e0b6b8-2943-4c44-8a07-9ec13060afb2","regionId":"6","region":"Asia Pacific (Sydney) (ap-southeast-2) [DZ-BLUE]"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"AWS_MP","connectivityGwName":"test-dcg2","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"transit","segments":["500"],"attachments":{"attachmentType":"tgw","vpcAttachments":["vpcTag1","vpcTag2"],"gatewayAttachments":[{"gatewayName":"TGW1","gatewayId":"12345","prefixAdvertiseList":["3.3.3.1/30"]},{"gatewayName":"TGW2","gatewayId":"54321","prefixAdvertiseList":["4.3.3.1/30","5.3.3.1/30"]}]}}]}}},"Interconnect Connections - AWS Hosted Connection Public":{"description":"Interconnect Connections - AWS Hosted Connection Public","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"test-conn-1","connectivitySpeed":"100","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney","interfaceDetail":{"interfaceName":"","ipAddress":"3.3.3.1","prefix":"30","bgpAsn":"","vlanId":""}},"destinationEnd":{"name":"AWS-Direct-Connect","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a1","productId":"d0a350e8-ee22-43b3-93c4-d08f901cb4ae","regionId":"75","region":"US East (N. Virginia) (us-east-1)"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"aws-account-dummy","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"public","segments":["100"],"prefixAdvertiseList":["4.4.4.1/30","5.5.5.1/30"],"interfaceDetail":{"interfaceName":"","ipAddress":"3.3.3.2","prefix":"30","bgpAsn":"23457","vlanId":""}}]}}},"Interconnect Connections - AZURE Private VNET Peering":{"description":"Interconnect Connections - AZURE Private VNET Peering","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","connectivityName":"ec-azure-redundancy-primary","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},"destinationEnd":{"name":"Seattle Primary","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"7cf983e5-554c-4cd7-9a58-d17276196608","regionId":"57","region":"Seattle Primary, WA, USA, Location Id: 57"},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"primary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","segments":["500"],"attachments":{"attachmentType":"vnet","vpcAttachments":["az-ic-west-us"]}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","connectivityName":"ec-azure-redundancy-secondary","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"41c00d69-1bee-4eda-8b21-d9c05ac6f3a9","regionId":"88","region":"Global Switch London East, London, United Kingdom : London"},"destinationEnd":{"name":"Seattle Secondary","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"af9b4093-e001-4d56-beaa-f005478f8240","regionId":"57","region":"Seattle Secondary, WA, USA, Location Id: 57"},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"secondary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","segments":["500"],"attachments":{"attachmentType":"vnet","vpcAttachments":["az-ic-west-us"]}}]}}}},"Interconnect Connections - AZURE Private CGW Peering":{"description":"Interconnect Connections - AZURE Private CGW Peering","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"New York Primary - New York - NY - USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"7b3d8228-b60a-42c7-857e-9db6d9790abc","regionId":"61","region":"New York Primary - New York - NY - USA"},"connectivityName":"test-az-cgw-p2","connectivitySpeed":"100","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"4ed114b3-b2da-4889-9a3e-f82c814f2f2c","regionId":"58","region":"Internap SEF, Seattle, WA, USA : Seattle"},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ERC-EASTUS","authorizationKey":"e0187415-a3cc-40ca-b35b-43cbfee350ba","role":"primary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","attachments":{"attachmentType":"cgw","gatewayAttachments":[{"gatewayName":"AZ-CGW-EAST-US"},{"gatewayName":"AZ-CGW-WESTUS2"}]}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"New York Secondary - New York - NY - USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"6e5ef004-371c-49e9-88e1-66956c0b5130","regionId":"61","region":"New York Secondary - New York - NY - USA"},"sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"0f7ad38f-0797-4b76-9dcb-0942e59e64b1","regionId":"68","region":"CoreSite VA1, Reston, VA, USA : Ashburn"},"connectivityName":"test-az-cgw-s2","connectivitySpeed":"100","cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ERC-EASTUS","authorizationKey":"e0187415-a3cc-40ca-b35b-43cbfee350ba","role":"secondary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","attachments":{"attachmentType":"cgw","gatewayAttachments":[{"gatewayName":"AZ-CGW-EAST-US"},{"gatewayName":"AZ-CGW-WESTUS2"}]}}]}}}},"Interconnect Connections - AZURE Microsoft Peering":{"description":"Interconnect Connections - AZURE Microsoft Peering","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"Seattle Primary WA USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"7cf983e5-554c-4cd7-9a58-d17276196608","regionId":"57","region":"Seattle Primary WA USA"},"connectivityName":"public-primary","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney","interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.101","prefix":"30","bgpAsn":"","vlanId":""}},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"primary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"public","segments":["200"],"prefixAdvertiseList":["162.43.160.0/24"],"interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.102","prefix":"30","bgpAsn":"","vlanId":""}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"Seattle Secondary WA USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"af9b4093-e001-4d56-beaa-f005478f8240","regionId":"57","region":"Seattle Secondary WA USA"},"sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"41c00d69-1bee-4eda-8b21-d9c05ac6f3a9","regionId":"88","region":"Global Switch London East, London, United Kingdom : London","interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.105","prefix":"30","bgpAsn":"","vlanId":""}},"connectivityName":"public-secondary","connectivitySpeed":"200","cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"secondary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"public","segments":["200"],"prefixAdvertiseList":["162.43.160.0/24"],"interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.106","prefix":"30","bgpAsn":"","vlanId":""}}]}}}},"Interconnect Connections - GOOGLE Private Shared VPC":{"description":"Interconnect Connections - GOOGLE Private Shared VPC","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"GCP","connectivityName":"test-gcp-aus-se","connectivitySpeed":"50","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"a3296673-8a7c-4274-90da-a2b0022eb6c2","regionId":"57","region":"Equinix SE2, Seattle, WA, USA : Seattle"},"destinationEnd":{"name":"Sydney (syd-zone1-1660) NSW Australia","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7c23ad6e-6ca8-4350-84bb-a1fd2abcabc4","regionId":"10","region":"Sydney (syd-zone1-1660) NSW Australia"},"cloudProviderDetail":{"cloudAccountId":"gcp-stratateamgcp-nprd-84038","cloudAccountName":"TEAM_STRATA_GCP","connectivityGwName":"","authorizationKey":"710001a6-c986-49c0-b968-c7ab7e505862/australia-southeast1/1","role":"","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["500"]}]}}},"Interconnect Connections - GOOGLE Private Shared VPC With Redundancy":{"description":"Interconnect Connections - GOOGLE Private Shared VPC With Redundancy","value":{"primaryEdgeConnection":{"sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"a3296673-8a7c-4274-90da-a2b0022eb6c2","regionId":"57","region":"Equinix SE2, Seattle, WA, USA : Seattle"},"destinationEnd":{"name":"Los Angeles (lax-zone1-8) CA USA","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7d7da69c-f5ab-4324-867f-449ac36b2c6c","regionId":"59","region":"Los Angeles (lax-zone1-8) CA USA"},"cloudProviderDetail":{"cloudAccountId":"gcp-stratateamgcp-nprd-84038","cloudAccountName":"TEAM_STRATA_GCP","connectivityGwName":"us-central1::cr-us-cent-1::uscent-attach1","role":"","authorizationKey":"301e9d66-6245-474e-940f-d646bd1c8b11/us-central1/1","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["500"]}]},"edgeType":"MEGAPORT","connectivityType":"cloud","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityProvider":"GCP","connectivityName":"test-gcp-uscent-p","connectivitySpeed":"200","settings":{"srcBgpAsn":"65000"}},"secondaryEdgeConnection":{"sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"23d472eb-0461-4c33-8d08-f47bfe621962","regionId":"59","region":"Equinix LA1, Los Angeles, CA, USA : Los Angeles"},"destinationEnd":{"name":"Los Angeles (lax-zone2-19) CA USA","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7bab4547-ff88-43f9-a1de-3df637522fa5","regionId":"60","region":"Los Angeles (lax-zone2-19) CA USA"},"cloudProviderDetail":{"cloudAccountId":"gcp-stratateamgcp-nprd-84038","cloudAccountName":"TEAM_STRATA_GCP","connectivityGwName":"us-central1::cr-us-cent-2::uscent-attach2","role":"","authorizationKey":"d467ac65-53f1-4ab0-b296-736b1a5baad6/us-central1/2","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["500"]}]},"edgeType":"MEGAPORT","connectivityType":"cloud","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityProvider":"GCP","connectivityName":"test-gcp-uscent-s","connectivitySpeed":"200","settings":{"srcBgpAsn":"65010"}}}},"Interconnect Connections - GOOGLE Private CGW":{"description":"Interconnect Connections - GOOGLE Private CGW","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"GCP","connectivityName":"test-gcp-cgw-1","connectivitySpeed":"50","sourceEnd":{"name":"mp-1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"a2962a4c-8d10-484c-b7b8-f0df084bc6f1","regionId":"83","region":"Cologix DAL2, Dallas, TX, USA : Dallas"},"destinationEnd":{"name":"Hong Kong (hkg-zone1-225) - Hong Kong - Hong Kong","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"b197b7e5-3af1-4b11-a419-84e7e89fb06d","regionId":"47","region":"Hong Kong (hkg-zone1-225) - Hong Kong - Hong Kong"},"cloudProviderDetail":{"cloudAccountId":"gcp-nprd-30634","cloudAccountName":"gap","connectivityGwName":"asia-northeast2::ic-cr-test-gcp-cgw-10-cisco919quakes-0::test-new-attach-3","authorizationKey":"629e4d56-1c9e-42b6-a7fd-37c049c0c84e/asia-northeast2/1","role":"","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["0"],"attachments":{"attachmentType":"cgw","vpcAttachments":[""],"gatewayAttachments":[{"gatewayName":"test-gcp-cgw-10"}]}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"GCP","connectivityName":"test-sam-gcp-cgw-s","connectivitySpeed":"50","sourceEnd":{"name":"mp-2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"703a6726-b6a2-499f-801c-a81fe5677af4","regionId":"320","region":"CoreSite DE1, Denver, CO, USA : Denver"},"destinationEnd":{"name":"Singapore (sin-zone2-2260) - Singapore - Singapore","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7007242d-833a-4513-9fdc-4e5eaf16bfa8","regionId":"36","region":"Singapore (sin-zone2-2260) - Singapore - Singapore"},"cloudProviderDetail":{"cloudAccountId":"gcp01-nprd-30634","cloudAccountName":"gap","connectivityGwName":"asia-northeast2::ic-cr-test-gcp-cgw-10-cisco919quakes-1::test-new-attach-4","authorizationKey":"16164bae-4eed-4148-b7b0-1ce2ca431cf5/asia-northeast2/2","role":"","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["0"],"attachments":{"attachmentType":"cgw","vpcAttachments":[""],"gatewayAttachments":[{"gatewayName":"test-gcp-cgw-10"}]}}]}}}},"Interconnect Connections - Edge":{"description":"Interconnect Connections - Edge","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"edge","connectivityProvider":"MEGAPORT","connectivityName":"test-conn-1","connectivitySpeed":"100","sourceEnd":{"name":"EGW1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"f5ff97d9-3a2a-47fb-9716-066ded11b00e","regionId":"646","region":"1623 Farnam Data Center, Omaha, NE, USA : Omaha"},"destinationEnd":{"name":"EGW3","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"76ff97d9-3a2a-47fb-9716-066ded11b01e","regionId":"137","region":"3DC/Telecity Sofia, Sofia, Bulgaria : Sofia"}}}}}}},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/connections/tags":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get configured Interconnect host VPC/VNET mapping tags.","description":"API to retrieve configured Interconnect host VPC/VNET mapping tags.","operationId":"getInterconnectMappingTags","parameters":[{"name":"cloud-type","in":"query","description":"Cloud Provider Type","schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"query","schema":{"type":"string"}},{"name":"resource-group","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2002"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/connections/{connection-name}":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get an Interconnect connectivity.","description":"API to retrieve an exisiting Interconnect connectivity.","operationId":"getInterconnectConnectivity","parameters":[{"name":"connection-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Edit an Interconnect connectivity.","description":"API to update an Interconnect connectivity at an Interconnect provider.","operationId":"updateInterconnectConnectivity","parameters":[{"name":"connection-name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Connections","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Connections - AWS Hosted Connection Private VPC":{"description":"Interconnect Connections - AWS Hosted Connection Private VPC","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-12345","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"aws-private-vif-hconn","connectivitySpeed":"2000","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},"destinationEnd":{"name":"AWS_Asia Pacific (Sydney) (ap-southeast-2)","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a2","productId":"87860c28-81ef-4e79-8cc7-cfc5a4c4bc86","regionId":"6","region":"Asia Pacific (Sydney) (ap-southeast-2)"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"AWS_MP","connectivityGwName":"test-dcg2","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"private","segments":["500"],"attachments":{"attachmentType":"vpc","vpcAttachments":["vpcTag1","vpcTag2"]}}]}}},"Interconnect Connections - AWS Hosted Connection Private CGW":{"description":"Interconnect Connections - AWS Hosted Connection Private CGW","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"test-icgw-v2-hc-private-cgw","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"0f7ad38f-0797-4b76-9dcb-0942e59e64b1","regionId":"68","region":"CoreSite VA1, Reston, VA, USA : Ashburn"},"destinationEnd":{"name":"AWSHC_US West (Oregon) (us-west-2) [DZ-RED], Location Id: 100 - Las Vegas - NV - USA","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a2","productId":"466b084f-6a52-44b2-b94d-7446b0e156c5","regionId":"100","region":"US West (Oregon) (us-west-2) [DZ-RED], Location Id: 100 - Las Vegas - NV - USA"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"TEAM_STRATA_AWS","connectivityGwName":"test-dcgw::5d08c579-ede3-4bf5-9e87-15b584ea52a0","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"private","attachments":{"attachmentType":"cgw","gatewayAttachments":[{"gatewayName":"CGW-US-WEST2"}]}}]}}},"Interconnect Connections - AWS Hosted Connection Transit VPC":{"description":"Interconnect Connections - AWS Hosted Connection Transit VPC","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"transit-hconn","connectivitySpeed":"1000","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},"destinationEnd":{"name":"AWSHC_Asia Pacific (Sydney) (ap-southeast-2) [DZ-BLUE]","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a2","productId":"b2e0b6b8-2943-4c44-8a07-9ec13060afb2","regionId":"6","region":"Asia Pacific (Sydney) (ap-southeast-2) [DZ-BLUE]"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"AWS_MP","connectivityGwName":"test-dcg2","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"transit","segments":["500"],"attachments":{"attachmentType":"tgw","vpcAttachments":["vpcTag1","vpcTag2"],"gatewayAttachments":[{"gatewayName":"TGW1","gatewayId":"12345","prefixAdvertiseList":["3.3.3.1/30"]},{"gatewayName":"TGW2","gatewayId":"54321","prefixAdvertiseList":["4.3.3.1/30","5.3.3.1/30"]}]}}]}}},"Interconnect Connections - AWS Hosted Connection Public":{"description":"Interconnect Connections - AWS Hosted Connection Public","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AWS","connectivityName":"test-conn-1","connectivitySpeed":"100","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney","interfaceDetail":{"interfaceName":"","ipAddress":"3.3.3.1","prefix":"30","bgpAsn":"","vlanId":""}},"destinationEnd":{"name":"AWS-Direct-Connect","ownerId":"605cb850-dfb4-4a05-a171-8bf17757b3a1","productId":"d0a350e8-ee22-43b3-93c4-d08f901cb4ae","regionId":"75","region":"US East (N. Virginia) (us-east-1)"},"cloudProviderDetail":{"cloudAccountId":"029553132105","cloudAccountName":"aws-account-dummy","role":"","connectionDetailList":[{"connectionType":"hconn","connectionSubType":"public","segments":["100"],"prefixAdvertiseList":["4.4.4.1/30","5.5.5.1/30"],"interfaceDetail":{"interfaceName":"","ipAddress":"3.3.3.2","prefix":"30","bgpAsn":"23457","vlanId":""}}]}}},"Interconnect Connections - AZURE Private VNET Peering":{"description":"Interconnect Connections - AZURE Private VNET Peering","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","connectivityName":"ec-azure-redundancy-primary","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},"destinationEnd":{"name":"Seattle Primary","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"7cf983e5-554c-4cd7-9a58-d17276196608","regionId":"57","region":"Seattle Primary, WA, USA, Location Id: 57"},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"primary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","segments":["500"],"attachments":{"attachmentType":"vnet","vpcAttachments":["az-ic-west-us"]}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","connectivityName":"ec-azure-redundancy-secondary","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"41c00d69-1bee-4eda-8b21-d9c05ac6f3a9","regionId":"88","region":"Global Switch London East, London, United Kingdom : London"},"destinationEnd":{"name":"Seattle Secondary","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"af9b4093-e001-4d56-beaa-f005478f8240","regionId":"57","region":"Seattle Secondary, WA, USA, Location Id: 57"},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"secondary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","segments":["500"],"attachments":{"attachmentType":"vnet","vpcAttachments":["az-ic-west-us"]}}]}}}},"Interconnect Connections - AZURE Private CGW Peering":{"description":"Interconnect Connections - AZURE Private CGW Peering","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"New York Primary - New York - NY - USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"7b3d8228-b60a-42c7-857e-9db6d9790abc","regionId":"61","region":"New York Primary - New York - NY - USA"},"connectivityName":"test-az-cgw-p2","connectivitySpeed":"100","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"4ed114b3-b2da-4889-9a3e-f82c814f2f2c","regionId":"58","region":"Internap SEF, Seattle, WA, USA : Seattle"},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ERC-EASTUS","authorizationKey":"e0187415-a3cc-40ca-b35b-43cbfee350ba","role":"primary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","attachments":{"attachmentType":"cgw","gatewayAttachments":[{"gatewayName":"AZ-CGW-EAST-US"},{"gatewayName":"AZ-CGW-WESTUS2"}]}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"New York Secondary - New York - NY - USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"6e5ef004-371c-49e9-88e1-66956c0b5130","regionId":"61","region":"New York Secondary - New York - NY - USA"},"sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"0f7ad38f-0797-4b76-9dcb-0942e59e64b1","regionId":"68","region":"CoreSite VA1, Reston, VA, USA : Ashburn"},"connectivityName":"test-az-cgw-s2","connectivitySpeed":"100","cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ERC-EASTUS","authorizationKey":"e0187415-a3cc-40ca-b35b-43cbfee350ba","role":"secondary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"private","attachments":{"attachmentType":"cgw","gatewayAttachments":[{"gatewayName":"AZ-CGW-EAST-US"},{"gatewayName":"AZ-CGW-WESTUS2"}]}}]}}}},"Interconnect Connections - AZURE Microsoft Peering":{"description":"Interconnect Connections - AZURE Microsoft Peering","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"Seattle Primary WA USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"7cf983e5-554c-4cd7-9a58-d17276196608","regionId":"57","region":"Seattle Primary WA USA"},"connectivityName":"public-primary","connectivitySpeed":"200","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"b7df4e41-7883-4b0b-8479-c8cf3a7ab4c4","regionId":"2","region":"Equinix SY1, Sydney, NSW, Australia : Sydney","interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.101","prefix":"30","bgpAsn":"","vlanId":""}},"cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"primary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"public","segments":["200"],"prefixAdvertiseList":["162.43.160.0/24"],"interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.102","prefix":"30","bgpAsn":"","vlanId":""}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"AZURE","destinationEnd":{"name":"Seattle Secondary WA USA","ownerId":"c40de5ed-4707-4471-a78c-69436de2c505","productId":"af9b4093-e001-4d56-beaa-f005478f8240","regionId":"57","region":"Seattle Secondary WA USA"},"sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"41c00d69-1bee-4eda-8b21-d9c05ac6f3a9","regionId":"88","region":"Global Switch London East, London, United Kingdom : London","interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.105","prefix":"30","bgpAsn":"","vlanId":""}},"connectivityName":"public-secondary","connectivitySpeed":"200","cloudProviderDetail":{"cloudAccountId":"9e222d34-9f20-4a2f-9c01-e507193dabb4","cloudAccountName":"TEAM_STRATA_AZURE","connectivityGwName":"ER-WEST-US","authorizationKey":"ba3113cd-fe6b-40ac-ac37-71fc25a99715","role":"secondary","connectionDetailList":[{"connectionType":"express_route","connectionSubType":"public","segments":["200"],"prefixAdvertiseList":["162.43.160.0/24"],"interfaceDetail":{"interfaceName":"","ipAddress":"162.43.160.106","prefix":"30","bgpAsn":"","vlanId":""}}]}}}},"Interconnect Connections - GOOGLE Private Shared VPC":{"description":"Interconnect Connections - GOOGLE Private Shared VPC","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"GCP","connectivityName":"test-gcp-aus-se","connectivitySpeed":"50","sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"a3296673-8a7c-4274-90da-a2b0022eb6c2","regionId":"57","region":"Equinix SE2, Seattle, WA, USA : Seattle"},"destinationEnd":{"name":"Sydney (syd-zone1-1660) NSW Australia","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7c23ad6e-6ca8-4350-84bb-a1fd2abcabc4","regionId":"10","region":"Sydney (syd-zone1-1660) NSW Australia"},"cloudProviderDetail":{"cloudAccountId":"gcp-stratateamgcp-nprd-84038","cloudAccountName":"TEAM_STRATA_GCP","connectivityGwName":"","authorizationKey":"710001a6-c986-49c0-b968-c7ab7e505862/australia-southeast1/1","role":"","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["500"]}]}}},"Interconnect Connections - GOOGLE Private Shared VPC With Redundancy":{"description":"Interconnect Connections - GOOGLE Private Shared VPC With Redundancy","value":{"primaryEdgeConnection":{"sourceEnd":{"name":"ICGW-V1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"a3296673-8a7c-4274-90da-a2b0022eb6c2","regionId":"57","region":"Equinix SE2, Seattle, WA, USA : Seattle"},"destinationEnd":{"name":"Los Angeles (lax-zone1-8) CA USA","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7d7da69c-f5ab-4324-867f-449ac36b2c6c","regionId":"59","region":"Los Angeles (lax-zone1-8) CA USA"},"cloudProviderDetail":{"cloudAccountId":"gcp-stratateamgcp-nprd-84038","cloudAccountName":"TEAM_STRATA_GCP","connectivityGwName":"us-central1::cr-us-cent-1::uscent-attach1","role":"","authorizationKey":"301e9d66-6245-474e-940f-d646bd1c8b11/us-central1/1","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["500"]}]},"edgeType":"MEGAPORT","connectivityType":"cloud","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityProvider":"GCP","connectivityName":"test-gcp-uscent-p","connectivitySpeed":"200","settings":{"srcBgpAsn":"65000"}},"secondaryEdgeConnection":{"sourceEnd":{"name":"ICGW-V2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"23d472eb-0461-4c33-8d08-f47bfe621962","regionId":"59","region":"Equinix LA1, Los Angeles, CA, USA : Los Angeles"},"destinationEnd":{"name":"Los Angeles (lax-zone2-19) CA USA","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7bab4547-ff88-43f9-a1de-3df637522fa5","regionId":"60","region":"Los Angeles (lax-zone2-19) CA USA"},"cloudProviderDetail":{"cloudAccountId":"gcp-stratateamgcp-nprd-84038","cloudAccountName":"TEAM_STRATA_GCP","connectivityGwName":"us-central1::cr-us-cent-2::uscent-attach2","role":"","authorizationKey":"d467ac65-53f1-4ab0-b296-736b1a5baad6/us-central1/2","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["500"]}]},"edgeType":"MEGAPORT","connectivityType":"cloud","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityProvider":"GCP","connectivityName":"test-gcp-uscent-s","connectivitySpeed":"200","settings":{"srcBgpAsn":"65010"}}}},"Interconnect Connections - GOOGLE Private CGW":{"description":"Interconnect Connections - GOOGLE Private CGW","value":{"primaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"GCP","connectivityName":"test-gcp-cgw-1","connectivitySpeed":"50","sourceEnd":{"name":"mp-1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"a2962a4c-8d10-484c-b7b8-f0df084bc6f1","regionId":"83","region":"Cologix DAL2, Dallas, TX, USA : Dallas"},"destinationEnd":{"name":"Hong Kong (hkg-zone1-225) - Hong Kong - Hong Kong","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"b197b7e5-3af1-4b11-a419-84e7e89fb06d","regionId":"47","region":"Hong Kong (hkg-zone1-225) - Hong Kong - Hong Kong"},"cloudProviderDetail":{"cloudAccountId":"gcp-nprd-30634","cloudAccountName":"gap","connectivityGwName":"asia-northeast2::ic-cr-test-gcp-cgw-10-cisco919quakes-0::test-new-attach-3","authorizationKey":"629e4d56-1c9e-42b6-a7fd-37c049c0c84e/asia-northeast2/1","role":"","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["0"],"attachments":{"attachmentType":"cgw","vpcAttachments":[""],"gatewayAttachments":[{"gatewayName":"test-gcp-cgw-10"}]}}]}},"secondaryEdgeConnection":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"cloud","connectivityProvider":"GCP","connectivityName":"test-sam-gcp-cgw-s","connectivitySpeed":"50","sourceEnd":{"name":"mp-2","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"703a6726-b6a2-499f-801c-a81fe5677af4","regionId":"320","region":"CoreSite DE1, Denver, CO, USA : Denver"},"destinationEnd":{"name":"Singapore (sin-zone2-2260) - Singapore - Singapore","ownerId":"29ba879b-45c8-48eb-bd97-618d0f20ea04","productId":"7007242d-833a-4513-9fdc-4e5eaf16bfa8","regionId":"36","region":"Singapore (sin-zone2-2260) - Singapore - Singapore"},"cloudProviderDetail":{"cloudAccountId":"gcp01-nprd-30634","cloudAccountName":"gap","connectivityGwName":"asia-northeast2::ic-cr-test-gcp-cgw-10-cisco919quakes-1::test-new-attach-4","authorizationKey":"16164bae-4eed-4148-b7b0-1ce2ca431cf5/asia-northeast2/2","role":"","connectionDetailList":[{"connectionType":"gcr","connectionSubType":"attachment","segments":["0"],"attachments":{"attachmentType":"cgw","vpcAttachments":[""],"gatewayAttachments":[{"gatewayName":"test-gcp-cgw-10"}]}}]}}}},"Interconnect Connections - Edge":{"description":"Interconnect Connections - Edge","value":{"edgeType":"MEGAPORT","edgeAccountId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","connectivityType":"edge","connectivityProvider":"MEGAPORT","connectivityName":"test-conn-1","connectivitySpeed":"100","sourceEnd":{"name":"EGW1","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"f5ff97d9-3a2a-47fb-9716-066ded11b00e","regionId":"646","region":"1623 Farnam Data Center, Omaha, NE, USA : Omaha"},"destinationEnd":{"name":"EGW3","ownerId":"1c1a1b8f-a690-490b-82f5-cc9416a9e2d2","productId":"76ff97d9-3a2a-47fb-9716-066ded11b01e","regionId":"137","region":"3DC/Telecity Sofia, Sofia, Bulgaria : Sofia"}}}}}}},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Delete an Interconnect connectivity.","description":"API to delete an Interconnect connectivity at an Interconnect provider.","operationId":"deleteInterconnectConnectivity","parameters":[{"name":"connection-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"delete-cloud-resources","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/device-links":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get Interconnect provider Device-Link.","description":"API to retrieve Interconnect provider Device-Link.","operationId":"getInterconnectDeviceLinks","parameters":[{"name":"device-link-name","in":"query","schema":{"type":"string"}},{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Interconnect Device-Link Get Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Add an Interconnect Device-Link to vManage.","description":"API to create a Device-Link in vManage.","operationId":"addInterconnectDeviceLink","requestBody":{"description":"Request Payload for Multicloud Interconnect Device Links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"},"examples":{"Interconnect Equinix Device Link":{"description":"Interconnect Equinix Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"ABCD-1234-CDEF","edgeAccountName":"interconnect-account-name","deviceLinkName":"my-device-link","subnet":"20.10.0.0/16","bandwidth":"100","deviceList":[{"deviceName":"ICGW_1"},{"deviceName":"ICGW_2"}]}}}}}},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/device-links/{device-link-name}":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get Interconnect provider Device-Link.","description":"API to retrieve Interconnect provider Device-Link.","operationId":"getInterconnectDeviceLink","parameters":[{"name":"device-link-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Device-Link Get Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Update an Interconnect Device-Link to vManage.","description":"API to update a Device-Link in vManage.","operationId":"updateInterconnectDeviceLink","parameters":[{"name":"device-link-name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Device Links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"},"examples":{"Interconnect Equinix Device Link":{"description":"Interconnect Equinix Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"ABCD-1234-CDEF","edgeAccountName":"interconnect-account-name","deviceLinkName":"my-device-link","subnet":"20.10.0.0/16","bandwidth":"100","deviceList":[{"deviceName":"ICGW_1"},{"deviceName":"ICGW_2"}]}}}}}},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Delete Interconnect provider Device-Link.","description":"API to Delete Interconnect provider Device-Link.","operationId":"deleteInterconnectDeviceLink","parameters":[{"name":"device-link-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/dashboard":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get Multicloud Interconnect dashboard view.","description":"API to retrieve Multicloud Interconnect dashboard view.","operationId":"getInterconnectDashboard","responses":{"200":{"description":"Interconnect Dashboard Response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDashboard"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/entitlement/licenses":{"get":{"tags":["Multicloud Interconnect - Entitlement"],"summary":"Get Interconnect Licenses","description":"API to retrieve Interconnect licences","operationId":"getInterconnectLicenses","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}},{"name":"product-type","in":"query","description":"Interconnect License Product Type","schema":{"type":"string","enum":["GATEWAY","CONNECTION","AWSHC"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectLicense"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get all Interconnect Gateways.","description":"API to retrieve all Interconnect Gateways from vManage.","operationId":"getInterconnectGateways","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"query","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"region-id","in":"query","schema":{"type":"string"}},{"name":"interconnect-gateway-name","in":"query","schema":{"type":"string"}},{"name":"resource-state","in":"query","schema":{"type":"string"}},{"name":"interconnect-billing-account-id","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"All Interconnect Gateways .","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectGatewayExtended"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Create an Interconnect gateway in an Interconnect provider.","description":"API to create an Intercoonect gateway in an Interconnect provider.","operationId":"createInterconnectGateway","requestBody":{"description":"Request Payload for Multicloud Interconnect Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"},"examples":{"Interconnect Megaport Gateways":{"description":"Interconnect Megaport Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"mp-gateway-name","description":"This is my Megaport gateway","region":"Cologix TOR1, Toronto, ON, Canada : Toronto","regionId":"10","siteName":"My_Megaport_Site","deviceUuid":"C8K-f7f6c42c-409d-11eb-9562-005056841be8","settings":{"instanceSize":"Small","softwareImageId":"C8000v 17.09.01a"},"mrfSettings":{"mrfRouterRole":"border","mrfTransportGateway":false}}},"Interconnect Equinix Gateways":{"description":"Interconnect Equinix Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"eq-gateway-name","description":"This is my Equinix Gateway","region":"NY Metro","regionId":"10","edgeBillingAccountId":"ABCD-1234-CDEF","siteName":"My_Equinix_Site","deviceUuid":"CSR-725caea2-41a4-497c-821d-a2e280be40f2","settings":{"instanceSize":"Small","softwareImageId":"CSR1000v 17.03.03"}}}}}}},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/image-names":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get Interconnect Gateway software image versions supported by an Interconnect Provider.","description":"API to retrieve Interconnect Gateway software image versions supported by an Interconnect Provider.","operationId":"getInterconnectGatewayImageNames","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2005"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/instance-sizes":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get Interconnect Gateway instance sizes supported by an Interconnect provider.","description":"API to retrieve Interconnect Gateway instance sizes supported by an Interconnect provider.","operationId":"getInterconnectGatewayInstanceSizes","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2004"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/push-config":{"post":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Initiate a configuration push for an Interconnect gateway.","description":"API to initiate a configuration push for an Interconnect gateway.","operationId":"pushInterconnectGatewayConfig","requestBody":{"description":"Request Payload for Multicloud Interconnect Gateway Configuration Push","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewaysPushconfigBody"},"examples":{"Interconnect Gateway Configuration Push":{"description":"Interconnect Gateway Configuration Push","value":{"edgeType":"MEGAPORT","edgeGatewayName":"icgw-name"}}}}}},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/types":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get supported Interconnect Gateway solution types.","description":"API to retrieve the supported Interconnect Gateway solution types.","operationId":"getInterconnetGatewayTypes","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/{interconnect-gateway-name}":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get Interconnect Gateway Information.","description":"API to retrieve the Interconnect Gateway Information from vManage.","operationId":"getInterconnectGateway","parameters":[{"name":"interconnect-gateway-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Gateway Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Edit Interconnect Gateway Information.","description":"API to update the Interconnect Gateway Information in vManage.","operationId":"updateInterconnectGateway","parameters":[{"name":"interconnect-gateway-name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"},"examples":{"Interconnect Megaport Gateways":{"description":"Interconnect Megaport Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"mp-gateway-name","description":"This is my Megaport gateway","region":"Cologix TOR1, Toronto, ON, Canada : Toronto","regionId":"10","siteName":"My_Megaport_Site","deviceUuid":"C8K-f7f6c42c-409d-11eb-9562-005056841be8","settings":{"instanceSize":"Small","softwareImageId":"C8000v 17.09.01a"},"mrfSettings":{"mrfRouterRole":"border","mrfTransportGateway":false}}},"Interconnect Equinix Gateways":{"description":"Interconnect Equinix Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"eq-gateway-name","description":"This is my Equinix Gateway","region":"NY Metro","regionId":"10","edgeBillingAccountId":"ABCD-1234-CDEF","siteName":"My_Equinix_Site","deviceUuid":"CSR-725caea2-41a4-497c-821d-a2e280be40f2","settings":{"instanceSize":"Small","softwareImageId":"CSR1000v 17.03.03"}}}}}}},"responses":{"200":{"description":"Interconnect Gateway Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Delete an Interconnect gateway.","description":"API to delete an Interconnect Gateway from an Interconnect provider.","operationId":"deleteInterconnectGateway","parameters":[{"name":"interconnect-gateway-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/{interconnect-gateway-name}/settings":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get configured custom settings for an Interconnect gateway","description":"API to retrieve the custom settings specified for an Interconnect Gateway","operationId":"getInterconnectGatewayCustomSettings","parameters":[{"name":"interconnect-gateway-name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Gateway Custom Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewaySettings"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/settings/global":{"get":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Get global settings for an Interconnect provider type","description":"API to retrieve global settings for an Interconnect provider type.","operationId":"getInterconnectGlobalSettings","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGlobalSettings"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Edit global settings for an Interconnect provider.","description":"API to update global settings for an Interconnect provider.","operationId":"updateInterconnectGlobalSettings","requestBody":{"description":"Request Payload for Multicloud Interconnect Global Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGlobalSettings"},"examples":{"Interconnect Global Settings":{"description":"Interconnect Global Settings","value":{"edgeType":"MEGAPORT","softwareImageId":"C8000v 17.09.01a","instanceSize":"Small","loopbackTunnelColor":"private3","loopbackCgwColor":"private5","bgpAsn":65000}}}}}},"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Add global settings for an Interconnect provider.","description":"API to add global settings for an Interconnect provider.","operationId":"addInterconnectGlobalSettings","requestBody":{"description":"Request Payload for Multicloud Interconnect Global Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGlobalSettings"},"examples":{"Interconnect Global Settings":{"description":"Interconnect Global Settings","value":{"edgeType":"MEGAPORT","softwareImageId":"C8000v 17.09.01a","instanceSize":"Small","loopbackTunnelColor":"private3","loopbackCgwColor":"private5","bgpAsn":65000}}}}}},"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/types":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get supported Multicloud Interconnect providers.","description":"API to retrieve list of supported Interconnect provider Types.","operationId":"getInterconnectTypes","responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/widget":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get all Interconnect widgets","description":"API to retrieve all Interconnect widgets.","operationId":"getAllInterconnectWidgets","responses":{"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/billing-accounts":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get billing accounts for Interconnect provider type and account.","description":"API to retrieve billing accounts for an Interconnect provider type and account.","operationId":"getInterconnectBillingAccounts","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2001"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/cloud/{cloud-type}/connectivity/connections/partner-ports":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get supported partner regions for an Interconnect provider.","description":"API to retrieve supported partner regions for an Interconnect provider.","operationId":"getInterconnectPartnerPorts","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"connect-type","in":"query","description":"Interconnect Connection Connect Type","schema":{"type":"string","enum":["hvif","hconn","express_route","gcr"]}},{"name":"vxc-permitted","in":"query","schema":{"type":"boolean"}},{"name":"authorization-key","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2006"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/connectivity/connections/{connection-type}/port-speeds":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get supported port speeds for an Interconnect connectivity.","description":"API to retrieve supported port speeds for an Interconnect connectivity.","operationId":"getInterconnectPortSpeeds","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection-type","in":"path","description":"Interconnect Connection Type","required":true,"schema":{"type":"string","enum":["edge","cloud"]}},{"name":"cloud-type","in":"query","description":"Cloud Provider Type","schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"query","schema":{"type":"string"}},{"name":"connect-type","in":"query","description":"Interconnect Connection Connect Type","schema":{"type":"string","enum":["hvif","hconn","express_route","gcr"]}},{"name":"connect-subtype","in":"query","description":"Interconnect Connection Connect Sub-Type","schema":{"type":"string","enum":["private","public","transit","attachment"]}},{"name":"connectivity-gateway-name","in":"query","schema":{"type":"string"}},{"name":"partner-port","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2007"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/locations":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get list of available regions for an Interconnect provider and account.","description":"API to retrieve list of available regions for an Interconnect provider and account.","operationId":"getInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Provider Location List.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectLocations"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Update available regions for an Interconnect provider and account.","description":"API to retrieve and update the available regions for an Interconnect provider and account.","operationId":"updateInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Provider Location List.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectLocations"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Delete stored regions for an Interconnect provider and account.","description":"API to delete the stored regions for an Interconnect provider and account from vManage.","operationId":"deleteInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/connectivity/device-links/metro-speed":{"post":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get metro speed for Device-Link by Device-Link Configuration.","description":"API to get metro speed for Device-Link by Device-Link Configuration.","operationId":"getInterconnectDeviceLinkMetroSpeed","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Device Links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"},"examples":{"Interconnect Equinix Device Link":{"description":"Interconnect Equinix Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"ABCD-1234-CDEF","edgeAccountName":"interconnect-account-name","deviceLinkName":"my-device-link","subnet":"20.10.0.0/16","bandwidth":"100","deviceList":[{"deviceName":"ICGW_1"},{"deviceName":"ICGW_2"}]}}}}}},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20011"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/connectivity/device-links/port-speeds":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get supported port speeds for Device-Link by Interconnect provider.","description":"API to get supported port speeds for Device-Link by Interconnect provider.","operationId":"getInterconnectDeviceLinkPortSpeeds","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20010"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/gateways/devices":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get available Interconnect Gateway devices.","description":"API to retrieve available Interconnect Gateway devices.","operationId":"getInterconnectGatewayDevices","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse2003"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/locations":{"delete":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Delete stored regions for an Interconnect provider type.","description":"API to delete the stored regions for an Interconnect provider type from vManage.","operationId":"deleteAllInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/monitoring/connected-sites":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get Interconnect devices by Interconnect type for monitoring.","description":"API to retrieve Interconnect devices by Interconnect type for monitoring.","operationId":"getMonitoringInterconnectConnectedSites","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-gateway-name","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectConnectedSite"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/monitoring/devices":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get an Interconnect devices by Interconnect type for monitoring.","description":"API to retrieve Interconnect devices by Interconnect type for monitoring.","operationId":"getMonitoringInterconnectDevices","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-gateway-name","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDeviceInfoExtended"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/monitoring/gateways":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get an Interconnect gateways by Interconnect type for monitoring.","description":"API to retrieve Interconnect gateways by Interconnect type for monitoring.","operationId":"getMonitoringInterconnectGateways","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectGatewayMonitoring"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/widget":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get an Interconnect widget for Interconnect type.","description":"API to retrieve an Interconnect widget for an Interconnect type.","operationId":"getInterconnectWidget","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectWidget"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interfacecolor":{"get":{"tags":["MultiCloud - BranchConnect"],"description":"Get WAN interface colors","operationId":"getWanInterfaceColors","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceColorResponse"}},"examples":{"Interface Colors":{"description":"Interface Colors","value":["default","red","green"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/license/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get License Info for Edge Gateways/Connections","operationId":"getLicenses","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT"]}},{"name":"accountId","in":"query","description":"Edge Account Id","schema":{"type":"string"}},{"name":"productType","in":"query","description":"product Type","schema":{"type":"string","enum":["GATEWAY","CONNECTION","AWSHC"]}},{"name":"refresh","in":"query","description":"Refresh License Cache from Megaport","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Licenses":{"description":"Licenses","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/locations/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Locations","operationId":"getEdgeLocationsInfo","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}},{"name":"accountId","in":"query","description":"Edge Account Id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge locations":{"description":"Edge locations"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete edge account","operationId":"deleteEdgeAccount_1","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/locations/edge/{edgeType}/accountId/{accountId}":{"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Edge Locations","operationId":"updateEdgeLocationsInfo","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}},{"name":"accountId","in":"path","description":"Edge Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge locations":{"description":"Edge locations"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/loopbackCGWColor/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Loopback CGW supported colors","operationId":"getSupportedLoopbackCgwColors","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Loopback CGW colors":{"description":"Edge Loopback CGW colors"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/loopbacktransportcolor/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Loopback Tunnel supported colors","operationId":"getSupportedLoopbackTransportColors","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Loopback Tunnel colors":{"description":"Edge Loopback Tunnel colors","value":{"loopbackTunnelColor":["mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/map":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get Mapping details for cloudType","operationId":"getMappingMatrix","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetMapResponse"}},"examples":{"Get map Response":{"description":"Get map Response","value":[{"srcType":"vpn","srcId":"140","destType":"tag","destId":"A14-sf-oregon-test-50","conn":"enabled"},{"srcType":"tag","srcId":"140","destType":"vpn","destId":"A14-sf-oregon-test-50","conn":"enabled"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Mapping"],"description":"Enable Mapping for cloudType","operationId":"processMapping","requestBody":{"description":"Payloads for enable mapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostMapRequest"},"examples":{"Post Map":{"description":"Post Map","value":{"cloudType":"GCP","connMatrix":[{"conn":"enabled","destId":"tag1","destType":"tag","srcId":"100","srcType":"vpn"},{"conn":"enabled","destId":"vpn","destType":"tag","srcId":"100","srcType":"tag"}]}},"Post UnMap":{"description":"Post UnMap","value":{"cloudType":"GCP","connMatrix":[{"conn":"disabled","destId":"tag1","destType":"tag","mapped":[],"outstandingMapping":[],"srcId":"100","srcType":"vpn","unmapped":[{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-011df81d-760e-47e2-b930-cc8eaaff773d::100"},{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-6c832624-b47c-491e-bd95-b5b4b86981ec::100"}]},{"conn":"disabled","destId":"100","destType":"vpn","srcId":"tag1","srcType":"tag"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/defaults":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get default mapping values","operationId":"getDefaultMappingValues","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapDefaults"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/status":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get mapping status","operationId":"getMappingStatus","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"region","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapStatus"}},"examples":{"Get Map Status":{"description":"Get Map Status","value":{"srcType":"tag","srcId":"tag1","destType":"vpn","destId":"100","mapped":[{"srcType":"vpc","srcId":"4382130894513720959","destType":"vpn","destId":"100","tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","destRegion":"us-west3","sourceTag":"tag2","sourceRegion":"global","cloudType":"GCP"},{"srcType":"vpc","srcId":"4382120894513720959","destType":"vpn","destId":"100","tunnelId":"C8K-8FBB3-B624-1929-22C0-0C55E7DD6858::100","destRegion":"us-west3","sourceTag":"tag2","sourceRegion":"global","cloudType":"GCP"}],"outstandingMapping":[],"unmapped":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/summary":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get mapping summary","operationId":"getMappingSummary","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"vpnTunnelStatus","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapSummary"}},"examples":{"Get GCP Map Summary":{"description":"Get GCP Map Summary","value":{"region":"us-west2","accountName":"pp-acc","cloudType":"GCP","cloudGatewayName":"cgw1-gcp","cloudGatewaySolution":"gcp","cloudProviderMgmtReference":"NA","connectivityState":"Successful","connectivityStateUpdateTs":"1660614410162","additionalDetails":[{"Account ID":"gcp-abc-10202"},{"WAN VPC Name":"wan-209overlayfi"},{"Site To Cloud VPC Name":"s2c-209overlayfi"},{"Site To Site VPC Name":"s2s-209overlayfi"},{"WAN VPC ID":"5949753400137042430"},{"Site To Cloud VPC ID":"4899470889371257287"},{"Site To Site VPC ID":"3797334272073222570"},{"Site To Cloud Primary GCR Name":"s2c-cr-cgw1-gcp-209overlayfi-0"},{"Site To Cloud NCC Spoke Name":"cgw1-gcp-209overlayfi-s2c-spoke"},{"Site To Cloud NCC Hub Name":"s2c-hub-209overlayfi"},{"Site To Site NCC Hub Name":"s2s-hub-209overlayfi"}],"devices":[{"uuid":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858","systemIp":"101.1.1.9","reachability":"reachable"},{"uuid":"C8K-4ABB877C-519B-5186-B271-5698961952F4","systemIp":"101.1.1.7","reachability":"reachable"},{"uuid":"C8K-495C4EB7-0813-01F2-06E1-2BFBE1C15965","systemIp":"101.1.1.6","reachability":"reachable"}],"status":"normal,","connectedSites":"1,","vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.42","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-4ABB877C-519B-5186-B271-5698961952F4::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.40","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}],"tags":[{"tag":"tag1"}],"hostVpcs":[{"hostVpcId":"4382130894513720959","accountId":"gcp-pp-nprd-10202","tag":"tag1"},{"hostVpcId":"5752708641463555655","accountId":"gcp-pp-nprd-10202","tag":"tag1"}],"operState":""}},"Get AWS Map Summary":{"description":"Get AWS Map Summary","value":{"region":"us-west-1","accountName":"sdwan-pp","cloudType":"AWS","cloudGatewayName":"awstest","cloudGatewaySolution":"tgw_tvpc","cloudProviderMgmtReference":"arn:aws:networkma380167:global-network","connectivityState":"Successful","connectivityStateUpdateTs":"1661542265017","additionalDetails":[{"Account ID":"845888380167"},{"Transit Gateway ID":"tgw-0dd6167696ff9"},{"TGW Route Table Count":"2"},{"Transit VPC ID":"vpc-09f7ce0e792d78e73"},{"Transit VPC Name":"awscgwtest"}],"devices":[{"uuid":"C8K-09f782-bc71-4f91-9673-cfeea2f8f235","systemIp":"203.1.1.1","reachability":"reachable"}],"status":"normal","connectedSites":1,"vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-09f76182-bc71-4f91-9673-cfeea2f8f235::100","tunnelInnerIps":["169.254.0.76/30","169.254.0.80/30"],"status":"DOWN","statusMessage":"IPSEC IS DOWN","outerIpAddr":"52.53.91.70","acceptedRouteCount":0,"lastStatusChangeTimestamp":"1660986000"}],"tags":[{"tag":"tagtest"}],"hostVpcs":[{"hostVpcId":"vpc-0445ecc99eecdf","accountId":"845888380167","tag":"tagtest"}],"operState":""}},"Get Azure Map Summary":{"description":"Get Azure Map Summary","value":{"region":"westcentralus","accountName":"pp-azure","cloudType":"AZURE","cloudGatewayName":"AzureCGW","connectivityState":"Successful","connectivityStateUpdateTs":"16606410162","additionalDetails":[{"Account ID":"aws-pp-nprd-10202"},{"WAN VPC Name":"wan-209overlayfi"},{"Site To Cloud VPC Name":"s2c-209overlayfi"},{"Site To Site VPC Name":"s2s-209overlayfi"},{"WAN VPC ID":"5949753400137042430"},{"Site To Cloud VPC ID":"4899470889371257287"},{"Site To Site VPC ID":"3797334272073222570"},{"Site To Cloud Primary GCR Name":"s2c-cr-cgw1-gcp-209overlayfi-0"},{"Site To Cloud NCC Spoke Name":"cgw1-gcp-209overlayfi-s2c-spoke"},{"Site To Cloud NCC Hub Name":"s2c-hub-209overlayfi"},{"Site To Site NCC Hub Name":"s2s-hub-209overlayfi"}],"devices":[{"uuid":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858","systemIp":"101.1.1.9","reachability":"reachable"},{"status":"normal"},{"connectedSites":1}],"vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.42","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}],"tags":[{"tag":"tag1"}],"hostVpcs":[{"hostVpcId":"4382130894513720959","accountId":"gcp-shabshargcp-nprd-10202","tag":"tag1"}],"operState":""}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/tags":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get cloud gateway types for specified cloudType","operationId":"getMappingTags","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/tags/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get default Interconnect mapping tag values","operationId":"getEdgeMappingTags","parameters":[{"name":"cloudType","in":"query","description":"Cloud type","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE"]}},{"name":"accountId","in":"query","description":"Cloud Account Id","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Cloud Tags":{"description":"Interconnect Cloud Tags","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/map/vpns":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get default mapping values","operationId":"getMappingVpns","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapVpnsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/mapping/{cloudType}":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get associated mappings to the CGW","operationId":"getCgwAssociatedMappings","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}},{"name":"siteUuid","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CgwVpnsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/partnerports/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get partner ports","operationId":"getPartnerPorts","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"accountId","in":"query","description":"Edge Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"connectType","in":"query","description":"Connect Type filter","schema":{"type":"string"}},{"name":"vxcPermitted","in":"query","description":"VXC Permitted on the port","schema":{"type":"string"}},{"name":"authorizationKey","in":"query","description":"authorization Key","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Partners ":{"description":"Edge Partners ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get supported port speed","operationId":"getPortSpeed","parameters":[{"name":"edgeType","in":"path","description":"Interconnect Provider","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"edgeAccountId","in":"path","description":"Interconnect Provider Account ID","required":true,"schema":{"type":"string"}},{"name":"connectivityType","in":"path","description":"Interconnect Connectivity Type","required":true,"schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Service Provider","schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloudAccountId","in":"query","description":"Cloud Service Provider Account ID","schema":{"type":"string"}},{"name":"connectType","in":"query","description":"Connection Type filter","schema":{"type":"string"}},{"name":"connectSubType","in":"query","description":"Connection Sub-Type filter","schema":{"type":"string"}},{"name":"connectivityGateway","in":"query","description":"Connectivity Gateway","schema":{"type":"string"}},{"name":"partnerPort","in":"query","description":"partnerPort","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"port-speed":{"description":"port-speed","value":"{100, 200}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/pushCgwConfig":{"post":{"tags":["MultiCloud - CloudGateway"],"description":"Push configuration to devices of CGW","operationId":"pushCgwCfg","requestBody":{"description":"Push configuration to devices of CGW","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushCgwConfig"},"examples":{"Push Cgw Config to devices":{"description":"Push Cgw Config to devices","value":{"cloudGatewayName":"cgw-test","cloudType":"GCP"}},"Post UnMap":{"description":"Post UnMap","value":{"cloudType":"GCP","connMatrix":[{"conn":"disabled","destId":"tag1","destType":"tag","mapped":[],"outstandingMapping":[],"srcId":"100","srcType":"vpn","unmapped":[{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-011df81d-760e-47e2-b930-cc8eaaff773d::100"},{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-6c832624-b47c-491e-bd95-b5b4b86981ec::100"}]},{"conn":"disabled","destId":"100","destType":"vpn","srcId":"tag1","srcType":"tag"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/regions":{"get":{"tags":["MultiCloud - General"],"description":"Obtain all supported Cloud Service Provider (CSP) types","operationId":"getCloudRegions","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetRegions"}},"examples":{"GCP Regions":{"description":"GCP Regions","value":[{"cloudType":"GCP","regionList":{"value":["asia-east1","asia-east2","asia-northeast1","asia-northeast2","asia-northeast3","asia-south1","asia-south2","asia-southeast1","asia-southeast2","australia-southeast1","australia-southeast2","europe-central2","europe-north1","europe-southwest1","europe-west1","europe-west2","europe-west3","europe-west4","europe-west6","europe-west8","europe-west9","northamerica-northeast1","northamerica-northeast2","southamerica-east1","southamerica-west1","us-central1","us-east1","us-east4","us-east5","us-west1","us-west2","us-west3","us-west4"]}}]},"Aws Regions":{"description":"Aws Regions","value":[{"cloudType":"AWS","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]}}]},"Aws GovCloud Regions":{"description":"Aws GovCloud Regions","value":[{"cloudType":"AWS_GOVCLOUD","regionList":{"value":["us-gov-west-1","us-gov-east-1"]}}]},"Azure Regions":{"description":"Azure Regions","value":[{"cloudType":"AZURE","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]}}]},"Azure GovCloud Regions":{"description":"Azure GovCloud Regions","value":[{"cloudType":"AZURE_GOVCLOUD","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]}}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/settings/edge/global":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get edge global settings","operationId":"getEdgeGlobalSettings","parameters":[{"name":"edgeType","in":"query","description":"Edge type","required":true,"schema":{"type":"string","enum":["MP","EQ"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global setting":{"description":"Global setting"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update edge global settings for Edge provider","operationId":"updateEdgeGlobalSettings","requestBody":{"description":"Global setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global setting":{"description":"Global setting"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Add global settings for Edge provider","operationId":"addEdgeGlobalSettings","requestBody":{"description":"Global setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global setting":{"description":"Global setting"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/settings/global":{"get":{"tags":["MultiCloud - Global Settings"],"description":"Get global settings","operationId":"getGlobalSettings","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"},"examples":{"GCP Global settings":{"description":"GCP Global settings","value":{"cloudGatewaySolution":"gcp","cloudType":"GCP","name":"GCP_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"cisco-c8k-17-07-01a-cisco-public","instanceSize":"n1-standard-4","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","cgwBgpAsnOffset":64520,"mapTvpc":true,"networkTier":"STANDARD","orgBgpAsn":64530,"policyManagement":false,"serviceDirPollTimer":1200,"tunnelType":"ipsec"}},"Aws Global settings":{"description":"Aws Global settings","value":"{\n \"cloudGatewaySolution\": \"tgw_tvpc\",\n \"cloudType\": \"AWS\",\n \"name\": \"AWS_GLOBAL_SETTING\",\n \"enableAutoCorrect\": true,\n \"enablePeriodicAudit\": true,\n \"softwareImageId\": \"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1\",\n \"instanceSize\": \"c5.xlarge\",\n \"intraTagComm\": true,\n \"ipSubnetPool\": \"10.0.0.0/16\",\n \"accountId\": \"999293417507\",\n \"cgwBgpAsnOffset\": 64520,\n \"mapTvpc\": true,\n \"programDefaultRoute\": true,\n \"region\": \"us-west-1\",\n \"tunnelType\": \"ipsec\"\n \"tunnelCount\": 1\n}"},"Aws GovCloud Global settings":{"description":"Aws GovCloud Global settings","value":"{\n \"cloudGatewaySolution\": \"tgw_tvpc\",\n \"cloudType\": \"AWS_GOVCLOUD\",\n \"name\": \"AWS__GOVCLOUD_GLOBAL_SETTING\",\n \"enableAutoCorrect\": true,\n \"enablePeriodicAudit\": true,\n \"softwareImageId\": \"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1\",\n \"instanceSize\": \"c5.large\",\n \"intraTagComm\": true,\n \"ipSubnetPool\": \"10.0.0.0/16\",\n \"accountId\": \"not available\",\n \"cgwBgpAsnOffset\": 64520,\n \"mapTvpc\": true,\n \"programDefaultRoute\": true,\n \"region\": \"us-gov-west-1\",\n \"tunnelType\": \"ipsec\"\n \"tunnelCount\": 1\n}\n"},"Azure Global settings":{"description":"Azure Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE","name":"AZURE_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":2,"enableDefRouteAdvertize":false,"enableMonitoring":false}},"Azure GovCloud Global settings":{"description":"Azure GovCloud Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE_GOVCLOUD","name":"AZURE__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":4}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - Global Settings"],"description":"Update global settings","operationId":"updateGlobalSettings","requestBody":{"description":"Payload for updating Global Settings based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"},"examples":{"GCP Global settings":{"description":"GCP Global settings","value":{"cloudGatewaySolution":"gcp","cloudType":"GCP","name":"GCP_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"cisco-c8k-17-07-01a-cisco-public","instanceSize":"n1-standard-4","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","cgwBgpAsnOffset":64520,"mapTvpc":true,"networkTier":"STANDARD","orgBgpAsn":64530,"policyManagement":false,"serviceDirPollTimer":1200,"tunnelType":"ipsec"}},"Aws Global settings":{"description":"Aws Global settings","value":"{\n \"cloudGatewaySolution\": \"tgw_tvpc\",\n \"cloudType\": \"AWS\",\n \"name\": \"AWS_GLOBAL_SETTING\",\n \"enableAutoCorrect\": true,\n \"enablePeriodicAudit\": true,\n \"softwareImageId\": \"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1\",\n \"instanceSize\": \"c5.xlarge\",\n \"intraTagComm\": true,\n \"ipSubnetPool\": \"10.0.0.0/16\",\n \"accountId\": \"999293417507\",\n \"cgwBgpAsnOffset\": 64520,\n \"mapTvpc\": true,\n \"programDefaultRoute\": true,\n \"region\": \"us-west-1\",\n \"tunnelType\": \"ipsec\"\n \"tunnelCount\": 1\n}"},"Aws GovCloud Global settings":{"description":"Aws GovCloud Global settings","value":"{\n \"cloudGatewaySolution\": \"tgw_tvpc\",\n \"cloudType\": \"AWS_GOVCLOUD\",\n \"name\": \"AWS__GOVCLOUD_GLOBAL_SETTING\",\n \"enableAutoCorrect\": true,\n \"enablePeriodicAudit\": true,\n \"softwareImageId\": \"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1\",\n \"instanceSize\": \"c5.large\",\n \"intraTagComm\": true,\n \"ipSubnetPool\": \"10.0.0.0/16\",\n \"accountId\": \"not available\",\n \"cgwBgpAsnOffset\": 64520,\n \"mapTvpc\": true,\n \"programDefaultRoute\": true,\n \"region\": \"us-gov-west-1\",\n \"tunnelType\": \"ipsec\"\n \"tunnelCount\": 1\n}\n"},"Azure Global settings":{"description":"Azure Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE","name":"AZURE_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":2,"enableDefRouteAdvertize":false,"enableMonitoring":false}},"Azure GovCloud Global settings":{"description":"Azure GovCloud Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE_GOVCLOUD","name":"AZURE__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":4}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Global Settings"],"description":"Add global settings","operationId":"addGlobalSettings","requestBody":{"description":"Responses for get Global Settings based CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"},"examples":{"GCP Global settings":{"description":"GCP Global settings","value":{"cloudGatewaySolution":"gcp","cloudType":"GCP","name":"GCP_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"cisco-c8k-17-07-01a-cisco-public","instanceSize":"n1-standard-4","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","cgwBgpAsnOffset":64520,"mapTvpc":true,"networkTier":"STANDARD","orgBgpAsn":64530,"policyManagement":false,"serviceDirPollTimer":1200,"tunnelType":"ipsec"}},"Aws Global settings":{"description":"Aws Global settings","value":"{\n \"cloudGatewaySolution\": \"tgw_tvpc\",\n \"cloudType\": \"AWS\",\n \"name\": \"AWS_GLOBAL_SETTING\",\n \"enableAutoCorrect\": true,\n \"enablePeriodicAudit\": true,\n \"softwareImageId\": \"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1\",\n \"instanceSize\": \"c5.xlarge\",\n \"intraTagComm\": true,\n \"ipSubnetPool\": \"10.0.0.0/16\",\n \"accountId\": \"999293417507\",\n \"cgwBgpAsnOffset\": 64520,\n \"mapTvpc\": true,\n \"programDefaultRoute\": true,\n \"region\": \"us-west-1\",\n \"tunnelType\": \"ipsec\"\n \"tunnelCount\": 1\n}"},"Aws GovCloud Global settings":{"description":"Aws GovCloud Global settings","value":"{\n \"cloudGatewaySolution\": \"tgw_tvpc\",\n \"cloudType\": \"AWS_GOVCLOUD\",\n \"name\": \"AWS__GOVCLOUD_GLOBAL_SETTING\",\n \"enableAutoCorrect\": true,\n \"enablePeriodicAudit\": true,\n \"softwareImageId\": \"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1\",\n \"instanceSize\": \"c5.large\",\n \"intraTagComm\": true,\n \"ipSubnetPool\": \"10.0.0.0/16\",\n \"accountId\": \"not available\",\n \"cgwBgpAsnOffset\": 64520,\n \"mapTvpc\": true,\n \"programDefaultRoute\": true,\n \"region\": \"us-gov-west-1\",\n \"tunnelType\": \"ipsec\"\n \"tunnelCount\": 1\n}\n"},"Azure Global settings":{"description":"Azure Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE","name":"AZURE_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":2,"enableDefRouteAdvertize":false,"enableMonitoring":false}},"Azure GovCloud Global settings":{"description":"Azure GovCloud Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE_GOVCLOUD","name":"AZURE__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":4}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/site":{"get":{"tags":["MultiCloud - BranchConnect"],"description":"Get available sites","operationId":"getSites","parameters":[{"name":"color","in":"query","schema":{"type":"string"}},{"name":"attached","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSitesResponse"},"examples":{"Sites":{"description":"Sites","value":{"uuid":"C8K-a165f574-e75e-11ec-8fea-0242ac120002","siteId":"10","hostname":"Branch-10","systemIp":"1.1.1.10","interface":"GigabitEthernet2","color":"red","privateIp":"10.11.2.248","publicIp":"3.109.26.54","attached":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/sshkeys":{"get":{"tags":["MultiCloud - General"],"description":"Get ssh keyList for cloud type","operationId":"getSshKeyList","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"cloudRegion","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SshKeyList"}},"examples":{"sshKeyList":{"description":"sshKeyList","value":[{"sshKeyName":"pp-newkp-oregon"},{"sshKeyName":"pp-newkp-oregon-2"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/statistics/interface/aggregation":{"post":{"tags":["MultiCloud - General"],"description":"Get aggregated data based on input query and filter. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_28","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats Query String":{"description":"Stats Query String","value":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated Search Result":{"description":"Aggregated Search Result","value":{"data":[{"latency":0.6404125644631974}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/swimages":{"get":{"tags":["MultiCloud - Global Settings"],"description":"Get software image list","operationId":"getSupportedSoftwareImageList","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"accountId","in":"query","schema":{"type":"string"}},{"name":"cloudRegion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SwImagesResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/telemetry":{"post":{"tags":["MultiCloud - General"],"description":"Reports telemetry data","operationId":"telemetry","requestBody":{"description":"telemetry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Telemetry"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/tunnels/{cloudType}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get the tunnels for cloudType","operationId":"getTunnelNames","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetTunnelsResponse"}},"examples":{"Get Tunnels":{"description":"Get Tunnels","value":{"101.1.1.9":{"hostname":"gcp1109","tunnels":["GigabitEthernet2"]},"101.1.1.7":{"hostname":"gcp1107","tunnels":["GigabitEthernet2"]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/types":{"get":{"tags":["MultiCloud - General"],"description":"Obtain all supported Cloud Service Provider (CSP) types","operationId":"getCloudTypes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"List of CloudTypes":{"description":"List of CloudTypes","value":["AWS","AWS_GOVCLOUD","GCP","AZURE","AZURE_GOVCLOUD"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/types/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get edge types","operationId":"getEdgeTypes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud types":{"description":"Cloud types"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vhubs":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Virtual Hubs","operationId":"getVHubs","parameters":[{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}},{"name":"vWanName","in":"query","description":"VWan Name","schema":{"type":"string"}},{"name":"vNetTags","in":"query","description":"VNet Tags","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Azure Virtual WANs":{"description":"Azure Virtual WANs","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vwan":{"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Virtual WAN","operationId":"createVirtualWan","requestBody":{"description":"Virtual WAN","content":{"application/json":{"schema":{"type":"object"},"examples":{"Virtual WAN":{"description":"Virtual WAN"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vwan/{cloudProvider}/{vWanName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Virtual Wan","operationId":"deleteVirtualWan","parameters":[{"name":"cloudProvider","in":"path","description":"Cloud Provider","required":true,"schema":{"type":"string"}},{"name":"vWanName","in":"path","description":"Virtual Wan name","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vwans":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Virtual Wans","operationId":"getVWans","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Azure Virtual WANs":{"description":"Azure Virtual WANs","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/widget":{"get":{"tags":["MultiCloud - General"],"description":"Get All cloud widgets","operationId":"getAllCloudWidgets","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widgets"},"examples":{"Widgets":{"description":"Widgets","value":{"cloudType":"AWS","cgwStatus":{"name":"Cloud Gateway","count":0,"statusList":[{"name":"Cloud Gateway","count":0,"status":"normal","message":"Cloud Gateways"},{"name":"Cloud Gateway","count":0,"status":"warning","message":"Cloud Gateways with warning"},{"name":"Cloud Gateway","count":0,"status":"error","message":"Cloud Gateways with error"}]},"cgwDeviceStatus":{"name":"Cloud Gateway Device","count":0,"unreachableCount":0,"statusList":[{"name":"Cloud Gateway Device","count":0,"status":"normal","message":"Cloud Gateway devices"},{"name":"Cloud Gateway Device","count":0,"status":"error","message":"Cloud Gateway devices with errors"}]},"cgwSitesStatus":{"name":"Cloud Gateway Sites","count":0,"statusList":[{"name":"Cloud Gateway Sites","count":0,"status":"error","message":"Cloud Gateway Sites with error"},{"name":"Cloud Gateway Sites","count":0,"status":"warning","message":"Cloud Gateway Sites with warning"},{"name":"Cloud Gateway Sites","count":0,"status":"normal","message":"Cloud Gateway Sites"}]},"cloudGatewaySolution":"tgw_tvpc","numAccounts":0,"numVpns":0,"numTags":0,"numVpcs":0,"numTunnels":0,"cgwDeviceSiteIds":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/widget/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get All Interconnect Edge widgets ","operationId":"getAllEdgeWidgets","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge widget":{"description":"Edge widget","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/widget/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Edge widget by edge type","operationId":"getEdgeWidget","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge widget":{"description":"Edge widget","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/widget/{cloudType}":{"get":{"tags":["MultiCloud - General"],"description":"Get cloud widget by cloud type","operationId":"getCloudWidget","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudWidget"},"examples":{"Widget":{"description":"Widget","value":{"cloudType":"AWS","cgwStatus":{"name":"Cloud Gateway","count":0,"statusList":[{"name":"Cloud Gateway","count":0,"status":"normal","message":"Cloud Gateways"},{"name":"Cloud Gateway","count":0,"status":"warning","message":"Cloud Gateways with warning"},{"name":"Cloud Gateway","count":0,"status":"error","message":"Cloud Gateways with error"}]},"cgwDeviceStatus":{"name":"Cloud Gateway Device","count":0,"unreachableCount":0,"statusList":[{"name":"Cloud Gateway Device","count":0,"status":"normal","message":"Cloud Gateway devices"},{"name":"Cloud Gateway Device","count":0,"status":"error","message":"Cloud Gateway devices with errors"}]},"cgwSitesStatus":{"name":"Cloud Gateway Sites","count":0,"statusList":[{"name":"Cloud Gateway Sites","count":0,"status":"error","message":"Cloud Gateway Sites with error"},{"name":"Cloud Gateway Sites","count":0,"status":"warning","message":"Cloud Gateway Sites with warning"},{"name":"Cloud Gateway Sites","count":0,"status":"normal","message":"Cloud Gateway Sites"}]},"cloudGatewaySolution":"tgw_tvpc","numAccounts":0,"numVpns":0,"numTags":0,"numVpcs":0,"numTunnels":0,"cgwDeviceSiteIds":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/network/connectionssummary":{"get":{"tags":["Device - Network"],"description":"Retrieve vManage control status","operationId":"getVmanageControlStatus","parameters":[{"name":"isCached","in":"query","description":"Is cached flag","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","description":"VPN Id","schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage control status":{"description":"vManage control status","value":{"data":[{"name":"vSmart","count":2,"detailsURL":"/dataservice/device/reachable?personality=vsmart","status":"error","statusList":[{"name":"vSmart","status":"error","message":"Number of devices down","detailsURL":"/dataservice/device/unreachable?personality=vsmart","count":0}]},{"name":"WAN Edge","count":5,"detailsURL":"/dataservice/device/reachable?personality=vedge","status":"error","statusList":[{"name":"vEdge","status":"error","message":"Number of devices down","detailsURL":"/dataservice/device/unreachable?personality=vedge","count":0}]},{"name":"vBond","count":1,"detailsURL":"/dataservice/device/reachable?personality=vbond","status":"error","statusList":[{"name":"vBond","status":"error","message":"Number of devices down","detailsURL":"/dataservice/device/unreachable?personality=vbond","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/network/issues/rebootcount":{"get":{"tags":["Device - Network"],"description":"Retrieve reboot count","operationId":"getRebootCount","parameters":[{"name":"isCached","in":"query","description":"Is cached flag","required":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reboot count":{"description":"Reboot count","value":{"data":[{"type":"Reboot count","name":"Reboot","showTitle":false,"count":3,"detailView":"dialog","detailsURL":"dataservice/device/reboothistory/details","status":"error"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/network/issues/summary":{"get":{"tags":["Device - Network"],"description":"Retrieve network issues summary","operationId":"getNetworkIssuesSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network issues":{"description":"Network issues","value":{"data":[{"type":"Status summary","name":"Status summary","showTitle":false,"count":3,"detailView":"dialog","statusList":[{"status":"Crashes","name":"Crashes","detailView":"dialog","detailsURL":"dataservice/device/crashlog/details","color":"fa7c7d","icon":"images/device/device-error.png","count":0},{"status":"Reboots","name":"Reboots","detailView":"dialog","detailsURL":"dataservice/device/reboothistory/details","color":"f2ce60","icon":"images/device/device-warning.png","count":3},{"status":"Hardware errors","name":"Hardware errors","detailView":"dialog","detailsURL":"dataservice/device/hardware/errors","color":"f2ce60","icon":"images/device/device-warning.png","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/network/status":{"get":{"tags":["Device - Network"],"description":"Retrieve network status summary","operationId":"getNetworkStatusSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Network status":{"description":"Network status","value":{"header":{"generatedOn":1635483849920},"data":[{"type":"vSmart","name":"vSmart","image":"images/vsmart.png","count":3,"detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart","statusList":[{"status":"error","name":"Error","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=error","color":"fa7c7d","icon":"images/device/device-error.png","count":0},{"status":"warning","name":"Warning","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=warning","color":"f2ce60","icon":"images/device/device-warning.png","count":0},{"status":"normal","name":"Normal","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=normal","color":"b0e276","icon":"images/device/device-normal.png","count":3},{"status":"new","name":"Discovered device","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=new","color":"7c8afa","icon":"images/device/device-new.png","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/networkdesign":{"get":{"tags":["Configuration - Network Design"],"description":"Get existing network design","operationId":"getNetworkDesign","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design":{"description":"Network design","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"},"put":{"tags":["Configuration - Network Design"],"description":"Edit network segment","operationId":"editNetworkDesign","parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network design payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design template":{"description":"Network design template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Device Inventory > Edge-write"},"post":{"tags":["Configuration - Network Design"],"description":"Create network design","operationId":"createNetworkDesign","requestBody":{"description":"Network design payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{"dc":[{"name":"DC4","segments":["c952c18b-30b3-4f0b-b985-494693d7adfb"],"deviceProfiles":[{"deviceProfileName":"ASR1001","deviceModel":"vedge-ASR-1001-X","deviceTemplateID":"","deviceProfileId":"","circuits":["07dce48b-3c7d-46c0-ac91-36f0d64d61e7"]}]}],"showDeviceProfileHelpText":true,"globalParameters":[{"templateType":"aaa","gTemplateClass":"vedge","isUsed":false},{"templateType":"cisco_snmp","gTemplateClass":"cedge","isUsed":false},{"templateType":"omp-vedge","gTemplateClass":"vedge","isUsed":false},{"templateType":"banner","gTemplateClass":"vedge","isUsed":false},{"templateType":"ntp","gTemplateClass":"vedge","isUsed":false},{"templateType":"snmp","gTemplateClass":"vedge","isUsed":false},{"templateType":"cisco_bfd","gTemplateClass":"cedge","isUsed":false},{"templateType":"cisco_ntp","gTemplateClass":"cedge","isUsed":false},{"templateType":"cedge_global","gTemplateClass":"cedge","isUsed":false},{"templateType":"cisco_logging","gTemplateClass":"cedge","isUsed":false},{"templateType":"bfd-vedge","gTemplateClass":"vedge","isUsed":false},{"templateType":"cedge_aaa","gTemplateClass":"cedge","isUsed":false},{"templateType":"logging","gTemplateClass":"vedge","isUsed":false},{"templateType":"cisco_omp","gTemplateClass":"cedge","isUsed":false},{"templateType":"cisco_banner","gTemplateClass":"cedge","isUsed":false}],"customizedProfiles":[]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"id":"07c1e0a1-d28a-4372-b819-0f1ab5fc8e39"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write"}},"/networkdesign/attachment":{"post":{"tags":["Configuration - Network Design"],"description":"Attach network design","operationId":"pushNetworkDesign","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/networkdesign/circuit":{"get":{"tags":["Configuration - Circuits"],"description":"Get network circuits","operationId":"getCircuits","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuits":{"description":"Network circuits","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Circuits"],"description":"Create network circuits","operationId":"createCircuit","requestBody":{"description":"Network circuit","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuit":{"description":"Network circuit","value":{"type":"private","color":"biz-internet"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuit Id":{"description":"Network circuit Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/networkdesign/circuit/{id}":{"put":{"tags":["Configuration - Circuits"],"description":"Edit network circuits","operationId":"editCircuit","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network circuit","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuit":{"description":"Network circuit"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Circuits"],"description":"Delete network circuits","operationId":"deleteCircuit","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/networkdesign/global/parameters":{"get":{"tags":["Configuration - Network Design"],"description":"Get global parameter templates","operationId":"getGlobalParameters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global parameters":{"description":"Global parameters","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/global/template/{templateId}":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Get global template","operationId":"getGlobalTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design template":{"description":"Network design template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"},"put":{"tags":["Configuration - Network Design Templates"],"description":"Edit global template","operationId":"editGlobalTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design template":{"description":"Network design template"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/networkdesign/lock/edit":{"post":{"tags":["Configuration - Network Design"],"description":"Acquire edit lock","operationId":"acquireEditLock","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Lock Id":{"description":"Lock Id","value":{"id":"nd_edit-96c1ff5a-44fa-4316-ad15-cc820347f7d3"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write"}},"/networkdesign/mytest/{name}":{"get":{"tags":["Configuration - Network Design"],"description":"Get all device templates for this feature template","operationId":"runMyTest","parameters":[{"name":"name","in":"path","description":"Test bane","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/attachment/{profileId}":{"post":{"tags":["Configuration - Network Design"],"description":"Attach to device profile","operationId":"pushDeviceProfileTemplate","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/networkdesign/profile/feature":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Generate device profile template list","operationId":"getDeviceProfileFeatureTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"}},"/networkdesign/profile/lock/{profileId}":{"post":{"tags":["Configuration - Network Design"],"description":"Get the service profile config for a given device profile id","operationId":"acquireAttachLock","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/networkdesign/profile/status":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration status","operationId":"getDeviceProfileConfigStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config status":{"description":"Device config status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/status/{profileId}":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration status by profile Id","operationId":"getDeviceProfileConfigStatusByProfileId","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config status":{"description":"Device config status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/task/count":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration task count","operationId":"getDeviceProfileTaskCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config task count":{"description":"Device config task count","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/task/status":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration task status","operationId":"getDeviceProfileTaskStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config task status":{"description":"Device config task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/task/status/{profileId}":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration status by profile Id","operationId":"getDeviceProfileTaskStatusByProfileId","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config task status":{"description":"Device config task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/template":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Generate profile template list","operationId":"generateProfileTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/template/{templateId}":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Get device profile template","operationId":"getDeviceProfileTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device profile template":{"description":"Device profile template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"},"put":{"tags":["Configuration - Network Design Templates"],"description":"Edit device profile template","operationId":"editDeviceProfileTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device profile template":{"description":"Device profile template"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/networkdesign/serviceProfileConfig/{profileId}":{"get":{"tags":["Configuration - Network Design"],"description":"Get the service profile config for a given device profile id","operationId":"getServiceProfileConfig","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}},{"name":"deviceModel","in":"query","description":"Device model","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device profile":{"description":"Device profile","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/notifications/rule":{"put":{"tags":["Monitoring - Alarms Notification"],"description":"Update notification rule","operationId":"updateNotificationRule","parameters":[{"name":"ruleId","in":"query","description":"Rule Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Notification rule","content":{"application/json":{"schema":{"type":"object"},"examples":{"Notification rule":{"description":"Notification rule","value":{"notificationRuleName":"testwebhook","severity":"Medium","alarmName":"BFD_Node_Up","accountDetails":"noreply@cisco.com","webHookEnabled":true,"webhookUsername":"admin","webhookPassword":"admin","webhookUrl":"https://localhost:8444","updatedBy":"admin","devicesAttached":"1712133e-0246-4281-8152-3317b796d2bc","emailThreshold":5,"accountDetailsArray":["noreply@cisco.com"]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"},"post":{"tags":["Monitoring - Alarms Notification"],"description":"Add notification rule","operationId":"createNotificationRule","requestBody":{"description":"Notification rule","content":{"application/json":{"schema":{"type":"object"},"examples":{"Notification rule":{"description":"Notification rule","value":{"notificationRuleName":"testwebhook","severity":"Medium","alarmName":"BFD_Node_Up","accountDetails":"noreply@cisco.com","webHookEnabled":true,"webhookUsername":"admin","webhookPassword":"admin","webhookUrl":"https://localhost:8444","updatedBy":"admin","devicesAttached":"1712133e-0246-4281-8152-3317b796d2bc","emailThreshold":5,"accountDetailsArray":["noreply@cisco.com"]}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"},"examples":{"Notification rule":{"description":"Notification rule","value":"{\n \"accountDetails\": \"noreply@cisco.com\",\n \"accountDetailsArray\": [\n \"noreply@cisco.com\"\n ]\n \"alarmName\": \"BFD_Node_Up\",\n \"devicesAttached\": \"1712133e-0246-4281-8152-3317b796d2bc\",\n \"emailEnabled\": true,\n \"emailThreshold\": 5,\n \"notificationRuleName\": \"testwebhook\",\n \"severity\": \"Medium\",\n \"updatedBy\": \"admin\",\n \"webHookEnabled\": true,\n \"webhookPassword\": \"admin\",\n \"webhookUrl\": \"https://localhost:8444\",\n \"webhookUsername\": \"admin\",\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/notifications/rules":{"get":{"tags":["Monitoring - Alarms Notification"],"description":"Get all rules or specific notification rule by its Id ","operationId":"getNotificationRule","parameters":[{"name":"ruleId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsRulesResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"delete":{"tags":["Monitoring - Alarms Notification"],"description":"Delete notification rule","operationId":"deleteNotificationRule","parameters":[{"name":"ruleId","in":"query","description":"Rule Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/opentaccase/authcode":{"get":{"tags":["Tools - TAC Cases"],"description":"Gets Access Token for SSO Logjn","operationId":"oauthAccess","parameters":[{"name":"code","in":"query","schema":{"type":"string"}},{"name":"redirect","in":"query","schema":{"type":"string"}},{"name":"isRefreshNeeded","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Access Token":{"description":"Access Token","value":{"access_token":"emQHZjOpma4gfco2c14BShVrdAqQ","refresh_token":"6cGDKZhHbYRR1ySrVpeKVmtIBSJifPopC8k5NeXVRW","id_token":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjJNc1VCbzE3Rnl4QVpMUVhGVHpqQVdoX2htcyJ9.eyJzdWIiOiJzaG9hYmFzdSIsImF1ZCI6InZtYW5hZ2Vfc2NtX2NsaWVudCIsImp0aSI6IlNKa1pKYWNsNkE4SVJ6UlBOTTFNbkMiLCJpc3MiOiJodHRwczovL2Nsb3Vkc3NvLXRlc3QuY2lzY28uY29tIiwiaWF0IjoxNjQ5ODM1ODcyLCJleHAiOjE2NDk4MzYxNzIsInBpLnNyaSI6Ikp4N1dJcmp4U1hDdFJuZ0hiT2tQRzhyV0MtYy4uVm45ZyIsImFjciI6InN0ZG5vbWZhIn0.IErZIsHsytpseCO1ReE-Y1i37bST3NPDnbHRiBInO8xhM6L0cbb7f7OhvWnKTSTaFQ_n-qDcG9iqCPZsNBGVX_e88L48S39QTn8OKndNfOmbmqZwkl5chno_6zUgXK-TsVWBKov3jEH2tC0TWRApIl0q9JGXkbrIzWh0qDnEhdk0aMtQf0WyhYvxAjR6W5ErzcqvZOiYBcWcfL4oRzr8wf2kULv1Z9V69aKIucA_Sxs3HflgamqzUaRVafeJW2rtJcnM4hHVMRZ5rjRtVj7KJz1xiZs9AyVuBceaF_XFEmzLrHiEbeNfPdCX0DVZl39uJNO9Z0Fe9wdj3Kq-TEa-VQ","token_type":"Bearer","expires_in":3599}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"}},"/opentaccase/getClientID":{"get":{"tags":["Tools - TAC Cases"],"description":"Gets vManage Client ID","operationId":"getClientID","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Access Token":{"description":"Access Token","value":"{ client_id: xxxxxxxxx}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"}},"/opentaccase/scmwidget/{var}":{"get":{"tags":["Tools - TAC Cases"],"description":"Proxy API for SCM Widget","operationId":"getCall","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"banner.json (Files needed by scm to load widget )":{"description":"banner.json (Files needed by scm to load widget )","value":{"statusCode":"SUCCESS","webexCategoriesList":[{"categoryHeader":"Meetings","category":"Joining a meeting","techId":"81","techName":"Cloud and Hybrid Products","subTechId":"3604","subTechName":"Webex joining a meeting","problemCodeDescription":"Configuration Assistance","problemCode":"CONFIG_ASSISTANCE","labelKey":"webexcategory.joiningameeting.tooltip","customerActivity":"Configuration","containerType":"W","type":"webex","enableVA":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"},"post":{"tags":["Tools - TAC Cases"],"description":"Prxoy API for SCM Widget","operationId":"postCall","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"getAuthCodeUrl.json (Files needed by scm to load widget )":{"description":"getAuthCodeUrl.json (Files needed by scm to load widget )","value":"{CSRFTOKEN: \"1da3fee1-18c9-4cfd-a8ff-8fe28aafbbd7\",\napixAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=48cvgdjcuf72je6x37ztbv52&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fcase%2F\",\nlogoutURL: \"https://www-stage.cisco.com/autho/logout.html\",\nmaxAppReload: 5 ,\nmuleAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=f7371b79ebeb4c0f8a5a0052120c2efa&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fmule\",\nrmaAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=b69k7tfhs45wf59yfpcdu98c&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fauthcode%2Frmaapi\",\nstatus: \"SUCCESS\",\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"},"delete":{"tags":["Tools - TAC Cases"],"description":"Proxy API for SCM Widget","operationId":"deleteCall","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"banner.json (Files needed by scm to load widget )":{"description":"banner.json (Files needed by scm to load widget )","value":"{\"clientTrxId\":\"SCM-1650876738048-shoabasu\",\"errorMessages\":null,\"responseOut\":\"2022-04-25T08:52:19.369Z\",\"requestId\":\"02e8c630-c475-11ec-a61b-005056bc2cda\",\"recordCount\":1,\"\"responseDetails\":{\"draftNumber\":\"9010540440\"},\"messageId\":null,\"eventLog\":null,\"eventResult\":null,\"statusCode\":\"SUCCESS\"}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"}},"/partner":{"get":{"tags":["Partner - Registration"],"description":"Get all NMS partners","operationId":"getPartners","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Partners":{"description":"Partners","value":[{"name":"DNAC-test","partnerId":"dnac-test","type":"dnac","id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5","description":"dnac-test","owner":"admin","registrationDate":"1632900123277","devicesAttached":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"}},"/partner/aci/policy":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get ACI definitions","operationId":"getACIDefinitions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACI policy":{"description":"ACI policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"}},"/partner/aci/policy/dscpmapping/{partnerId}":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get DSCP policy","operationId":"getDscpMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSCP policy":{"description":"DSCP policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"},"post":{"tags":["Partner - ACI Policy Builder"],"description":"Create an ACI definition entry","operationId":"createDscpMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"ACI definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACI definition":{"description":"ACI definition","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Action Id":{"description":"Action Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write"},"delete":{"tags":["Partner - ACI Policy Builder"],"description":"Delete DSCP mapping","operationId":"deleteDscpMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Action Id":{"description":"Action Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write"}},"/partner/aci/policy/events/{partnerId}":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get ACI events","operationId":"getEvents","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}},{"name":"starttime","in":"query","description":"Start time","schema":{"type":"integer","format":"int64"}},{"name":"endtime","in":"query","description":"End time","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"ACI events":{"description":"ACI events","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"}},"/partner/aci/policy/prefixmapping/{partnerId}":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get prefix mapping","operationId":"getDataPrefixMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Prefix mapping":{"description":"Prefix mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"},"post":{"tags":["Partner - ACI Policy Builder"],"description":"Create data prefix mapping","operationId":"setDataPrefixMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Prefix definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Prefix definition":{"description":"Prefix definition","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Action Id":{"description":"Action Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write"}},"/partner/aci/policy/sequences":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get data prefix sequence","operationId":"getDataPrefixSequences","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Data prefix sequence":{"description":"Data prefix sequence","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"}},"/partner/dnac/sda/config/{partnerId}":{"post":{"tags":["Partner - DNAC SDA API"],"description":"Create SDA enabled device","operationId":"createSDAConfig","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device SDA configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device SDA configuration":{"description":"Device SDA configuration","value":{"header":{"generatedOn":1649645769219},"data":[{"deviceId":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","deviceConfig":"PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg=="}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Id":{"description":"Device Id","value":{"id":"push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Integration Management-write"}},"/partner/dnac/sda/device/{partnerId}":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get SDA enabled devices","operationId":"getSDAEnabledDevices","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices list":{"description":"Devices list","value":{"header":{"generatedOn":1649645769219},"data":[{"uuid":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","deviceId":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","reachability":"reachable","status":"normal","personality":"vedge","device-type":"normal","device-model":"C8000v","version":"17.06.01.0.1422","site-id":"500","platform":"x86_64","device-os":"next","state":"green","chassis-serial-number":"SSI130300YK","host-name":"vm5","system-ip":"172.16.255.15","serialNumber":"12345712","templateStatus":"Success","validity":"valid","configuredAaaUser":["admin"],"wanInterfaces":["GigabitEthernet1"],"discoveredDeviceInterfaces":["GigabitEthernet8","GigabitEthernet1","GigabitEthernet2"],"registrationDate":"1632900123277","devicesAttached":0,"loopback":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write"}},"/partner/dnac/sda/device/{partnerId}/{uuid}":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get SDA enabled devices detail","operationId":"getDeviceDetails","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}},{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string","example":"C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device detail list":{"description":"Device detail list","value":{"header":{"generatedOn":1649645769219},"data":[{"uuid":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","deviceId":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","reachability":"reachable","status":"normal","personality":"vedge","device-type":"normal","device-model":"C8000v","version":"17.06.01.0.1422","site-id":"500","platform":"x86_64","device-os":"next","state":"green","chassis-serial-number":"SSI130300YK","host-name":"vm5","system-ip":"172.16.255.15","serialNumber":"12345712","templateStatus":"Success","validity":"valid","configuredAaaUser":["admin"],"wanInterfaces":["GigabitEthernet1"],"discoveredDeviceInterfaces":["GigabitEthernet8","GigabitEthernet1","GigabitEthernet2"],"registrationDate":"1632900123277","devicesAttached":0,"loopback":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write"}},"/partner/dnac/sda/netconfconfig/{partnerId}":{"post":{"tags":["Partner - DNAC SDA API"],"description":"Create SDA enabled device from Netconf","operationId":"createSDAConfigFromNetconf","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device SDA configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device SDA configuration":{"description":"Device SDA configuration","value":{"header":{"generatedOn":1649645769219},"data":[{"deviceId":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","deviceConfig":"PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg=="}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template push Id":{"description":"Device template push Id","value":{"id":"push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Integration Management-write"}},"/partner/dnac/sda/site/{partnerId}":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get SDA enabled devices","operationId":"getSitesForPartner","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Sites":{"description":"Sites","value":{"header":{"generatedOn":1649645769219},"data":[{"partnerId":"dnac-test","sites":["400"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write"}},"/partner/dnac/sda/vpn":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get Overlay VPN list","operationId":"getOverlayVPNList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN list":{"description":"VPN list","value":{"header":{"generatedOn":1649645769219},"data":[{"vpnId":"33","vpnType":"configuredVPN"},{"vpnId":"0","vpnType":"vmanageVPN"},{"vpnId":"512","vpnType":"vmanageVPN"},{"vpnId":"65528","vpnType":"vmanageVPN"},{"vpnId":"Mgmt-intf","vpnType":"vmanageVPN"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"DNAC SDA-read,DNAC SDA-write,Integration Management-read,Integration Management-write"}},"/partner/vpn":{"get":{"tags":["Partner - Registration"],"description":"Get all VPNs","operationId":"getVPNList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN list":{"description":"VPN list","value":{"header":{"generatedOn":1649645769219},"data":[{"vpnId":"1","vpnType":"configuredVPN"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"}},"/partner/wcm/netconf/{nmsId}":{"post":{"tags":["Partner - WCM Configs"],"description":"Push device configs","operationId":"pushNetconfConfigs","parameters":[{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","format":"uuid","example":"58fca3a1-9703-464e-9454-7a9795d6e770"}}],"requestBody":{"description":"Netconf configuration","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Netconf configuration":{"description":"Netconf configuration","value":{"data":[{"deviceId":"C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0","deviceConfig":"ICA8bmF0aXZlIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLW5hdGl2ZSI+CiAgICAgICAgICAgICAgICA8c2VydmljZS1pbnNlcnRpb24+CiAgICAgICAgICAgICAgICAgICAgPGFwcG5hdi1jb250cm9sbGVyLWdyb3VwIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNlcnZpY2UtaW5zZXJ0aW9uIj4KICAgICAgICAgICAgICAgICAgICAgICAgPGdyb3VwLW5hbWU+QVBQUU9FLUFDRzwvZ3JvdXAtbmFtZT4KICAgICAgICAgICAgICAgICAgICAgICAgPGFwcHFvZS8+CiAgICAgICAgICAgICAgICAgICAgICAgIDxhcHBuYXYtY29udHJvbGxlcnM+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8YWRkcmVzcz4xOTIuMTY4LjAuMjwvYWRkcmVzcz4KICAgICAgICAgICAgICAgICAgICAgICAgPC9hcHBuYXYtY29udHJvbGxlcnM+CiAgICAgICAgICAgICAgICAgICAgPC9hcHBuYXYtY29udHJvbGxlci1ncm91cD4KICAgICAgICAgICAgICA8L3NlcnZpY2UtaW5zZXJ0aW9uPgogIDwvbmF0aXZlPg=="}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_template_configuration-40649f49-787a-4481-9b55-c13eabbde7f2"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Integration Management-write"}},"/partner/{partnerType}":{"get":{"tags":["Partner - Registration"],"description":"Get NMS partners by partner type","operationId":"getPartnersByPartnerType","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"type":"string"},"example":"dnac"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Partners":{"description":"Partners","value":[{"name":"DNAC-test","partnerId":"dnac-test","type":"dnac","id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5","description":"dnac-test","owner":"admin","registrationDate":"1632900123277","devicesAttached":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"},"post":{"tags":["Partner - Registration"],"description":"Register NMS partner","operationId":"registerPartner","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"type":"string","example":"dnac"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":[{"name":"DNAC-test","partnerId":"dnac-test","description":"dnac-test"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{"id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/partner/{partnerType}/map/{nmsId}":{"get":{"tags":["Partner - Registration"],"description":"List mapped devices for the partner","operationId":"getPartnerDevices","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"$ref":"#/components/schemas/PartnerType"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","format":"uuid","example":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Devices":{"description":"Devices","value":"[{ \"uuid\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"deviceId\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"reachability\": \"reachable\", \"status\": \"normal\", \"personality\": \"vedge\", \"device-type\": \"normal\", \"device-model\": \"C8000v\", \"version\": \"17.06.01.0.1422\", \"site-id\": \"500\", \"platform\": \"x86_64\", \"device-os\": \"next\", \"state\": \"green\", \"chassis-serial-number\": \"SSI130300YK\", \"host-name\": \"vm5\", \"system-ip\": \"172.16.255.15\", \"serialNumber\": \"12345712\", \"templateStatus\": \"Success\", \"validity\": \"valid\", \"configuredAaaUser\": [\"admin\"], \"wanInterfaces\": [\"GigabitEthernet1\"], \"discoveredDeviceInterfaces\": [\"GigabitEthernet8\",\"GigabitEthernet1\"\"GigabitEthernet2\"], \"registrationDate\": \"1632900123277\", \"devicesAttached\": 0, \"loopback\": []}]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write,Policy Configuration-write"},"post":{"tags":["Partner - Registration"],"description":"Map devices for the partner","operationId":"mapDevices","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"type":"string","example":"dnac"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","example":"341e4f9a-e72c-4d34-9c9a-e6c82248743f"}}],"requestBody":{"description":"List of devices","content":{"application/json":{"schema":{"type":"object"},"examples":{"List of devices":{"description":"List of devices","value":{"devices":["C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"},"delete":{"tags":["Partner - Registration"],"description":"Unmap all devices for the partner","operationId":"unmapDevices","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"$ref":"#/components/schemas/PartnerType"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","format":"uuid","example":"341e4f9a-e72c-4d34-9c9a-e6c82248743f"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/partner/{partnerType}/unmap/{nmsId}":{"post":{"tags":["Partner - Registration"],"description":"Unmap a set of devices for the partner","operationId":"deleteDeviceMapping","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"type":"string","example":"dnac"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","example":"341e4f9a-e72c-4d34-9c9a-e6c82248743f"}}],"requestBody":{"description":"List of devices","content":{"application/json":{"schema":{"type":"object"},"examples":{"List of devices":{"description":"List of devices","value":{"devices":["C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/partner/{partnerType}/{nmsId}":{"get":{"tags":["Partner - Registration"],"description":"Get NMS partners by partner type and Id","operationId":"getPartner","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"type":"string","example":"dnac"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","example":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partners":{"description":"Partners","value":[{"name":"DNAC-test","partnerId":"dnac-test","type":"dnac","id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5","description":"dnac-test","owner":"admin","registrationDate":"1632900123277","devicesAttached":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"},"put":{"tags":["Partner - Registration"],"description":"Update NMS partner details","operationId":"updatePartner","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"type":"string","example":"dnac"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","example":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{"name":"DNAC-test-new","description":"dnac-test-new"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"},"delete":{"tags":["Partner - Registration"],"description":"Delete NMS partner","operationId":"deletePartner","parameters":[{"name":"partnerType","in":"path","description":"Partner type","required":true,"schema":{"$ref":"#/components/schemas/PartnerType"}},{"name":"nmsId","in":"path","description":"NMS Id","required":true,"schema":{"type":"string","format":"uuid","example":"341e4f9a-e72c-4d34-9c9a-e6c82248743f"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/policy/wani/recommendation/process":{"post":{"tags":["Wani Recommendations"],"summary":"Apply recommendation to a centralized policy","description":"Applies recommendations to a centralized policy ","operationId":"applyWaniRecommendation","parameters":[{"name":"key","in":"query","description":"Key from vAnalytics to retrieve recommendation json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRecommendationRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/refreshtoken/{regionBaseUri}/{clientId}":{"get":{"tags":["Monitoring - SecureX Integration"],"description":"Get Access Token for SecureX Ribbon","operationId":"getSecureXRefreshToken","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/resourcepool/resource/vpn":{"get":{"tags":["Resource - Pool"],"description":"Get tenant device vpn resource","operationId":"getResources","parameters":[{"name":"tenantId","in":"query","description":"Tenant Organization Name","required":true,"schema":{"type":"string"}},{"name":"tenantVpn","in":"query","description":"Tenant Vpn Number","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Resources":{"description":"Resources","value":{"resourcePoolDataType":"vpn","tenantId":"Tenant Organization Name","tenantVpn":2,"deviceVpn":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Resource - Pool"],"description":"Create Vpn resource pool and return tenant device vpn","operationId":"createResources","requestBody":{"description":"create resources from resource pool","content":{"application/json":{"schema":{"type":"object"},"examples":{"Resources":{"description":"Resources","value":"{\n\t\"resourcePoolDataType\": \"vpn\",\n\t\"tenantId\": \"Tenant Organization Name\",\n\t\"tenantVpn\": 2,\n} "}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Resources":{"description":"Resources","value":{"resourcePoolDataType":"vpn","tenantId":"Tenant Organization Name","tenantVpn":2,"deviceVpn":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Resource - Pool"],"description":"Delete tenant device vpn and release the resource","operationId":"deleteResources","parameters":[{"name":"tenantId","in":"query","description":"Tenant Organization Name","required":true,"schema":{"type":"string"}},{"name":"tenantVpn","in":"query","description":"Tenant Vpn Number","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/restore/import":{"post":{"tags":["Scheduled Backup Restore"],"description":"Submit a previously backed up file and import the data and apply it to the configuraion database","operationId":"importScheduledBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/restore/remoteimport":{"post":{"tags":["Scheduled Backup Restore"],"description":"Remote import backup from a remote URL and import the data and apply it to the configuraion database","operationId":"remoteImportBackup","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/schedule/create":{"post":{"tags":["Scheduled Backup Restore"],"description":"create backup scheduler config-db and statstics database with startDateTime and persist to config-db","operationId":"scheduleBackup","requestBody":{"description":"schedule request information","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats setting":{"description":"Stats setting","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/schedule/list":{"get":{"tags":["Scheduled Backup Restore"],"description":"Get a schedule record for backup by scheduler id","operationId":"listSchedules","parameters":[{"name":"limit","in":"query","description":"size","schema":{"type":"integer","format":"int64","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get backup schedule ":{"description":"Get backup schedule ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/schedule/{schedulerId}":{"get":{"tags":["Scheduled Backup Restore"],"description":"Get a schedule record for backup by scheduler id","operationId":"getScheduleRecordForBackup","parameters":[{"name":"schedulerId","in":"path","description":"scheduler id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get backup schedule ":{"description":"Get backup schedule ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Scheduled Backup Restore"],"description":"Delete a schedule record for backup in vManage by scheduler id","operationId":"deleteSchedule","parameters":[{"name":"schedulerId","in":"path","description":"scheduler id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Delete backup scheduler job ":{"description":"Delete backup scheduler job ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sdavc/cloudconnector":{"get":{"tags":["SD AVC Cloud Connector"],"description":"Get SD_AVC Cloud Connector Config","operationId":"getCloudConnector","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["SD AVC Cloud Connector"],"description":"Disable SD_AVC Cloud Connector","operationId":"disableCloudConnector","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["SD AVC Cloud Connector"],"description":"Enable SD_AVC Cloud Connector","operationId":"enableCloudConnector","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sdavc/cloudconnector/status":{"get":{"tags":["SD AVC Cloud Connector"],"description":"Get SD_AVC Cloud Connector Status","operationId":"getCloudConnectorStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sdavc/customapps":{"get":{"tags":["System - Container"],"description":"Displays the user-defined applications","operationId":"getCustomApp","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Custom applications":{"description":"Custom applications","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sdavc/task/{taskId}":{"post":{"tags":["System - Container"],"description":"Activate container","operationId":"activateContainer","parameters":[{"name":"taskId","in":"path","description":"Task Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Container task config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Container task config":{"description":"Container task config","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sdavc/test":{"post":{"tags":["System - Container"],"description":"Test SD_AVC load balancer","operationId":"testLoadBalancer","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/security/policy/devicelist":{"get":{"tags":["Monitoring - Security Policy"],"summary":"security policy device list","description":"Get security policy device list ","operationId":"getSecurityPolicyDeviceList","responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyDeviceList"}}}}},"400":{"description":"bad input parameter"}}}},"/security/policy/fwall/device":{"post":{"tags":["Monitoring - Security Policy"],"summary":"firewall devices list","description":"Get firewall devices list ","operationId":"getPostFwallByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"firewall device query":{"description":"firewall device query","$ref":"examples/elasticsearch/monitoring/parameter_example/FwallDevice.json"}}}}},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLists"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Device Monitoring-read"}},"/security/policy/ips/device":{"post":{"tags":["Monitoring - Security Policy"],"summary":"ips alert devices list","description":"Get ips alert devices list ","operationId":"getPostIPSAlertByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"ips alert device query":{"description":"ips alert device query","$ref":"examples/elasticsearch/monitoring/parameter_example/IpsAlertDevice.json"}}}}},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLists"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Device Monitoring-read"}},"/security/policy/urlf/device":{"post":{"tags":["Monitoring - Security Policy"],"summary":"url filtering devices list","description":"Get url filtering devices list ","operationId":"getPostUrlFilteringByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"url filtering pass device query":{"description":"url filtering pass device query","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFilteringPassDevice.json"},"url filtering block device query":{"description":"url filtering block device query","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFilteringBlockDevice.json"},"url filtering exempt white/black list device query":{"description":"url filtering exempt white/black list device query","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFilteringExemptWitBlkListDevice.json"},"amp device query":{"description":"amp device query","$ref":"examples/elasticsearch/monitoring/parameter_example/AMPDevice.json"}}}}},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLists"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Device Monitoring-read"}},"/segment":{"get":{"tags":["Configuration - Segments"],"description":"Get network segments","operationId":"getSegments","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Segment list":{"description":"Segment list","value":{"data":[{"segmentName":"Discovered_VPN_10","segmentId":"10","id":"c952c18b-30b3-4f0b-b985-494693d7adfb","referenceCount":2},{"segmentName":"Discovered_VPN_65529","segmentId":"65529","id":"5dd3f122-e52f-437e-b5e5-5ae94ad09cd6","referenceCount":0},{"segmentName":"Discovered_VPN_20","segmentId":"20","id":"83b6309d-f61d-4ac5-9699-7d3c04a1caef","referenceCount":0},{"segmentName":"Discovered_VPN_40","segmentId":"40","id":"64b30b74-08e2-4b4b-81ca-d019c7e452d5","referenceCount":1}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Segments"],"description":"Create network segment","operationId":"createSegment","requestBody":{"description":"Network segment","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network segment":{"description":"Network segment","value":{"segmentName":"Discovered_VPN_80","segmentId":"80"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"bab577b9-e3c7-4385-abc1-d800dacb5f36"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/segment/{id}":{"get":{"tags":["Configuration - Segments"],"description":"Get network segment","operationId":"getSegment","parameters":[{"name":"id","in":"path","description":"Segment Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Segment list":{"description":"Segment list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Segments"],"description":"Edit network segment","operationId":"editSegment","parameters":[{"name":"id","in":"path","description":"Segment Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network segment","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network segment":{"description":"Network segment","value":"{{\n \"segmentName\":\"Discovered_VPN_80\",\n \"segmentId\":\"90\",\n \"id\":\"bab577b9-e3c7-4385-abc1-d800dacb5f36\",\n \"referenceCount\":0\n}}"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Segments"],"description":"Delete network segment","operationId":"deleteSegment","parameters":[{"name":"id","in":"path","description":"Segment Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/server/info":{"get":{"tags":["Monitoring - Server Info"],"description":"Get Server info","operationId":"createServerInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage server info":{"description":"vManage server info","value":{"Achitecture":"amd64","Available processors":8}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/serverlongpoll/event/poll/{partnerId}":{"get":{"tags":["Partner - Registration"],"description":"Retrieve registration change information","operationId":"getDataChangeInfo","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}},{"name":"event_id","in":"query","description":"Continuation token of ongoing event-polling session","schema":{"type":"string"}},{"name":"eventNames","in":"query","description":"Names of type of events to filter on","schema":{"type":"array","items":{"$ref":"#/components/schemas/EventName"}}},{"name":"wait_time","in":"query","description":"Maximum polling wait time in seconds","schema":{"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read"}},"/setting/configuration/webserver/certificate":{"get":{"tags":["Certificate Management - vManage"],"summary":"Retrieves Certificate Signing Request information","description":"Retrieves Certificate Signing Request information","operationId":"showInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,dca"},"put":{"tags":["Certificate Management - vManage"],"summary":"Import a signed web server certificate","description":"Import a signed web server certificate","operationId":"importCertificate","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"x-roles-required":"Settings-write"},"post":{"tags":["Certificate Management - vManage"],"summary":"Generate Certificate Signing Request","description":"Generate Certificate Signing Request","operationId":"getCSR","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"x-roles-required":"Settings-write"}},"/setting/configuration/webserver/certificate/getcertificate":{"get":{"tags":["Certificate Management - vManage"],"summary":"Get certificate for alias server","description":"Get certificate for alias server","operationId":"getCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/settings/banner":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve banner","description":"Retrieve banner","operationId":"getBanner","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/clientSessionTimeout":{"get":{"tags":["Configuration - Settings"],"summary":"Get client session timeout","description":"Get client session timeout","operationId":"getSessionTimout","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/analytics/dca":{"post":{"tags":["Configuration - Settings"],"summary":"Create analytics data file","description":"Create analytics data file","operationId":"createAnalyticsDataFile","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/certificate/{type}":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve certificate configuration value by type","description":"Retrieve certificate configuration value by type","operationId":"getCertConfiguration","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Settings"],"summary":"Update certificate configuration","description":"Update certificate configuration","operationId":"editCertConfiguration","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}},"post":{"tags":["Configuration - Settings"],"summary":"Add new certificate configuration","description":"Add new certificate configuration","operationId":"newCertConfiguration","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/googleMapKey":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve Google map key","description":"Retrieve Google map key","operationId":"getGoogleMapKey","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/maintenanceWindow":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve maintenance window","description":"Retrieve maintenance window","operationId":"getMaintenanceWindow","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/{type}":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve configuration value by type","description":"Retrieve configuration value by type","operationId":"getConfigurationBySettingType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Settings"],"summary":"Update configuration setting","description":"Update configuration setting","operationId":"editConfiguration","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}},"post":{"tags":["Configuration - Settings"],"summary":"Add new certificate configuration","description":"Add new certificate configuration","operationId":"newConfiguration","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/passwordPolicy":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve password policy from global settings","description":"Retrieve password policy from global settings","operationId":"getPasswordPolicy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/sig/datacenters/{type}/{tunneltype}/{devicetype}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"Get list of data centers for zscaler or umbrella","operationId":"getSigDataCenterList","parameters":[{"name":"type","in":"path","description":"Provider type","required":true,"schema":{"type":"string"}},{"name":"tunneltype","in":"path","description":"Type of the tunnel ipsec/gre","required":true,"schema":{"type":"string"}},{"name":"devicetype","in":"path","description":"Type of the device vedge/cedge","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sig/sigGlobalCredentials/{featureTemplateType}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"Get sig global credentials","operationId":"getSigGlobalCredentials","parameters":[{"name":"featureTemplateType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureTemplateType"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sig/umbrella/childOrg/{type}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"Get the list of child org IDs given the type management or device ","operationId":"getChildOrgs","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/authenticate":{"post":{"tags":["Smart License"],"description":"authenticate user for sle","operationId":"sleauthenticate","requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/fetchAccounts":{"get":{"tags":["Smart License"],"description":"fetch sava for sle","operationId":"fetchAccounts","parameters":[{"name":"mode","in":"query","description":"mode","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/fetchAllSa":{"get":{"tags":["Smart License"],"description":"fetch reports offline for sle","operationId":"fetchReports","requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"SLE":{"description":"SLE","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/fetchReportsForSa":{"get":{"tags":["Smart License"],"description":"fetch reports offline for sle","operationId":"fetchReports_1","parameters":[{"name":"saDomain","in":"query","description":"saDomain","required":true,"schema":{"type":"string"}},{"name":"saId","in":"query","description":"saId","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"SLE":{"description":"SLE","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/getUserSettings":{"get":{"tags":["Smart License"],"description":"get settings","operationId":"get settings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Devices":{"description":"Devices","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/removeSaVaSelection":{"post":{"tags":["Smart License"],"description":"get all licenses for sa/va","operationId":"syncLicenses","requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/syncLicenses":{"post":{"tags":["Smart License"],"description":"get all licenses for sa/va","operationId":"syncLicenses_1","requestBody":{"description":"Partner","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LicenseUplodFile"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"license":{"description":"license","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write"}},"/smartLicensing/uploadAck":{"post":{"tags":["Smart License"],"description":"upload ack file for sa/va","operationId":"uploadAck","requestBody":{"description":"Partner","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AckUplodFile"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"license":{"description":"license","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write"}},"/software/compliance/ip/origin/check":{"post":{"tags":["Utility - Security"],"description":"Block IP based on list","operationId":"checkGivenIpList","requestBody":{"description":"Device detail","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device detail":{"description":"Device detail","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IP validation status":{"description":"IP validation status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sslproxy/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get edge proxy certificate","operationId":"getProxyCertOfEdge","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge proxy certificate":{"description":"Edge proxy certificate","value":{"enterpriseCA":true,"vManageRootCA":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"put":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Upload device certificate","operationId":"updateCertificate","requestBody":{"description":"Upload device certificate","content":{"application/json":{"schema":{"type":"object"},"examples":{"Upload device certificate":{"description":"Upload device certificate","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","certificate":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{id: \"210c2bc2-5423-4a6b-9269-22eaf058d774\"}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/certificate/wanedge/{deviceId}":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Add SSL proxy wan edge","operationId":"addWANEdge","parameters":[{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cert state","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cert state":{"description":"Cert state","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/certificates":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Upload device certificates","operationId":"uploadCertificiates","requestBody":{"description":"Certificate file","content":{"multipart/form-data":{"schema":{"type":"object"},"examples":{"Certificate file":{"description":"Certificate file"}}}}},"responses":{"200":{"description":"Success"},"207":{"description":"Multi-status"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/csr":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get SSL proxy CSR","operationId":"getSslProxyCSR","parameters":[{"name":"deviceId","in":"query","description":"device UUID","required":true,"schema":{"type":"string","example":"8d86d8b2-2239-402e-9fef-467f7bad3f2f"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR":{"description":"CSR","value":{"csr":[{"hostCommonName":"vManageCA_vm12","csr":"-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n","last updated":"07 Apr 2022 07:56:17 UTC","commonName":"vManageCA","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/devicecertificates":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get certificate for all cEdges","operationId":"getAllDeviceCertificates","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":[{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate":{"description":"Certificate","value":{"header":{"generatedOn":1650355912089},"data":[{"certificate":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/devicecsr":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get CSR for all cEdges","operationId":"getAllDeviceCSR","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":[{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR":{"description":"CSR","value":{"header":{"generatedOn":1650354738278},"data":[{"csr":"-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n","uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/generate/csr/sslproxy":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"CSR request SSL proxy for edge","operationId":"generateSslProxyCSR","requestBody":{"description":"CSR request for edge","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR request for edge":{"description":"CSR request for edge"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Certificates-write"}},"/sslproxy/generate/vmanage/csr":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Generate CSR","operationId":"generateSSLProxyCSR","requestBody":{"description":"CSR request","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR request":{"description":"CSR request","value":{"commonName":"vManageCA","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com","intermediateCA":"true"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"ba6586b6-6caf-4eac-a6ae-ec4d57d0fe2c"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/list":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get SSL proxy certificate list","operationId":"getSslProxyList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Certificate list":{"description":"Certificate list","value":[{"deviceModel":"vedge-C8000V","chasisNumber":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","configuredHostname":"vm5","managementSystemIP":"172.16.255.15","deviceSerialNumber":"12345712","configuredSiteId":"500","commonName":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","csr":"-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n","serialNumber":"","@rid":1023,"last updated":"07 Apr 2022 09:07:34 UTC","certificate":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","state":"CSR_GENERATED","uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","scep":false,"expirationDate":"Apr 08 09:07:34 2022 UTC","hasCert":true,"hasCSR":true,"hasEnterpriseCert":false}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/renew":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Renew device certificate","operationId":"renewCertificate","requestBody":{"description":"Renew device certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Renew device certificate request":{"description":"Renew device certificate request","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"0ed22d4e-ba07-4828-9bd6-f3ea9d281513"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/revoke":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Revoke device certificate","operationId":"revokeCertificate","requestBody":{"description":"Revoke device certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Revoke device certificate request":{"description":"Revoke device certificate request","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","revokeReason":"Unspecified"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/revokerenew":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Revoke and renew device certificate","operationId":"revokeRenewCertificate","requestBody":{"description":"Revoke device certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Revoke and renew device certificate request":{"description":"Revoke and renew device certificate request","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","revokeReason":"Unspecified"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get certificate state","operationId":"getCertificateState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate State":{"description":"Certificate State","value":{"enterpriseCA":false,"vManageRootCA":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/settings/enterprise/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get enterprise certificate","operationId":"getEnterpriseCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise certificate":{"description":"Enterprise certificate","value":{"scep":false,"last updated":"07 Apr 2022 03:45:59 UTC","commonName":"OCSP-CA","enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Configure enterprise certificate","operationId":"setEnterpriseCert","requestBody":{"description":"Config enterprise certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise certificate request":{"description":"Enterprise certificate request","value":{"scep":"false","enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate":{"description":"Certificate","value":{"scep":false,"last updated":"07 Apr 2022 03:45:59 UTC","commonName":"OCSP-CA","enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/enterprise/rootca":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage enterprise root certificate","operationId":"getVManageEnterpriseRootCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise root certificate":{"description":"Enterprise root certificate","value":{"enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289","last updated":"07 Apr 2022 03:53:12 UTC"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Set vManage enterprise root certificate","operationId":"setEnterpriseRootCaCert","requestBody":{"description":"Set enterprise root CA request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise root CA":{"description":"Enterprise root CA","value":{"enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","intermediateCA":"true"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise root certificate":{"description":"Enterprise root certificate","value":{"enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289","last updated":"07 Apr 2022 03:53:12 UTC"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/vmanage/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage intermediate certificate","operationId":"getvManageCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage intermediate certificate":{"description":"vManage intermediate certificate","value":{"header":{"generatedOn":1649322823353},"data":[{"vManageRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","hostCommonName":"vManageCA_vm12","commonName":"vManageCA_vm12","fingerprint":"fcb9c623aa9022354fecd95b1f355e1372802aeb","last updated":"07 Apr 2022 07:56:17 UTC","intermediateCA":"true"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Set vManage root certificate","operationId":"setvManageintermediateCert","requestBody":{"description":"Set vManage intermediate CA request","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage intermediate CA":{"description":"vManage intermediate CA","value":{"data":[{"commonName":"vManageCA_vm12","vManageRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","intermediateCA":"true"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage intermediate certificate":{"description":"vManage intermediate certificate","value":{"header":{"generatedOn":1649318177975},"data":[{"vManageRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","hostCommonName":"vManageCA_vm12","commonName":"vManageCA_vm12","fingerprint":"fcb9c623aa9022354fecd95b1f355e1372802aeb","last updated":"07 Apr 2022 07:56:17 UTC","intermediateCA":"true"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/vmanage/csr":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage CSR","operationId":"getvManageCSR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage CSR":{"description":"vManage CSR","value":{"csr":[{"hostCommonName":"vManageCA_vm12","csr":"-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n","last updated":"07 Apr 2022 04:37:37 UTC","commonName":"vManageCA","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/settings/vmanage/rootca":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage root certificate","operationId":"getvManageRootCA","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage root certificate":{"description":"vManage root certificate","value":{"header":{"generatedOn":1649300400918},"data":[{"vManageRootCA":"...","publickey":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","csr":"-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n","hostCommonName":"vManageRootCa_vm12","last updated":"07 Apr 2022 02:59:59 UTC","uuid":"3a0733ad-3967-4f71-b4fc-a64c3f634366","fingerprint":"1aef4396ce2c71e5df49c448a5eb49b488e9305b","commonName":"vManageRootCa","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com","validity":"10"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Set vManage root certificate","operationId":"setvManageRootCA","requestBody":{"description":"Set vManage root CA request","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage root CA":{"description":"vManage root CA","value":{"commonName":"vManageRootCa","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","validity":10,"email":"name@cisco.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage root certificate":{"description":"vManage root certificate","value":{"id":"4aa25a65-b65a-443c-9ebf-21d1dee0ed20"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/statistics":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get statistics types","operationId":"getStatisticType","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Stats type":{"description":"Stats type","value":["interfacestatistics","eioltestatistics","providerdpistatistics","sulstatistics","qosstatistics","devicesystemstatusstatistics","bridgemacstatistics","dpistatistics","approutestatsstatistics","provideraggregatedappsdpistatistics","wlanclientinfostatistics","flowlogstatistics","urlf","fwall","vnfstatistics","umbrella","apphostingstatistics","utddaqioxstatistics","ipsalert","aggregatedappsdpistatistics","bridgeinterfacestatistics","artstatistics","trackerstatistics","cloudxstatistics","deviceevents","sleofflinereport","alarm","auditlog","deviceconfiguration","nwpi","nwpiflowraw","speedtest"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getStatsRawData_13","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/aggregation":{"get":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_14","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/parameter_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/parameter_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"},"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/response_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/response_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_14","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/parameter_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/parameter_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"},"generated by base class - Monitoring - Performance Monitor":{"description":"generated by base class - Monitoring - Performance Monitor","$ref":"examples/elasticsearch/monitoring/parameter_example/PerfmonPathChart.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/response_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/response_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"},"generated by base class - Monitoring - Performance Monitor":{"description":"generated by base class - Monitoring - Performance Monitor","$ref":"examples/elasticsearch/monitoring/response_example/Perfmon.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/app-agg/aggregation":{"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_13","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/parameter_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/parameter_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/response_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/response_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/apphosting":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatDataRawData_1","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatsRawData_1","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphosting/aggregation":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_1","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_1","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/apphosting/app-agg/aggregation":{"post":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_1","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/apphosting/csv":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_1","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphosting/doccount":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCount_4","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCountPost_3","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphosting/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get fields and type","operationId":"getStatDataFields_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphosting/page":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatBulkRawData_1","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_1","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphosting/query/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get query fields","operationId":"getStatQueryFields_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphostinginterface":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatDataRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatsRawData","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphostinginterface/aggregation":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/apphostinginterface/app-agg/aggregation":{"post":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/apphostinginterface/csv":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphostinginterface/doccount":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCount_3","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCountPost_2","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphostinginterface/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get fields and type","operationId":"getStatDataFields_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphostinginterface/page":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatBulkRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphostinginterface/query/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get query fields","operationId":"getStatQueryFields_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getStatDataRawData_2","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getStatsRawData_2","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"example":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/aggregation":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_2","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["100"],"field":"loss_percentage","type":"number","operator":"less"}]},"aggregation":{"field":[{"property":"local_color","sequence":1,"order":"asc"}],"metrics":[{"property":"loss_percentage","type":"avg"},{"property":"latency","type":"avg"},{"property":"jitter","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAggResp"}},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":" [\n {\n \"count\": 5,\n \"local_color\": \"3g\",\n \"loss_percentage\": 0\n \"jitter\": 0\n \"latency\": 0\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_2","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["100"],"field":"loss_percentage","type":"number","operator":"less"}]},"aggregation":{"field":[{"property":"local_color","sequence":1,"order":"asc"}],"metrics":[{"property":"loss_percentage","type":"avg"},{"property":"latency","type":"avg"},{"property":"jitter","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAggResp"}},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":" [\n {\n \"count\": 5,\n \"local_color\": \"3g\",\n \"loss_percentage\": 0\n \"jitter\": 0\n \"latency\": 0\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/app-agg/aggregation":{"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery9","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAppAggResp"}},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":[{"latency":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/csv":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_2","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":" blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/device/tunnel/summary":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get statistics for top applications per tunnel in a grid table","operationId":"getStatsAppRouteDeviceTunnelSummary","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTunnenSummarResp"}},"examples":{"Statistics for top application":{"description":"Statistics for top application","value":[{"name":"172.16.255.11:lte-172.16.255.15:3g","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.15:lte","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.16:3g","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.16:lte","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/device/tunnels":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get statistics for top applications per tunnel in a grid table","operationId":"getStatsAppRouteDeviceTunnels","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"examples":{"Tunnel top statistics":{"description":"Tunnel top statistics","value":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677160200123,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677159336845,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":3718,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:lte","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm1","id":"0q-JfoYB04cEz_Q-t9i_"},{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.2","local_color":"lte","src_ip":"10.0.101.1","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677160200123,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677159336845,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":3713,"dst_port":12366,"name":"172.16.255.11:lte-172.16.255.16:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm1","id":"za-JfoYB04cEz_Q-t9i_"},{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.2","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677160200123,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677159336845,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":3714,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:3g","sla_class_list":"0","tunnel_color":"3g:3g","host_name":"vm1","id":"zq-JfoYB04cEz_Q-t9i_"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/doccount":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get response count of a query","operationId":"getDocCount","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get response count of a query","operationId":"getDocCountPost","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/fec/aggregation":{"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregation data and fec recovery rate","operationId":"getAppRouteFecAgg","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["172.16.255.11:lte-172.16.255.14:lte","172.16.255.11:lte-172.16.255.15:3g"],"field":"name","type":"string","operator":"in"},{"value":["100"],"field":"loss_percentage","type":"number","operator":"less"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"state","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"loss_percentage","type":"avg"},{"property":"fecLossRecovery","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteFECAggResp"}},"examples":{"Aggregation data and fec recovery rate":{"description":"Aggregation data and fec recovery rate","value":" [\n {\n \"loss_percentage\": 0.1066624445851805,\n \"entry_time\": 1676892600000,\n \"count\": 1578,\n \"proto\": \"IPSEC\",\n \"name\": \"172.16.254.16:default-172.16.254.2:default\",\n \"state\": \"Up\",\n \"fecLossRecovery\": \"-\",\n },\n {\n \"loss_percentage\": 0.1266624445851805,\n \"entry_time\": 1676892600000,\n \"count\": 1579,\n \"proto\": \"IPSEC\",\n \"name\": \"172.16.254.16:default-172.16.254.3:default\",\n \"state\": \"Up\",\n \"fecLossRecovery\": \"-\",\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/fields":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get fields and type","operationId":"getStatDataFields_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteDocCountResponse"}},"example":[{"property":"vdevice_name","dataType":"string"},{"property":"host_name","dataType":"string"},{"property":"device_model","dataType":"string"},{"property":"statcycletime","dataType":"date"},{"property":"entry_time","dataType":"date"},{"property":"vip_idx","dataType":"number"},{"property":"local_system_ip","dataType":"string"},{"property":"remote_system_ip","dataType":"string"},{"property":"local_color","dataType":"string"},{"property":"remote_color","dataType":"string"},{"property":"proto","dataType":"string"},{"property":"window","dataType":"number"},{"property":"src_ip","dataType":"string"},{"property":"dst_ip","dataType":"string"},{"property":"src_port","dataType":"number"},{"property":"dst_port","dataType":"number"},{"property":"total","dataType":"number"},{"property":"latency","dataType":"number"},{"property":"loss_percentage","dataType":"number"},{"property":"jitter","dataType":"number"},{"property":"tx_pkts","dataType":"number"},{"property":"rx_pkts","dataType":"number"},{"property":"tx_octets","dataType":"number"},{"property":"rx_octets","dataType":"number"},{"property":"name","dataType":"string"},{"property":"loss","dataType":"number"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/page":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getStatBulkRawData_2","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteAggRespWithPageInfo"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.2","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677076800077,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677075936838,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":934,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:3g","sla_class_list":"0","tunnel_color":"3g:3g","host_name":"vm1","id":"-auReYYB04cEz_Q-IvdV"},{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.0.101.1","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677076800077,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677075936838,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":937,"dst_port":12366,"name":"172.16.255.11:lte-172.16.255.16:lte","sla_class_list":"0","tunnel_color":"lte:lte","host_name":"vm1","id":"_KuReYYB04cEz_Q-IvdV"},{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677076800077,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677075936838,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":938,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:lte","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm1","id":"_auReYYB04cEz_Q-IvdV"}],"pageInfo":{"startTime":"1677076800076","endTime":"1677076800077","scrollId":"FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFnRpX1duVm1rUmhpMVJUdGk1R05PWHcAAAAAAAAkbhZVMG9reER2Y1NtT1ZwM2lBYmpEWVZ3_10","hasMoreData":true,"count":10,"totalCount":1430}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_2","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteAggRespWithPageInfo"},"example":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1666941702257","endTime":"1666941699172","count":1000}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/query/fields":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get query fields","operationId":"getStatQueryFields_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query fields":{"description":"Query fields","value":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/transport/summary/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get application-aware routing statistics summary from device","operationId":"getAppRouteTransportSummaryType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":5}},{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteFECAggResp"}},"examples":{"Application-aware routing statistics summary":{"description":"Application-aware routing statistics summary","value":[{"entry_time":1676892600000,"loss_percentage":0,"color":"3g:3g","jitter":0,"latency":0,"app_probe_class":""},{"entry_time":1676818800000,"loss_percentage":0,"color":"3g:lte","jitter":0,"latency":0,"app_probe_class":""}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/transport/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get application-aware routing statistics from device","operationId":"getAppRouteTransportType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteTransportResp"},"example":[{"latency":0,"entry_time":1673524800000,"jitter":0,"color":"lte","loss_percentage":0,"app_probe_class":"None"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnel/{type}/summary":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel top statistics in as chart","operationId":"getAppRouteTunnelSummaryType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"examples":{"Tunnel top statistics":{"description":"Tunnel top statistics","value":{"value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnels/health/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel health","operationId":"getAppRouteTunnelHealth","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":3}},{"name":"last_n_minutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"deviceIP","in":"query","schema":{"type":"string"},"example":"172.16.255.11"},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTunnenSummarResp"}},"examples":{"Tunnel top statistics":{"description":"Tunnel top statistics","value":[{"name":"172.16.255.11:lte-172.16.255.16:lte","remote_system_ip":"172.16.255.16,","remote_color":"lte","remote-host-name":"vm6,","remote_site_id":"600,","remote_latitude":"32.0,","remote_longitude":"-88.0,","local_color":"gold,","local_system_ip":"172.16.255.11,","device-type":"vedge,","deviceClass":"viptela-router,","state":"Up,","vqoe_score":"10,","jitter":"0,","rx_octets":"0,","loss_percentage":"0,","latency":"0,","tx_octets":"0,","health":"green"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnels/summary/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel top statistics from device","operationId":"getAppRouteTunnelsSummaryType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteTransportResp"},"example":[{"name":"172.16.255.11:lte-172.16.255.16:3g","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.16:lte","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"app_probe_class":""}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnels/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel top statistics from device","operationId":"getAppRouteTunnelType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"example":{"value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/art":{"get":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getStatDataRawData_4","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getStatsRawData_4","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/art/aggregation":{"get":{"tags":["Monitoring - ART"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_4","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - ART"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_4","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/art/app-agg/aggregation":{"post":{"tags":["Monitoring - ART"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_3","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/art/csv":{"get":{"tags":["Monitoring - ART"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_4","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/art/doccount":{"get":{"tags":["Monitoring - ART"],"description":"Get response count of a query","operationId":"getCount_6","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - ART"],"description":"Get response count of a query","operationId":"getCountPost_5","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/art/fields":{"get":{"tags":["Monitoring - ART"],"description":"Get fields and type","operationId":"getStatDataFields_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/art/page":{"get":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getStatBulkRawData_4","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_4","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/art/query/fields":{"get":{"tags":["Monitoring - ART"],"description":"Get query fields","operationId":"getStatQueryFields_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bfd":{"get":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getStatDataRawData_5","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getStatsRawData_5","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bfd/aggregation":{"get":{"tags":["Monitoring - BFD"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_5","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - BFD"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_5","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/bfd/app-agg/aggregation":{"post":{"tags":["Monitoring - BFD"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_4","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/bfd/csv":{"get":{"tags":["Monitoring - BFD"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_5","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bfd/doccount":{"get":{"tags":["Monitoring - BFD"],"description":"Get response count of a query","operationId":"getCount_7","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - BFD"],"description":"Get response count of a query","operationId":"getCountPost_6","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bfd/fields":{"get":{"tags":["Monitoring - BFD"],"description":"Get fields and type","operationId":"getStatDataFields_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bfd/page":{"get":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getStatBulkRawData_5","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_5","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bfd/query/fields":{"get":{"tags":["Monitoring - BFD"],"description":"Get query fields","operationId":"getStatQueryFields_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgeinterface":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatDataRawData_6","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatsRawData_6","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgeinterface/aggregation":{"get":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_6","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_6","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/bridgeinterface/app-agg/aggregation":{"post":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_5","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/bridgeinterface/csv":{"get":{"tags":["Monitoring - Bridge"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_6","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgeinterface/doccount":{"get":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCount_8","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCountPost_7","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgeinterface/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get fields and type","operationId":"getStatDataFields_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgeinterface/page":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatBulkRawData_6","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_6","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgeinterface/query/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get query fields","operationId":"getStatQueryFields_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgemac":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatDataRawData_7","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatsRawData_7","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgemac/aggregation":{"get":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_7","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_7","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/bridgemac/app-agg/aggregation":{"post":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_6","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/bridgemac/csv":{"get":{"tags":["Monitoring - Bridge"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_7","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgemac/doccount":{"get":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCount_9","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCountPost_8","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgemac/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get fields and type","operationId":"getStatDataFields_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgemac/page":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatBulkRawData_7","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_7","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgemac/query/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get query fields","operationId":"getStatQueryFields_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cflowd":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getStatDataRawData_9","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getStatsRawData_9","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/aggregation":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_9","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cflowd"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_9","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/cflowd/app-agg/aggregation":{"post":{"tags":["Monitoring - Cflowd"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_8","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/cflowd/applications":{"get":{"tags":["Monitoring - Cflowd"],"description":"Generate cflowd flows list in a grid table","operationId":"createFlowsGrid","parameters":[{"name":"vpn","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"limit","in":"query","description":"Limit","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Flows":{"description":"Flows","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/applications/summary":{"get":{"tags":["Monitoring - Cflowd"],"description":"Generate cflowd flows list in a grid table","operationId":"createFlowssummary","parameters":[{"name":"limit","in":"query","description":"Limit","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Flows":{"description":"Flows","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/csv":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_9","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/device/applications":{"get":{"tags":["Monitoring - Cflowd"],"description":"Generate cflowd flows list in a grid table","operationId":"createFlowDeviceData","parameters":[{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Flows":{"description":"Flows","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/doccount":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get response count of a query","operationId":"getCount_11","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Cflowd"],"description":"Get response count of a query","operationId":"getCountPost_10","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cflowd/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get fields and type","operationId":"getStatDataFields_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cflowd/page":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getStatBulkRawData_9","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_9","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/query/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get query fields","operationId":"getStatQueryFields_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cloudx":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getStatDataRawData_10","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getStatsRawData_10","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cloudx/aggregation":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_10","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_10","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/cloudx/app-agg/aggregation":{"post":{"tags":["Monitoring - CloudExpress"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_9","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/cloudx/csv":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_10","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cloudx/doccount":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get response count of a query","operationId":"getCount_12","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get response count of a query","operationId":"getCountPost_11","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cloudx/fields":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get fields and type","operationId":"getStatDataFields_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cloudx/page":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getStatBulkRawData_10","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_10","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cloudx/query/fields":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get query fields","operationId":"getStatQueryFields_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/collect":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Start stats collect","operationId":"startStatsCollection","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"ActivateDataCollection":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/collect/thread/status":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get stats collect thread report","operationId":"generateStatsCollectThreadReport","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Process thread report":{"description":"Process thread report","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/collection/reset/{processQueue}":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Reset stats collect thread report","operationId":"resetStatsCollection","parameters":[{"name":"processQueue","in":"path","description":"Process queue","required":true,"schema":{"type":"integer","format":"int64","default":-1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"statisticsCollectionReset":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/csv":{"get":{"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_13","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/demomode":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Enable statistic demo mode","operationId":"enableStatisticsDemoMode","parameters":[{"name":"enable","in":"query","description":"Demo mode flag","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Demo mode":{"description":"Demo mode","value":{"DemoMode":"Stats collection interval: 1 minute, Stats Processing interval: 1 min"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/device":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getStatDataRawData_15","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getStatsRawData_15","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/device/aggregation":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_16","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_17","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/device/app-agg/aggregation":{"post":{"tags":["Monitoring - Device Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_15","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/device/csv":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_15","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/device/doccount":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get response count of a query","operationId":"getCount_16","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get response count of a query","operationId":"getCountPost_16","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/device/fields":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get fields and type","operationId":"getStatDataFields_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/device/page":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getStatBulkRawData_16","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_15","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/device/query/fields":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get query fields","operationId":"getStatQueryFields_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/devicehealth/history":{"get":{"tags":["Monitoring - Device Health"],"summary":"Device health history data","description":"Get all device health history ","operationId":"getDeviceHealthHistory","parameters":[{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthHistoryItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/devicehealth/overview/{type}":{"get":{"tags":["Monitoring - Device Health"],"summary":"Device health overview data","description":"Get all device health overview ","operationId":"getDeviceHealthOverview","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"personality","in":"query","schema":{"type":"string","enum":["vsmart","vbond","vmanage","vedge"],"default":"vedge"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceHealthOverview"}}}},"400":{"description":"bad input parameter"}}}},"/statistics/doccount":{"get":{"description":"Get response count of a query","operationId":"getCount_14","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"description":"Get response count of a query","operationId":"getCountPost_14","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/download/{processType}/fetchvManageList":{"get":{"tags":["Monitoring - Stats Download"],"operationId":"fetchList","parameters":[{"name":"processType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}":{"get":{"tags":["Monitoring - Stats Download"],"description":"Downloading stats file","operationId":"download_1","parameters":[{"name":"processType","in":"path","description":"Process type","required":true,"schema":{"type":"string"}},{"name":"fileType","in":"path","description":"File type","required":true,"schema":{"type":"string"}},{"name":"queue","in":"path","description":"Queue name","required":true,"schema":{"type":"string"}},{"name":"deviceIp","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}},{"name":"token","in":"path","description":"Token","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/download/{processType}/filelist":{"post":{"tags":["Monitoring - Stats Download"],"description":"Downloading list of stats file","operationId":"downloadList","parameters":[{"name":"processType","in":"path","description":"Possible types are: remoteprocessing, dr","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/dpi":{"get":{"tags":["Monitoring - DPI"],"description":"Get DPI stats raw data","operationId":"getDPIStatsRawData","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get DPI stats raw data","operationId":"getDPIStatsRawDataPost","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/agg-app/aggregation":{"post":{"tags":["Monitoring - DPI"],"description":"Get raw aggregated data and display applications with the highest utilization for a device","operationId":"getAggAppDataPost","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1.1.60.7"],"field":"vdevice_name","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/dpi/aggregation":{"get":{"tags":["Monitoring - DPI"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getDPIStatsAggregationData","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get raw aggregated data and display applications with the highest utilization for a device","operationId":"getDPIStatsAggregationDataPost","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1.1.60.7"],"field":"vdevice_name","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/dpi/applications":{"get":{"tags":["Monitoring - DPI"],"description":"Get detailed DPI application flows list in a grid table","operationId":"getAggAppFlows","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAppResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/statistics/dpi/applications/summary":{"get":{"tags":["Monitoring - DPI"],"description":"Get detailed DPI application flows summary","operationId":"getAggAppFlowsSummary","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAppResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/csv":{"get":{"tags":["Monitoring - DPI"],"description":"Get raw data with optional query as CSV","operationId":"getDPIStatsRawDataAsCSV","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/device/application/flowcount":{"get":{"tags":["Monitoring - DPI"],"description":"Get application flow count per tunnel","operationId":"getDPIDeviceAppUniqueFlowCount","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"interval","in":"query","required":true,"schema":{"type":"string"}},{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"window","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"family","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/device/applications":{"get":{"tags":["Monitoring - DPI"],"description":"Get DPI application flows device aggregation data","operationId":"getDPIDeviceAppAggregationData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAppResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/statistics/dpi/device/details/applications":{"get":{"tags":["Monitoring - DPI"],"description":"Get detailed DPI device and application list","operationId":"getDPIDeviceAppDetails","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAppDetailResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/doccount":{"get":{"tags":["Monitoring - DPI"],"description":"Get response count of a query","operationId":"getDPIStatsCount","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get response count of a query","operationId":"getDPIStatsCountPost","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/fields":{"get":{"tags":["Monitoring - DPI"],"description":"Get fields and type","operationId":"getDPIFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"fields":{"description":"fields","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/pktdup/aggregation":{"post":{"tags":["Monitoring - DPI"],"description":"Get time series aggregation data for packet duplication for an application over TLOCs if available","operationId":"getDPIStatsAggregationDataForPacketDup","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FecAndPktDupResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/query/fields":{"get":{"tags":["Monitoring - DPI"],"description":"Get query fields","operationId":"getDPIQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"fields":{"description":"fields","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/recovery/aggregation":{"post":{"tags":["Monitoring - DPI"],"description":"Get aggregation data and fec recovery rate if available","operationId":"getDPIStatsAggregationDataForFec","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FecAndPktDupResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/eiolte":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getStatDataRawData_8","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getStatsRawData_8","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/eiolte/aggregation":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_8","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_8","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/eiolte/app-agg/aggregation":{"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_7","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/eiolte/csv":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_8","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/eiolte/doccount":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get response count of a query","operationId":"getCount_10","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get response count of a query","operationId":"getCountPost_9","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/eiolte/fields":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get fields and type","operationId":"getStatDataFields_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/eiolte/page":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getStatBulkRawData_8","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_8","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/eiolte/query/fields":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get query fields","operationId":"getStatQueryFields_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/endpointTracker":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getStatDataRawData_18","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]},"size":10000}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"entry_time":"1623811598645","tracker_name":"track1","vmanage_system_ip":"172.16.255.15","host_name":"vm5","vdevice_name":"172.16.255.15","device_model":"vedge-CSR-1000v","vpn_idx":2,"tracker_status":"DOWN","rtt_avg":4,"rtt_min":0,"rtt_max":42,"tenant":"default","statcycletime":"1623813001149","id":"xELMEnoBED2frxv5D_e_"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getStatsRawData_18","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/endpointTracker/aggregation":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_19","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_20","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/endpointTracker/app-agg/aggregation":{"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_18","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/endpointTracker/csv":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_18","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/endpointTracker/doccount":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get response count of a query","operationId":"getCount_19","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get response count of a query","operationId":"getCountPost_19","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/endpointTracker/fields":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get fields and type","operationId":"getStatDataFields_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/endpointTracker/page":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getStatBulkRawData_19","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_18","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/endpointTracker/query/fields":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get query fields","operationId":"getStatQueryFields_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fields":{"get":{"description":"Get fields and type","operationId":"getStatDataFields_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/flowlog":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get stats raw data","operationId":"getStatDataRawData_26","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Flowlog"],"description":"Get stats raw data","operationId":"getStatsRawData_25","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/flowlog/aggregation":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_27","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Flowlog"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_29","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/flowlog/app-agg/aggregation":{"post":{"tags":["Monitoring - Flowlog"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_26","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/flowlog/csv":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_26","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/flowlog/doccount":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get response count of a query","operationId":"getCount_27","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Flowlog"],"description":"Get response count of a query","operationId":"getCountPost_27","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/flowlog/fields":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get fields and type","operationId":"getStatDataFields_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/flowlog/page":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get stats raw data","operationId":"getStatBulkRawData_27","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Flowlog"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_26","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/flowlog/query/fields":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get query fields","operationId":"getStatQueryFields_29","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fwall":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getStatDataRawData_23","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getStatsRawData_23","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/fwall/aggregation":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_24","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_25","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/fwall/app-agg/aggregation":{"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_23","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/fwall/csv":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_23","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/fwall/doccount":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get response count of a query","operationId":"getCount_24","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get response count of a query","operationId":"getCountPost_24","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fwall/fields":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get fields and type","operationId":"getStatDataFields_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fwall/page":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getStatBulkRawData_24","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_23","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/fwall/query/fields":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get query fields","operationId":"getStatQueryFields_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getStatDataRawData_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceQuery"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getStatsRawData_11","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.55.16"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceRespWithPageInfo"}},"examples":{"QueryFields":{"description":"QueryFields","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/aggregation":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24000"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","system","vmanage_system","eth0","loopback65528","ge0/0"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"}},"examples":{"Aggregated Data":{"description":"Aggregated Data","value":[{"entry_time":1673766000000,"count":1,"interface":"eth0","tx_kbps":0,"rx_kbps":1},{"entry_time":1673766000000,"count":1,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"eth0","tx_kbps":1.8333333333333333,"rx_kbps":0.8333333333333334},{"entry_time":1673769600000,"count":6,"interface":"ge0/0","tx_kbps":0.3333333333333333,"rx_kbps":2.8333333333333335},{"entry_time":1673769600000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":2,"interface":"system","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"ge0/0","tx_kbps":5,"rx_kbps":48.833333333333336},{"entry_time":1673771400000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_11","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","ge0/2","ge0/4","ge0/7","loopback1","loopback2"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggResp"}},"examples":{"Aggregated Data":{"description":"Aggregated Data","value":[{"entry_time":1673766000000,"count":1,"interface":"eth0","tx_kbps":0,"rx_kbps":1},{"entry_time":1673766000000,"count":1,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"eth0","tx_kbps":1.8333333333333333,"rx_kbps":0.8333333333333334},{"entry_time":1673769600000,"count":6,"interface":"ge0/0","tx_kbps":0.3333333333333333,"rx_kbps":2.8333333333333335},{"entry_time":1673769600000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":2,"interface":"system","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"ge0/0","tx_kbps":5,"rx_kbps":48.833333333333336},{"entry_time":1673771400000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/app-agg/aggregation":{"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_10","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["2400"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","system","vmanage_system","eth0","loopback65528","ge0/0"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/ccapacity/distribution":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get bandwidth distribution","operationId":"getBandwidthDistribution","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapacityResp"},"examples":{"Bandwidth Distribution":{"description":"Bandwidth Distribution","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1.1.60.7"],"field":"vdevice_name","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/csv":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"example":"{\n \"blob\": https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd\n}"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/doccount":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get response count of a query","operationId":"getCount10","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get response count of a query","operationId":"getCountPost_12","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/fields":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get fields and type","operationId":"getStatDataFields_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceDocCountRequest"}},"examples":{"Interface Fields":{"description":"Interface Fields","value":[{"property":"entry_time","dataType":"date"},{"property":"vip_idx","dataType":"number"},{"property":"statcycletime","dataType":"date"},{"property":"vdevice_name","dataType":"string"},{"property":"device_model","dataType":"string","display":"keyvalue"},{"property":"host_name","dataType":"string"},{"property":"vpn_id","dataType":"number"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/page":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getStatBulkRawData_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"},"examples":{"Response with page info":{"description":"Response with page info","value":[{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"system","tx_octets":0,"oper_status":"Up","rx_errors":0,"bw_down":10000,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Up","bw_up":10000,"interface_type":"logical","tenant":"default","entry_time":1673958142101,"vip_time":1673958142101,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":284,"host_name":"vm11","vpn_id":0,"id":"RQG-v4UBrf5pDUb4VeQc"},{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"ge0/5","tx_octets":0,"oper_status":"Down","rx_errors":0,"bw_down":0,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Down","bw_up":0,"interface_type":"physical","tenant":"default","entry_time":1673958414824,"vip_time":1673958414825,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":293,"host_name":"vm11","vpn_id":0,"id":"TgG-v4UBrf5pDUb4VeQc"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_11","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.55.16"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/query/fields":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get query fields","operationId":"getStatQueryFields_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface Query Fields":{"description":"Interface Query Fields","value":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"Event Time","options":[{"enableDateFields":false,"number":"1","value":"Last 1 hour","key":"last_1_hour"},{"enableDateFields":false,"number":"3","value":"Last 3 hours","key":"last_3_hours"},{"enableDateFields":false,"number":"6","value":"Last 6 hours","key":"last_6_hours"},{"enableDateFields":false,"number":"12","value":"Last 12 hours","key":"last_12_hours"},{"enableDateFields":false,"number":"24","isSelected":true,"value":"Last 24 hours","key":"last_24_hours"},{"enableDateFields":false,"number":"168","value":"Last 7 days","key":"last_168_hours"},{"enableDateFields":true,"value":"Custom","key":"custom"}]}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/type":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get statistics per interface","operationId":"getStatisticsPerInterface","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceAggResp"},"examples":{"Interface by type":{"description":"Interface by type","value":[{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"system","tx_octets":0,"oper_status":"Up","rx_errors":0,"bw_down":10000,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Up","bw_up":10000,"interface_type":"logical","tenant":"default","entry_time":1673958142101,"vip_time":1673958142101,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":284,"host_name":"vm11","vpn_id":0,"id":"RQG-v4UBrf5pDUb4VeQc"},{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"ge0/5","tx_octets":0,"oper_status":"Down","rx_errors":0,"bw_down":0,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Down","bw_up":0,"interface_type":"physical","tenant":"default","entry_time":1673958414824,"vip_time":1673958414825,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":293,"host_name":"vm11","vpn_id":0,"id":"TgG-v4UBrf5pDUb4VeQc"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/ipsalert":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getStatDataRawData_21","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getStatsRawData_21","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/ipsalert/aggregation":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_22","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_23","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/ipsalert/app-agg/aggregation":{"post":{"tags":["Monitoring - IPsAlert"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_21","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/ipsalert/csv":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_21","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/ipsalert/doccount":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get response count of a query","operationId":"getCount_22","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get response count of a query","operationId":"getCountPost_22","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/ipsalert/fields":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get fields and type","operationId":"getStatDataFields_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/ipsalert/page":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getStatBulkRawData_22","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_21","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/ipsalert/query/fields":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get query fields","operationId":"getStatQueryFields_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/on-demand/queue":{"get":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"gets current on-demand queue entries","operationId":"getQueueEntries","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue Entries":{"description":"Queue Entries","value":{"entries":[{"status":"COMPLETED","complete":true,"data_type":"ConnectionEvents","tenant_id":"default","start_time":0,"creationTime":1640765713644,"value":48,"completionTime":1640765718372,"end_time":0,"startProcessingTime":1640765717682,"time_period":"LAST_N_HOURS","id":"0a43d31b-fde9-400a-b0ed-319f72115323","device_id":"172.16.255.11"},{"status":"QUEUED","complete":false,"data_type":"DPI","tenant_id":"default","start_time":0,"creationTime":1640764758920,"value":24,"completionTime":0,"end_time":0,"startProcessingTime":0,"time_period":"LAST_N_HOURS","id":"93629fed-ec81-4f37-9c85-24b577191c9c","device_id":"10.0.1.17"},{"status":"COMPLETED","complete":true,"data_type":"DPI","tenant_id":"default","start_time":0,"creationTime":1640765915038,"value":48,"completionTime":1640765918258,"end_time":0,"startProcessingTime":1640765917678,"time_period":"LAST_N_HOURS","id":"d9111cd6-59ab-482c-bd95-41fdaba9fc5b","device_id":"172.16.255.11"},{"status":"QUEUED","complete":false,"data_type":"ConnectionEvents","tenant_id":"default","start_time":0,"creationTime":1640767377708,"value":24,"completionTime":0,"end_time":0,"startProcessingTime":0,"time_period":"LAST_N_HOURS","id":"544ce0e1-9f57-4266-b789-ed50d043761c","device_id":"10.0.1.17"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"},"post":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"Create on-demand troubleshooting queue entry","operationId":"createQueueEntry","requestBody":{"description":"On-demand queue entry","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"device_id":"10.0.1.17","data_type":"DPI","time_period":"LAST_N_HOURS","value":24}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"complete":false,"creationTime":1641373054019,"startProcessingTime":0,"completionTime":0,"id":"bc4e2dbe-a226-4a01-aa1a-1859978014d3","device_id":"169.254.10.10","data_type":"DPI","time_period":"LAST_N_HOURS","tenant_id":"a200c754-22bc-4a99-b0b9-a2957755e3ba","value":3,"start_time":0,"end_time":0,"status":"QUEUED"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/on-demand/queue/properties":{"get":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"gets current size of on-demand queue","operationId":"getQueueProperties","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue size is 2":{"description":"Queue size is 2","value":{"tenant_current_size":2,"max_size":20,"tenant_max_size":5}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/on-demand/queue/{entryId}":{"put":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"Updates on-demand troubleshooting queue entry","operationId":"updateQueueEntry","parameters":[{"name":"entryId","in":"path","description":"Entry Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"On-demand queue entry","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"device_id":"10.0.1.17","data_type":"DPI","time_period":"LAST_N_HOURS","value":24}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"id":"ac031e7b-9c6e-4375-8589-ad503f9d52d2","device_id":"10.0.1.17","data_type":"DPI","time_period":"LAST_N_HOURS","value":24}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"},"delete":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"removes on-demand queue entry","operationId":"deleteQueueEntry","parameters":[{"name":"entryId","in":"path","description":"Entry Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-write"}},"/statistics/page":{"get":{"description":"Get stats raw data","operationId":"getStatBulkRawData_14","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getPostStatBulkRawData_13","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/perfmon/aggregation":{"post":{"tags":["Monitoring - Performance Monitor"],"summary":"one site one application line chart data","description":"Get one application one site line chart data ","operationId":"getPostAggregationDataByQuery_3","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"all paths chart query string":{"description":"all paths chart query string","$ref":"examples/elasticsearch/monitoring/parameter_example/PerfmonPathChart.json"}}}}},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSiteChartItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/application/heatmap/detail":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"single applicaiton site health detail in a time range","description":"Get single applicaiton site health detail in a time range ","operationId":"getApplicationHeatMapDetail","parameters":[{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"siteid","in":"query","schema":{"type":"string"}},{"name":"start_time","in":"query","description":"Heatmap single box entry_time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"heatmap_time","in":"query","description":"Heatmap generation time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"],"default":"12"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationHeatMapDetail"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/perfmon/application/site/health":{"post":{"tags":["Monitoring - Performance Monitor"],"summary":"one site one application health data","description":"Get one application health for one site ","operationId":"getApplicationSiteHealth","parameters":[{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"all paths table query string":{"description":"all paths table query string","$ref":"examples/elasticsearch/monitoring/parameter_example/PerfmonPathTable.json"}}}}},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSiteItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/application/sites/health":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"all sites one application health data","description":"Get one application health for all sites ","operationId":"getApplicationSitesHealth","parameters":[{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"isHeatMap","in":"query","schema":{"type":"boolean","default":false}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSitesItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/applications/site/health":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"one site all applications health data","description":"Get all applications health for one site ","operationId":"getApplicationsSiteHealth","parameters":[{"name":"siteid","in":"query","required":true,"schema":{"type":"string"}},{"name":"isHeatMap","in":"query","schema":{"type":"boolean","default":false}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"includeUsage","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationsSiteItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/applications/sites/health":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"all sites all applications health data","description":"Get applications health for all sites ","operationId":"getApplicationsSitesHealth","parameters":[{"name":"isHeatMap","in":"query","schema":{"type":"boolean","default":false}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"includeUsage","in":"query","schema":{"type":"boolean","default":false}},{"name":"useCache","in":"query","description":"Use cache data","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationsSitesItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/process":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Process stats data","operationId":"processStatisticsData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"ActivateDataProcessing":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/process/counters":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get statistics processing counters","operationId":"getStatisticsProcessingCounters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Statistics processing counters":{"description":"Statistics processing counters","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/process/status":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get stats process report","operationId":"generateStatsProcessReport","parameters":[{"name":"processQueue","in":"query","description":"Process queue","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Process report":{"description":"Process report","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/process/thread/status":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get stats process thread report","operationId":"generateStatsProcessThreadReport","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Process thread report":{"description":"Process thread report","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/qos":{"get":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getStatDataRawData_13","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSRespWithPageInfo"}},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getStatsRawData12","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSRespWithPageInfo"}},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/aggregation":{"get":{"tags":["Monitoring - QoS"],"description":"Monitoring - QoS","operationId":"getAggregationDataByQuery_13","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"queue_name","sequence":1,"size":20}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"tx_bytes_in_kbps","type":"avg","order":"desc"},{"property":"drop_in_kbps","type":"avg"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSAggResp"}},"example":[{"entry_time":1678924800000,"count":72,"queue_name":"Queue4","drop_in_kbps":0,"tx_bytes_in_kbps":0},{"entry_time":1678924800000,"count":72,"queue_name":"Queue5","drop_in_kbps":0,"tx_bytes_in_kbps":0},{"entry_time":1678924800000,"count":72,"queue_name":"Queue6","drop_in_kbps":0,"tx_bytes_in_kbps":0}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_13","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"queue_name","sequence":1,"size":20}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"tx_bytes_in_kbps","type":"avg","order":"desc"},{"property":"drop_in_kbps","type":"avg"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSAggResp"}},"example":" [\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue4\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n },\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue5\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n },\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue6\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n }"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/app-agg/aggregation":{"post":{"tags":["Monitoring - QoS"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_12","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"number","operator":"in"}]},"aggregation":{"field":[{"property":"queue_name","sequence":1,"size":20}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"tx_bytes_in_kbps","type":"avg","order":"desc"},{"property":"drop_in_kbps","type":"avg"},{"property":"jitter","type":"avg"}],"sort":[{"property":"entry_time","type":"date","order":"desc"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSAggResp"}},"example":[{"entry_time":1678881600000,"count":72,"queue_name":"Queue1","drop_in_kbps":0,"jitter":0,"tx_bytes_in_kbps":0},{"entry_time":1678881600000,"count":72,"queue_name":"Queue2","drop_in_kbps":0,"jitter":0,"tx_bytes_in_kbps":0}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/csv":{"get":{"tags":["Monitoring - QoS"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV12","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"example":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/doccount":{"get":{"tags":["Monitoring - QoS"],"description":"Get response count of a query","operationId":"getCount13","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get response count of a query","operationId":"getCountPost13","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/fields":{"get":{"tags":["Monitoring - QoS"],"description":"Get fields and type","operationId":"getStatDataFields13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/page":{"get":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getStatBulkRawData_13","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QoSRespWithPageInfo"},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"647394800045,","endTime":"1647394800047,","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10,","hasMoreData":"true,","count":"5,","totalCount":11140}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData12","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QoSRespWithPageInfo"},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"647394800045,","endTime":"1647394800047,","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10,","hasMoreData":"true,","count":"5,","totalCount":11140}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/query/fields":{"get":{"tags":["Monitoring - QoS"],"description":"Get query fields","operationId":"getStatQueryFields_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QoSQueryFieldsResp"},"example":{"data":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"Event Time","options":[{"enableDateFields":false,"number":"1","value":"Last 1 hour","key":"last_1_hour"},{"enableDateFields":false,"number":"3","value":"Last 3 hours","key":"last_3_hours"},{"enableDateFields":false,"number":"6","value":"Last 6 hours","key":"last_6_hours"},{"enableDateFields":false,"number":"12","value":"Last 12 hours","key":"last_12_hours"},{"enableDateFields":false,"number":"24","isSelected":true,"value":"Last 24 hours","key":"last_24_hours"},{"enableDateFields":false,"number":"168","value":"Last 7 days","key":"last_168_hours"},{"enableDateFields":true,"value":"Custom","key":"custom"}]}],"header":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/query/fields":{"get":{"description":"Get query fields","operationId":"getStatQueryFields_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sdra/headends":{"get":{"tags":["Monitoring - SDRA"],"description":"Get SD-WAN Remote Access Head-end summary","operationId":"getSdraHeadendSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdraHeadendSummary"},"examples":{"SDRA Head-end Summary":{"description":"SDRA Head-end Summary","value":" {\n \"ipsec_enabled\": 5,\n \"sslvpn_enabled\": 2,\n }\n"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sdra/sessions":{"get":{"tags":["Monitoring - SDRA"],"description":"Get SD-WAN Remote Access session summary","operationId":"getSdraSessionSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdraSessionSummary"},"examples":{"SDRA Session Summary":{"description":"SDRA Session Summary","value":" {\n \"total\": {\n \"ipsec_anyconnect\": 50,\n \"ipsec_soho\": 20,\n \"ipsec_unknown\": 25,\n \"sslvpn_anyconnect\": 200,\n }, \"top\": [\n {\n \"system_ip\": \"1.1.1.1\",\n \"site_id\": 10,\n \"host_name\": vm10,\n \"ipsec_anyconnect\": 3,\n \"ipsec_soho\": 5,\n \"ipsec_unknown\": 11,\n \"sslvpn_anyconnect\": 0,\n },\n {\n \"system_ip\": \"2.2.2.2\",\n \"site_id\": 20,\n \"host_name\": vm20,\n \"ipsec_anyconnect\": 0,\n \"ipsec_soho\": 0,\n \"ipsec_unknown\": 0,\n \"sslvpn_anyconnect\": 85,\n }\n ]\n }\n"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/settings/disable/devicelist/{indexName}":{"get":{"tags":["Monitoring - Status"],"description":"Get list of disabled devices for a statistics index","operationId":"getDisabledDeviceList","parameters":[{"name":"indexName","in":"path","description":"Index name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Disabled device list":{"description":"Disabled device list","value":["172.16.255.14"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read"},"put":{"tags":["Monitoring - Status"],"description":"Update list of disabled devices for a statistics index","operationId":"updateStatisticsDeviceList","parameters":[{"name":"indexName","in":"path","description":"Index name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Disabled device","content":{"application/json":{"schema":{"type":"object"},"examples":{"Disabled device":{"description":"Disabled device","value":["172.16.255.14"]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update status":{"description":"Update status","value":{"response":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/statistics/settings/status":{"get":{"tags":["Monitoring - Status"],"description":"Get statistics settings","operationId":"getStatisticsSettings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Statistics settings":{"description":"Statistics settings","value":[{"indexName":"approutestatsstatistics","status":"enable","displayName":"Approute"},{"indexName":"interfacestatistics","status":"enable","displayName":"Interface"},{"indexName":"wlanclientinfostatistics","status":"enable","displayName":"Wlan Client Info"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,dca"},"put":{"tags":["Monitoring - Status"],"description":"Update statistics settings","operationId":"updateStatisticsSettings","requestBody":{"description":"Stats setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats setting":{"description":"Stats setting","value":[{"indexName":"interfacestatistics","status":"enable"}]}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,dca"}},"/statistics/settings/status/device":{"get":{"tags":["Monitoring - Status"],"description":"Get list of enabled device for statistics index","operationId":"getEnabledIndexForDevice","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enabled device":{"description":"Enabled device","value":["interfacestatistics","eioltestatistics","sulstatistics","qosstatistics","devicesystemstatusstatistics","bridgemacstatistics","dpistatistics","approutestatsstatistics","wlanclientinfostatistics","flowlogstatistics","urlf","fwall","vnfstatistics","umbrella","apphostingstatistics","utddaqioxstatistics","ipsalert","aggregatedappsdpistatistics","bridgeinterfacestatistics","artstatistics","trackerstatistics","cloudxstatistics"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read"}},"/statistics/sitehealth":{"get":{"description":"Get stats raw data","operationId":"getStatDataRawData_3","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getStatsRawData_3","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sitehealth/aggregation":{"get":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_3","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/parameter_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/parameter_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"},"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/response_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/response_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_15","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/parameter_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/parameter_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"},"generated by base class - Monitoring - Performance Monitor":{"description":"generated by base class - Monitoring - Performance Monitor","$ref":"examples/elasticsearch/monitoring/parameter_example/PerfmonPathChart.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/response_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/response_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"},"generated by base class - Monitoring - Performance Monitor":{"description":"generated by base class - Monitoring - Performance Monitor","$ref":"examples/elasticsearch/monitoring/response_example/Perfmon.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/sitehealth/app-agg/aggregation":{"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_2","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/parameter_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/parameter_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/parameter_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/parameter_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/parameter_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/parameter_example/UmbrellaPatterns.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"examples/elasticsearch/monitoring/response_example/Events.json"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"examples/elasticsearch/monitoring/response_example/InterfaceStatistics.json"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"examples/elasticsearch/monitoring/response_example/QoS.json"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"examples/elasticsearch/monitoring/response_example/IPsAlert.json"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"examples/elasticsearch/monitoring/response_example/DPI.json"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"examples/elasticsearch/monitoring/response_example/UmbrellaPatterns.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/sitehealth/common":{"get":{"tags":["Monitoring - SiteHealth Monitor"],"summary":"sitehealth data","description":"Get all site health ","operationId":"getSiteHealth","parameters":[{"name":"isHeatMap","in":"query","schema":{"type":"boolean","default":false}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"interval","in":"query","schema":{"type":"integer","format":"int32","default":30}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"start_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"end_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"includeDetails","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteHealthItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/sitehealth/csv":{"get":{"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_3","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sitehealth/doccount":{"get":{"description":"Get response count of a query","operationId":"getCount_5","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"description":"Get response count of a query","operationId":"getCountPost_4","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sitehealth/fields":{"get":{"description":"Get fields and type","operationId":"getStatDataFields_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sitehealth/page":{"get":{"description":"Get stats raw data","operationId":"getStatBulkRawData_3","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getPostStatBulkRawData_3","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sitehealth/query/fields":{"get":{"description":"Get query fields","operationId":"getStatQueryFields_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sitehealth/topology":{"get":{"tags":["Monitoring - SiteHealth Monitor"],"summary":"sitehealth data","description":"Get all site health topology ","operationId":"getSiteHealthTopology","parameters":[{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"start_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"end_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteHealthTopologyItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/speedtest":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatDataRawData_27","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatsRawData_27","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/speedtest/aggregation":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_29","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_31","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/speedtest/app-agg/aggregation":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_28","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/speedtest/csv":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_28","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/speedtest/doccount":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get response count of a query","operationId":"getCount_29","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get response count of a query","operationId":"getCountPost_29","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/speedtest/fields":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get fields and type","operationId":"getStatDataFields_30","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/speedtest/page":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatBulkRawData_29","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_28","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/speedtest/query/fields":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get query fields","operationId":"getStatQueryFields_31","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get security connection events stats raw data","operationId":"getSulStatDataRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","fw_zone_pair":"ulogging_in2out","statcycletime":1616121001459,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616120034778,"create_time":1616120009235,"fw_dst_zone":"ulogging_z_out","end_time":1616120024267,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_src_zone":"ulogging_z_in","fw_policy":"p1","src_port":34128,"start_time":1616120009235,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"103.235.46.39","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"_dlRSHgBQcANHsKKdbP0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get stats raw data","operationId":"getStatsRawData_14","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","fw_zone_pair":"ulogging_in2out","statcycletime":1616121001459,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616120034778,"create_time":1616120009235,"fw_dst_zone":"ulogging_z_out","end_time":1616120024267,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_src_zone":"ulogging_z_in","fw_policy":"p1","src_port":34128,"start_time":1616120009235,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"103.235.46.39","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"_dlRSHgBQcANHsKKdbP0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sul/connections/aggregation":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_15","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated each result":{"description":"Aggregated each result","value":{"data":[{"latency":0.6404125644631974}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_16","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","statcycletime":1616170802027,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616170026992,"create_time":1616170001492,"end_time":1616170016505,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_policy":"p1","src_port":53105,"start_time":1616170001492,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"90.130.70.73","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"uNlJS3gBQcANHsKKW_5s"}],"pageInfo":{"startTime":"1615956601540","endTime":"1616170802027","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500","hasMoreData":false,"count":14,"totalCount":14}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/sul/connections/app-agg/aggregation":{"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_14","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":{"data":[{"latency":0.6404125644631974}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/sul/connections/csv":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_14","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1"],"field":"vpn_id","type":"int","operator":"in"},{"value":["p1"],"field":"fw_policy","type":"string","operator":"in"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sul/connections/doccount":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get response count of a query","operationId":"getCount_15","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get response count of a query","operationId":"getCountPost_15","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections/fields":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get fields and type","operationId":"getStatDataFields_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections/filter/policy_name/{policyType}":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get filter Policy Name list","operationId":"getFilterPolicyNameList","parameters":[{"name":"policyType","in":"path","description":"Policy type","required":true,"schema":{"type":"string","enum":["zoneBasedFW","intrusionPrevention","urlFiltering","advancedMalwareProtection"]}},{"name":"query","in":"query","description":"query string","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"field":"vdevice_name","type":"string","operator":"in","value":["172.16.255.15"]}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Filter Policy Name list":{"description":"Filter Policy Name list","value":[{"fw_policy":"FW-Block-AV"},{"fw_policy":"FW-Block-p2p"},{"fw_policy":"FW_policy1"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections/page":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get stats raw data","operationId":"getStatBulkRawData_15","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1"],"field":"vpn_id","type":"int","operator":"in"},{"value":["p1"],"field":"fw_policy","type":"string","operator":"in"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","statcycletime":1616170802027,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616170026992,"create_time":1616170001492,"end_time":1616170016505,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_policy":"p1","src_port":53105,"start_time":1616170001492,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"90.130.70.73","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"uNlJS3gBQcANHsKKW_5s"}],"pageInfo":{"startTime":"1615956601540","endTime":"1616170802027","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500","hasMoreData":false,"count":14,"totalCount":14}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_14","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1"],"field":"vpn_id","type":"int","operator":"in"},{"value":["p1"],"field":"fw_policy","type":"string","operator":"in"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","statcycletime":1616170802027,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616170026992,"create_time":1616170001492,"end_time":1616170016505,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_policy":"p1","src_port":53105,"start_time":1616170001492,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"90.130.70.73","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"uNlJS3gBQcANHsKKW_5s"}],"pageInfo":{"startTime":"1615956601540","endTime":"1616170802027","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500","hasMoreData":false,"count":14,"totalCount":14}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sul/connections/query/fields":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get query fields","operationId":"getStatQueryFields_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getStatDataRawData_16","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getStatsRawData_16","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/aggregation":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_17","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_18","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/system/app-agg/aggregation":{"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_16","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/system/cpu":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get device system CPU stats list","operationId":"createDeviceSystemCPUStat","parameters":[{"name":"query","in":"query","description":"Query filter","required":true,"schema":{"type":"string","example":"{\"query\":{\"condition\":\"AND\",\"rules\":[{\"value\":[\"1\"],\"field\":\"entry_time\",\"type\":\"date\",\"operator\":\"last_n_hours\"},{\"value\":[\"172.16.255.11\"],\"field\":\"vdevice_name\",\"type\":\"string\",\"operator\":\"in\"}]}}"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"mem_used":842211328,"disk_avail":7370178560,"device_model":"vedge-cloud","mem_cached":440655872,"mem_util":0.43,"min1_avg":1.05,"disk_used":168906752,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925196144,"runningp":0,"cpu_user":1.15,"cpu_idle_new":94.86,"vip_time":1656925196144,"min15_avg":1.08,"totalp":325,"cpu_idle":94.86,"mem_buffers":76447744,"cpu_system":3.99,"vmanage_system_ip":"172.16.255.11","min5_avg":1.07,"cpu_min1_avg":1.05,"mem_free":597938176,"vdevice_name":"172.16.255.11","vip_idx":6977,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.15,"cpu_system_new":3.99,"host_name":"vm1","cpu_min5_avg":1.07,"id":"ZE2UyIEBC5z8Ij_cxb8R"},{"mem_used":842907648,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.06,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925256204,"runningp":0,"cpu_user":10.17,"cpu_idle_new":76.16,"vip_time":1656925256205,"min15_avg":1.08,"totalp":326,"cpu_idle":76.16,"mem_buffers":76447744,"cpu_system":13.67,"vmanage_system_ip":"172.16.255.11","min5_avg":1.07,"cpu_min1_avg":1.06,"mem_free":596877312,"vdevice_name":"172.16.255.11","vip_idx":6978,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":10.17,"cpu_system_new":13.67,"host_name":"vm1","cpu_min5_avg":1.07,"id":"W02UyIEBC5z8Ij_cxb8R"},{"mem_used":842715136,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.02,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925316264,"runningp":0,"cpu_user":1.34,"cpu_idle_new":92.22,"vip_time":1656925316264,"min15_avg":1.08,"totalp":326,"cpu_idle":92.22,"mem_buffers":76447744,"cpu_system":6.44,"vmanage_system_ip":"172.16.255.11","min5_avg":1.06,"cpu_min1_avg":1.02,"mem_free":597069824,"vdevice_name":"172.16.255.11","vip_idx":6979,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.34,"cpu_system_new":6.44,"host_name":"vm1","cpu_min5_avg":1.06,"id":"XE2UyIEBC5z8Ij_cxb8R"},{"mem_used":842813440,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.01,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925376319,"runningp":0,"cpu_user":1.17,"cpu_idle_new":94.02,"vip_time":1656925376319,"min15_avg":1.07,"totalp":326,"cpu_idle":94.02,"mem_buffers":76447744,"cpu_system":4.81,"vmanage_system_ip":"172.16.255.11","min5_avg":1.04,"cpu_min1_avg":1.01,"mem_free":596971520,"vdevice_name":"172.16.255.11","vip_idx":6980,"cpu_min15_avg":1.07,"system_ip":"172.16.255.11","cpu_user_new":1.17,"cpu_system_new":4.81,"host_name":"vm1","cpu_min5_avg":1.04,"id":"XU2UyIEBC5z8Ij_cxb8R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/csv":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_16","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/doccount":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get response count of a query","operationId":"getCount_17","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get response count of a query","operationId":"getCountPost_17","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/fields":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get fields and type","operationId":"getStatDataFields_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/memory":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get device system memory stats list","operationId":"createDeviceSystemMemoryStat","parameters":[{"name":"query","in":"query","description":"Query filter","required":true,"schema":{"type":"string","example":"{\"query\":{\"condition\":\"AND\",\"rules\":[{\"value\":[\"1\"],\"field\":\"entry_time\",\"type\":\"date\",\"operator\":\"last_n_hours\"},{\"value\":[\"172.16.255.11\"],\"field\":\"vdevice_name\",\"type\":\"string\",\"operator\":\"in\"}]}}"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"mem_used":842715136,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.02,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925316264,"runningp":0,"cpu_user":1.34,"cpu_idle_new":92.22,"vip_time":1656925316264,"min15_avg":1.08,"totalp":326,"cpu_idle":92.22,"mem_buffers":76447744,"cpu_system":6.44,"vmanage_system_ip":"172.16.255.11","min5_avg":1.06,"cpu_min1_avg":1.02,"mem_free":597069824,"vdevice_name":"172.16.255.11","vip_idx":6979,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.34,"cpu_system_new":6.44,"host_name":"vm1","cpu_min5_avg":1.06,"id":"XE2UyIEBC5z8Ij_cxb8R"},{"mem_used":842813440,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.01,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925376319,"runningp":0,"cpu_user":1.17,"cpu_idle_new":94.02,"vip_time":1656925376319,"min15_avg":1.07,"totalp":326,"cpu_idle":94.02,"mem_buffers":76447744,"cpu_system":4.81,"vmanage_system_ip":"172.16.255.11","min5_avg":1.04,"cpu_min1_avg":1.01,"mem_free":596971520,"vdevice_name":"172.16.255.11","vip_idx":6980,"cpu_min15_avg":1.07,"system_ip":"172.16.255.11","cpu_user_new":1.17,"cpu_system_new":4.81,"host_name":"vm1","cpu_min5_avg":1.04,"id":"XU2UyIEBC5z8Ij_cxb8R"},{"mem_used":842711040,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441024512,"mem_util":0.43,"min1_avg":1.11,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925436376,"runningp":0,"cpu_user":1.24,"cpu_idle_new":93.19,"vip_time":1656925436376,"min15_avg":1.08,"totalp":326,"cpu_idle":93.19,"mem_buffers":76447744,"cpu_system":5.57,"vmanage_system_ip":"172.16.255.11","min5_avg":1.07,"cpu_min1_avg":1.11,"mem_free":597069824,"vdevice_name":"172.16.255.11","vip_idx":6981,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.24,"cpu_system_new":5.57,"host_name":"vm1","cpu_min5_avg":1.07,"id":"Xk2UyIEBC5z8Ij_cxb8R"},{"mem_used":842600448,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441069568,"mem_util":0.43,"min1_avg":1.04,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925496428,"runningp":0,"cpu_user":1.3,"cpu_idle_new":93.16,"vip_time":1656925496428,"min15_avg":1.07,"totalp":326,"cpu_idle":93.16,"mem_buffers":76447744,"cpu_system":5.54,"vmanage_system_ip":"172.16.255.11","min5_avg":1.05,"cpu_min1_avg":1.04,"mem_free":597135360,"vdevice_name":"172.16.255.11","vip_idx":6982,"cpu_min15_avg":1.07,"system_ip":"172.16.255.11","cpu_user_new":1.3,"cpu_system_new":5.54,"host_name":"vm1","cpu_min5_avg":1.05,"id":"X02UyIEBC5z8Ij_cxb8R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/page":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getStatBulkRawData_17","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_16","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/query/fields":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get query fields","operationId":"getStatQueryFields_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/stats":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getStatDataRawData_17","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getStatsRawData_17","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/stats/aggregation":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_18","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_19","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/system/stats/app-agg/aggregation":{"post":{"tags":["Monitoring - System Status Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_17","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/system/stats/csv":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_17","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/stats/doccount":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get response count of a query","operationId":"getCount_18","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get response count of a query","operationId":"getCountPost_18","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/stats/fields":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get fields and type","operationId":"getStatDataFields_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/stats/page":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getStatBulkRawData_18","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_17","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/stats/query/fields":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get query fields","operationId":"getStatQueryFields_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/tunnelhealth/history":{"get":{"tags":["Monitoring - Tunnel Health"],"summary":"Tunnel health history data","description":"Get all tunnel health history ","operationId":"statisticsApprouteTunnelhealthHistoryGet","parameters":[{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthHistoryItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/tunnelhealth/overview/{type}":{"get":{"tags":["Monitoring - Tunnel Health"],"summary":"Tunnel health overview data","description":"Get all tunnel health overview ","operationId":"statisticsApprouteTunnelhealthOverviewTypeGet","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelHealthOverview"}}}},"400":{"description":"bad input parameter"}}}},"/statistics/umbrella":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getStatDataRawData_24","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getStatsRawData_24","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/umbrella/aggregation":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_25","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_26","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/umbrella/app-agg/aggregation":{"post":{"tags":["Monitoring - Umbrella"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_24","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/parameter_example/Umbrella.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"examples/elasticsearch/monitoring/response_example/Umbrella.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/umbrella/csv":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_24","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/umbrella/doccount":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get response count of a query","operationId":"getCount_25","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Umbrella"],"description":"Get response count of a query","operationId":"getCountPost_25","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/umbrella/fields":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get fields and type","operationId":"getStatDataFields_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/umbrella/page":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getStatBulkRawData_25","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_24","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/umbrella/query/fields":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get query fields","operationId":"getStatQueryFields_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/urlf":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getStatDataRawData_22","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getStatsRawData_22","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/urlf/aggregation":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_23","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_24","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/urlf/app-agg/aggregation":{"post":{"tags":["Monitoring - URL Filtering"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_22","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/parameter_example/URLFiltering.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"examples/elasticsearch/monitoring/response_example/URLFiltering.json"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/urlf/csv":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_22","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/urlf/doccount":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get response count of a query","operationId":"getCount_23","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get response count of a query","operationId":"getCountPost_23","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/urlf/fields":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get fields and type","operationId":"getStatDataFields_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/urlf/page":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getStatBulkRawData_23","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_22","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/urlf/query/fields":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get query fields","operationId":"getStatQueryFields_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/vnfstatistics":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getStatDataRawData_12","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getStatsRawData_12","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/vnfstatistics/aggregation":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_12","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_12","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/vnfstatistics/app-agg/aggregation":{"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_11","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/vnfstatistics/csv":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_12","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/vnfstatistics/doccount":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get response count of a query","operationId":"getCount_13","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get response count of a query","operationId":"getCountPost_13","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/vnfstatistics/fields":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get fields and type","operationId":"getStatDataFields_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/vnfstatistics/page":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getStatBulkRawData_12","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_12","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/vnfstatistics/query/fields":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get query fields","operationId":"getStatQueryFields_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/wlanclientinfo":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getStatDataRawData_19","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getStatsRawData_19","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/wlanclientinfo/aggregation":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_20","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_21","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/wlanclientinfo/app-agg/aggregation":{"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_19","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/wlanclientinfo/csv":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_19","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/wlanclientinfo/doccount":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get response count of a query","operationId":"getCount_20","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get response count of a query","operationId":"getCountPost_20","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/wlanclientinfo/fields":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get fields and type","operationId":"getStatDataFields_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/wlanclientinfo/page":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getStatBulkRawData_20","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_19","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/wlanclientinfo/query/fields":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get query fields","operationId":"getStatQueryFields_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/capture":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSessionInfoCapture","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/capture/disable/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"disablePacketCaptureSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/capture/download/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"downloadFile","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/capture/forcedisbale/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"forceStopPcapSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/capture/start/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"startPcapSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/capture/status/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getFileDownloadStatus","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/capture/stop/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"stopPcapSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/capture/vnicsInfo/{vnfId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getVnicInfoByVnfId","parameters":[{"name":"vnfId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/capture/{deviceUUID}/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"formPostPacketCapture","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSessionInfoLog","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/disable/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"disableDeviceLog","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/download/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"downloadDebugLog","parameters":[{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/renew/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"renewSessionInfo","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/search/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"searchDeviceLog","parameters":[{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/sessions":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSessions","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/sessions/clear/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"clearSession","parameters":[{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/type":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getLogType","parameters":[{"name":"uuid","in":"query","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/{logType}/{deviceUUID}/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"streamLog","parameters":[{"name":"logType","in":"path","description":"Log type","required":true,"schema":{"type":"string"}},{"name":"deviceUUID","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/log/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getDeviceLog","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},{"name":"logId","in":"query","schema":{"type":"integer","format":"int64","default":-1}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/nwpi":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatDataRawData_14","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatsRawData_26","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["2020-05-10T01:00:00 UTC","2020-05-10T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"},{"value":["172.16.255.15"],"field":"local_system_ip","type":"string","operator":"in"},{"value":["172.16.255.16"],"field":"remote_system_ip","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/stream/device/nwpi/activeFlowWithQuery":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get active flows for NWPI.","operationId":"activeFlowWithQuery","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveFlowResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/aggFlow":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get aggregated flow data for NWPI.","operationId":"getAggFlow","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","description":"trace state","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/aggregation":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_28","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_30","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/stream/device/nwpi/app-agg/aggregation":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_27","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/stream/device/nwpi/appQosData":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get QoS Application data for NWPI.","operationId":"getAppQosData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"receivedTimestamp","in":"query","description":"received timestamp","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/appQosState":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get QoS Application state to received timestamp mapping for NWPI.","operationId":"getAppQosState","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/concurrentData":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get concurrent data for NWPI.","operationId":"getConcurrentData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/concurrentDomainData":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get concurrent domain data for NWPI.","operationId":"getConcurrentDomainData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/csv":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_27","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/stream/device/nwpi/currentTimestamp":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getCurrentTimestamp","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/device/blist/del":{"delete":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Delete Device BlackList for NWPI.","operationId":"delDeviceBlack","parameters":[{"name":"systemIp","in":"query","description":"systemIp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceBlistDeleteResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/device/blist/get":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Device BlackList for NWPI.","operationId":"getDeviceBList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceBlistResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/deviceInfoBySite":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get device and interface data by site","operationId":"getDevicesAndInterfacesBySite","parameters":[{"name":"site_id","in":"query","description":"Site id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/doccount":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get response count of a query","operationId":"getCount_28","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get response count of a query","operationId":"getCountPost_28","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["2021-05-10T01:00:00 UTC","2021-11-30T01:30:00 UTC"],"field":"entry_time","type":"date","operator":"between"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/domainMetric":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getDomainMetric","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"domain","in":"query","description":"domain name","required":true,"schema":{"type":"string"}},{"name":"firstTimestamp","in":"query","description":"first timestamp of xAxis","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lastTimestamp","in":"query","description":"last timestamp of xAxis","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/eventAppHopList":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Trace Application and HopList for NWPI.","operationId":"getEventAppHopList","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","schema":{"type":"string"}},{"name":"version","in":"query","description":"source-site-vmanage-version","schema":{"type":"string"}},{"name":"serverSideKey","in":"query","description":"Server Side Key","schema":{"type":"string"}},{"name":"clientSideKey","in":"query","description":"Client Side Key","schema":{"type":"string"}},{"name":"vpn","in":"query","description":"vpn","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"event app hop list":{"description":"event app hop list","value":"{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-hoplist\",\"application\": \"smtp\",\"upHopListInfo\": [[ {\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\"}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\"}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\"}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\"}]]}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventAppScoreBandwidth":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Trace Event Application Performance Score and Bandwidth for NWPI.","operationId":"getEventAppScoreBandwidth","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","schema":{"type":"string"}},{"name":"receivedTimestamp","in":"query","description":"received timestamp","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"serverSideKey","in":"query","description":"Server Side Key","schema":{"type":"string"}},{"name":"clientSideKey","in":"query","description":"Client Side Key","schema":{"type":"string"}},{"name":"version","in":"query","description":"source-site-vmanage-version","schema":{"type":"string"}},{"name":"vpn","in":"query","description":"vpn","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"event application score and bandwidth":{"description":"event application score and bandwidth","value":"{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-score-bandwidth\",\"data\": {\"received_timestamp\": 1647581328105,\"detail\": [{\"application\": \"smtp\",\"received_timestamp\":1647581328105,\"upHopListInfo\": [[{\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 249381,\"performanceScore\": 95,\"bandwidth\": 79998}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 683820,\"performanceScore\": 95,\"bandwidth\": 207353.2}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 15690,\"performanceScore\": 95,\"bandwidth\": 5598}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 20775,\"performanceScore\": 95,\"bandwidth\": 5472}]]}]}, \"tenant\":\"default\"}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventFlowFromAppHop":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Trace Event Flow From Application And Hop for NWPI.","operationId":"getEventFlowFromAppHop","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","schema":{"type":"string"}},{"name":"application","in":"query","description":"app name","schema":{"type":"string"}},{"name":"version","in":"query","description":"source-site-vmanage-version","schema":{"type":"string"}},{"name":"direction","in":"query","description":"direction","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"from","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","description":"to","required":true,"schema":{"type":"string"}},{"name":"deviceTraceId","in":"query","description":"deviceTraceId","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"serverSideKey","in":"query","description":"Server Side Key","schema":{"type":"string"}},{"name":"clientSideKey","in":"query","description":"Client Side Key","schema":{"type":"string"}},{"name":"vpn","in":"query","description":"vpn","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"event flow from app and hop":{"description":"event flow from app and hop","value":"{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-flow\",\"data\": {\"app_name\": \"smtp\",\"received_timestamp\": 1647581328105,\"direction\": \"upstream\",\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"intervalActiveFlow\": 7,\"intervalFinFlow\": 7,\"inspectedFlow\": 7,\"qosCongestedFlow\": 0,\"slaViolatedFlow\": 0,\"asymmetryFlow\": 0,\"fifNotClassifiledFlow\": 0,\"pathChangedFlow\": 0,\"policyBypassedFlow\": 0,\"wanAsymmetryFlow\": 0},\"tenant\":\"default\"}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventReadout":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Trace Event Readout for NWPI.","operationId":"getEventReadout","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventReadoutBySite":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get event Readout By Site","operationId":"getEventReadoutBySite","parameters":[{"name":"site_id","in":"query","description":"site id","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","description":"last_n_hours","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadData"},"examples":{"Get event Readout By Site":{"description":"Get event Readout By Site","value":{"data":[{"trace_id":160,"entry_time":1673499964222,"source_site":"500","device_ip":"N/A","vpn_id":"1","src_if":"N/A","src_ip":"N/A","src_port":"N/A","dst_ip":"N/A","dst_port":"N/A","src_pfx":"N/A","src_pfx_len":"N/A","dst_pfx":"N/A","dst_pfx_len":"N/A","app":"N/A","common_app":"N/A","app_grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace_name":"dd_test_0112_1","domain_mon":"disabled","qos_mon":"true","art_vis":"true","app_vis":"true","dia_vis":"N/A","hub_wan_vis":"true","sampling":"N/A","spl_intvl":"N/A","stop_time":1673503629842,"source_site_vmanage_version":"20.11.999-2486","state":"stopped","message":"Trace Stop successfully (auto stop)","warning":"","wan_drop_rate_threshold":5,"local_drop_rate_threshold":5,"detail":[{"application":"rtp-video","totalFlowNum":35,"dropSendPkts":[{"sendPkts":5485,"dropPkts":2072,"event":"LOCAL_DROP"}],"eventList":["FIF_DPI_NOT_CLASSIFIED","LOCAL_DROP"],"eventImpactedFlowNum":[{"event":"LOCAL_DROP","impactedFlowNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","impactedFlowNum":"8"}],"eventNum":[{"event":"LOCAL_DROP","eventNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","eventNum":"8"}],"eventHopStatistics":[{"event":"LOCAL_DROP","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"13","dropCauses":[{"dropCause":"MplsFragReq"}]}]},{"event":"FIF_DPI_NOT_CLASSIFIED","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"8","dropCauses":[]}]}],"eventHopTimeInfo":[{"eventHop":"FIF_DPI_NOT_CLASSIFIED+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"FIF_DPI_NOT_CLASSIFIED+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673499975847","endTime":"1673500050669","eventNum":"8"}]},{"eventHop":"LOCAL_DROP+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"LOCAL_DROP+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673500035854","endTime":"1673500053871","eventNum":"12"},{"startTime":"1673500032732","endTime":"1673500035864","eventNum":"2"}]}],"eventHopPolicyInfo":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/eventReadoutByTraces":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get event Readout By Traces","operationId":"getEventReadoutByTraces","parameters":[{"name":"trace_id","in":"query","description":"traceId","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"entry_time","in":"query","description":"entry_time","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadData"},"examples":{"Get event Readout By Traces":{"description":"Get event Readout By Traces","value":{"data":[{"trace_id":160,"entry_time":1673499964222,"source_site":"500","device_ip":"N/A","vpn_id":"1","src_if":"N/A","src_ip":"N/A","src_port":"N/A","dst_ip":"N/A","dst_port":"N/A","src_pfx":"N/A","src_pfx_len":"N/A","dst_pfx":"N/A","dst_pfx_len":"N/A","app":"N/A","common_app":"N/A","app_grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace_name":"dd_test_0112_1","domain_mon":"disabled","qos_mon":"true","art_vis":"true","app_vis":"true","dia_vis":"N/A","hub_wan_vis":"true","sampling":"N/A","spl_intvl":"N/A","stop_time":1673503629842,"source_site_vmanage_version":"20.11.999-2486","state":"stopped","message":"Trace Stop successfully (auto stop)","warning":"","wan_drop_rate_threshold":5,"local_drop_rate_threshold":5,"detail":[{"application":"rtp-video","totalFlowNum":35,"dropSendPkts":[{"sendPkts":5485,"dropPkts":2072,"event":"LOCAL_DROP"}],"eventList":["FIF_DPI_NOT_CLASSIFIED","LOCAL_DROP"],"eventImpactedFlowNum":[{"event":"LOCAL_DROP","impactedFlowNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","impactedFlowNum":"8"}],"eventNum":[{"event":"LOCAL_DROP","eventNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","eventNum":"8"}],"eventHopStatistics":[{"event":"LOCAL_DROP","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"13","dropCauses":[{"dropCause":"MplsFragReq"}]}]},{"event":"FIF_DPI_NOT_CLASSIFIED","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"8","dropCauses":[]}]}],"eventHopTimeInfo":[{"eventHop":"FIF_DPI_NOT_CLASSIFIED+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"FIF_DPI_NOT_CLASSIFIED+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673499975847","endTime":"1673500050669","eventNum":"8"}]},{"eventHop":"LOCAL_DROP+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"LOCAL_DROP+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673500035854","endTime":"1673500053871","eventNum":"12"},{"startTime":"1673500032732","endTime":"1673500035864","eventNum":"2"}]}],"eventHopPolicyInfo":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/fields":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get fields and type","operationId":"getStatDataFields_29","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/finalizedData":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getFinalizedData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/finalizedDomainData":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getFinalizedDomainData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/flowDetail":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getFlowDetail","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"flowId","in":"query","description":"flow id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/flowMetric":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getFlowMetric","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"flowId","in":"query","description":"flow id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"firstTimestamp","in":"query","description":"first timestamp of xAxis","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lastTimestamp","in":"query","description":"last timestamp of xAxis","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/getMonitorState":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getMonitorState","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/monitor/overrideStart":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"CXP Monitor Action - Override Start","operationId":"monitorOverrideStart","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Start CXP Monitor":{"description":"Start CXP Monitor","value":{"source-site":"500","duration":"5","vpn-id":"1","src-ip":"100.0.0.1","dst-ip":"200.0.0.1","app":"webex","src-if":"GigabitEthernet0/1","protocol":"1","src-port":"8080","dst-port":"8443","dscp-is-valid":"true","dscp":"1"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/monitor/start":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"CXP Monitor Action - Start","operationId":"monitorStart","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Start CXP Monitor":{"description":"Start CXP Monitor","value":{"source-site":"500","duration":"5","vpn-id":"1","src-ip":"100.0.0.1","dst-ip":"200.0.0.1","app":"webex","src-if":"GigabitEthernet0/1","protocol":"1","src-port":"8080","dst-port":"8443","dscp-is-valid":"true","dscp":"1"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/monitor/stop":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"CXP Monitor Action - Stop","operationId":"monitorStop","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Stop CXP Monitor":{"description":"Stop CXP Monitor","value":{"source-site":"500","duration":"5","vpn-id":"1","src-ip":"100.0.0.1","dst-ip":"200.0.0.1","app":"webex","src-if":"GigabitEthernet0/1","protocol":"1","src-port":"8080","dst-port":"8443","dscp-is-valid":"true","dscp":"1"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/nwpiDSCP":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getNwpiDscp","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/nwpiNbarAppGroup":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getNwpiNbarAppGroup","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/nwpiProtocol":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getNwpiProtocol","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/packetFeatures":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getPacketFeatures","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"flowId","in":"query","description":"flow id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/page":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatBulkRawData_28","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_27","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"string"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["100"],"operator":"greater"},"size":1,"sort":[{"field":"latency","type":"long","order":"asc"}],"fields":["latency"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19433402368,"disk_avail":9305391104,"device_model":"vmanage","mem_cached":6743166976,"mem_util":0.59,"min1_avg":1.02,"disk_used":5789564928,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393930306,"runningp":0,"cpu_user":7.18,"cpu_idle_new":89.78,"vip_time":1647393930306,"min15_avg":1.07,"totalp":2323,"cpu_idle":89.78,"mem_buffers":895946752,"cpu_system":3.04,"vmanage_system_ip":"169.254.10.2","min5_avg":1.06,"cpu_min1_avg":0.1275,"mem_free":5685383168,"vdevice_name":"172.16.255.201","vip_idx":83,"cpu_min15_avg":0.13375,"system_ip":"172.16.255.201","cpu_user_new":7.18,"cpu_system_new":3.04,"host_name":"vm201","cpu_min5_avg":0.1325,"id":"4ophkH8BPIGvVbrdtzXi"},{"mem_used":19544223744,"disk_avail":9304797184,"device_model":"vmanage","mem_cached":6744907776,"mem_util":0.6,"min1_avg":1.56,"disk_used":5790158848,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393990365,"runningp":0,"cpu_user":19.58,"cpu_idle_new":75.25,"vip_time":1647393990365,"min15_avg":1.11,"totalp":2324,"cpu_idle":75.25,"mem_buffers":897961984,"cpu_system":5.17,"vmanage_system_ip":"169.254.10.2","min5_avg":1.19,"cpu_min1_avg":0.195,"mem_free":5570805760,"vdevice_name":"172.16.255.201","vip_idx":84,"cpu_min15_avg":0.13875,"system_ip":"172.16.255.201","cpu_user_new":19.58,"cpu_system_new":5.17,"host_name":"vm201","cpu_min5_avg":0.14875,"id":"44phkH8BPIGvVbrdtzXi"},{"mem_used":19527507968,"disk_avail":9304543232,"device_model":"vmanage","mem_cached":6746238976,"mem_util":0.6,"min1_avg":1.11,"disk_used":5790412800,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394050422,"runningp":0,"cpu_user":5.18,"cpu_idle_new":92.16,"vip_time":1647394050422,"min15_avg":1.09,"totalp":2331,"cpu_idle":92.16,"mem_buffers":899567616,"cpu_system":2.66,"vmanage_system_ip":"169.254.10.2","min5_avg":1.12,"cpu_min1_avg":0.13875,"mem_free":5584584704,"vdevice_name":"172.16.255.201","vip_idx":85,"cpu_min15_avg":0.13625,"system_ip":"172.16.255.201","cpu_user_new":5.18,"cpu_system_new":2.66,"host_name":"vm201","cpu_min5_avg":0.14,"id":"5IphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10","hasMoreData":true,"count":5,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/stream/device/nwpi/preloadinfo":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getPreloadInfo","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/query/fields":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get query fields","operationId":"getStatQueryFields_30","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/routingDetail":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Routing Details for NWPI.","operationId":"getRoutingDetailFromLocal","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","description":"trace state","required":true,"schema":{"type":"string"}},{"name":"routePrefixs","in":"query","description":"route prefixs","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{"upstream":[{"hostname":"Site20-cEdge-1","system_ip":"4.4.4.2","route":"119.0.0.0/8","route_preference":1,"metric":0,"next_hop":{"outgoing_interface":"NULL0","next_hop_address":"168.19.1.200"},"source_protocol":"static","last_update_time":1646093417790}],"downstream":[{"hostname":"Site20-cEdge-2","system_ip":"4.4.4.3","route":"10.20.25.0/24","route_preference":1,"metric":0,"next_hop":{"outgoing_interface":"NULL0","next_hop_address":"168.19.1.201"},"source_protocol":"static","last_update_time":1646093417790}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/tasks/create":{"post":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Task Action - Create","operationId":"taskCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Create Trace Start Task with empty Duration":{"description":"Create Trace Start Task with empty Duration","value":{"taskName":"auto-on","events":["sla-violation","sla-violation-pkt-drop","qos-congestion"],"sites":["100","500"],"duration":""}},"Create Trace Start Task with Duration":{"description":"Create Trace Start Task with Duration","value":{"taskName":"auto-on","events":["sla-violation","sla-violation-pkt-drop","qos-congestion"],"sites":["100","500"],"duration":"1440"}},"Create Trace Start Task without Duration":{"description":"Create Trace Start Task without Duration","value":{"taskName":"auto-on","events":["sla-violation","sla-violation-pkt-drop","qos-congestion"],"sites":["100","500"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksCreateResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/tasks/delete/{taskId}":{"delete":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Delete Auto On Task","operationId":"taskDelete","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksDeleteResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/tasks/eventStatsData":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get auto on stats data in one task","operationId":"getEventStatsData","parameters":[{"name":"taskId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","required":true,"schema":{"type":"string"}},{"name":"taskEndTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"duration","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventStatsDataResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/stream/device/nwpi/tasks/stop/{taskId}":{"post":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Task Action - Stop","operationId":"taskStop","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksStopResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/tasks/taskHistory":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get all the auto on tasks","operationId":"getTaskHistory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskHistoryResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/tasks/{taskId}/traces":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get all traces in one task","operationId":"getTaskTrace","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskTracesResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/trace/delete":{"delete":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Trace Action - Delete","operationId":"traceDelete","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/trace/record/{deviceUUID}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"post flow data","operationId":"nwpiPostFlowData","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write,vmanage-http-stream"}},"/stream/device/nwpi/trace/start":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Trace Action - Start","operationId":"traceStart","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Start Flow Monitor trace":{"description":"Start Flow Monitor trace","value":{"source-site":"600","vpn-id":"1","duration":"60","trace-name":"trace_1","device-list":[{"local-system-ip":"172.16.255.16","deviceId":"172.16.255.16","uuid":"C8K-25e26fb8-e692-4b24-bf10-1da949728c41","version":"17.07.01.0.144090"},{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-bea08f58-91b6-498a-86f3-9b74646c318b","version":"17.04.01.0.144091"}],"app":["webex-meeting","ms-office-365"],"src-pfx":"100.0.0.0/8","dst-pfx":"200.0.0.0/8","src-if":"GigabitEthernet5","protocol":"6","dscp":"1","src-port":"8080","dst-port":"8443","art-vis":"true","app-vis":"true","dia-vis":"true","hub-wan-vis":"true","sampling":"true","spl-intvl":"60000","source-site-version":"17.04.01.0.144091","warning":" "}},"Start Flow Monitor trace for a specific device":{"description":"Start Flow Monitor trace for a specific device","value":{"source-site":"600","vpn-id":"1","duration":"60","trace-name":"trace_2","device-ip":"172.16.255.16","device-list":[{"local-system-ip":"172.16.255.16","deviceId":"172.16.255.16","uuid":"C8K-25e26fb8-e692-4b24-bf10-1da949728c41","version":"17.07.01.0.144090"}],"app-grp":["google-group","ms-cloud-group"],"src-pfx":"100.0.0.0/8","dst-pfx":"200.0.0.0/8","src-if":"GigabitEthernet5","protocol":"6","dscp":"1","src-port":"8080","dst-port":"8443","art-vis":"true","app-vis":"true","dia-vis":"true","hub-wan-vis":"true","sampling":"true","spl-intvl":"60000","source-site-version":"17.07.01.0.144090","warning":" "}},"Start Domain Monitor trace":{"description":"Start Domain Monitor trace","value":{"source-site":"600","vpn-id":"1","duration":"60","trace-name":"trace_3","device-list":[{"local-system-ip":"172.16.255.16","deviceId":"172.16.255.16","uuid":"C8K-25e26fb8-e692-4b24-bf10-1da949728c41","version":"17.07.01.0.144090"},{"local-system-ip":"172.16.255.14","deviceId":"172.16.255.14","uuid":"C8K-0ea91298-f8db-41e4-a167-e7af0461ed81","version":"17.06.01.0.144092"}],"app-grp":["google-group","ms-cloud-group"],"client-ip":"100.0.0.0/8","domain-mon":"true","art-vis":"true","app-vis":"true","dia-vis":"true","hub-wan-vis":"true","sampling":"true","spl-intvl":"60000","source-site-version":"17.06","warning":" "}},"Start Flow Monitor trace (without vManage UI)":{"description":"Start Flow Monitor trace (without vManage UI)","value":{"source-site":"600","vpn-id":"1","duration":"60","trace-name":"trace_4","app":["webex-meeting","ms-office-365"],"src-pfx":"100.0.0.0/8","dst-pfx":"200.0.0.0/8","src-if":"GigabitEthernet5","protocol":"6","dscp":"1","src-port":"8080","dst-port":"8443","art-vis":"true","app-vis":"true","dia-vis":"true","hub-wan-vis":"true","sampling":"true","spl-intvl":"60000"}},"Start Flow Monitor trace for a specific device (without vManage UI)":{"description":"Start Flow Monitor trace for a specific device (without vManage UI)","value":{"source-site":"600","vpn-id":"1","duration":"60","trace-name":"trace_5","device-ip":"172.16.255.16","app-grp":["google-group","ms-cloud-group"],"src-pfx":"100.0.0.0/8","dst-pfx":"200.0.0.0/8","src-if":"GigabitEthernet5","protocol":"6","dscp":"1","src-port":"8080","dst-port":"8443","art-vis":"true","app-vis":"true","dia-vis":"true","hub-wan-vis":"true","sampling":"true","spl-intvl":"60000"}},"Start Domain Monitor trace (without vManage UI)":{"description":"Start Domain Monitor trace (without vManage UI)","value":{"source-site":"600","vpn-id":"1","duration":"60","trace-name":"trace_6","app-grp":["google-group","ms-cloud-group"],"client-ip":"100.0.0.0/8","domain-mon":"true","art-vis":"true","app-vis":"true","dia-vis":"true","hub-wan-vis":"true","sampling":"true","spl-intvl":"60000"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/trace/stop/{traceId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Trace Action - Stop","operationId":"traceStop","parameters":[{"name":"traceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/traceCftRecord":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get Trace CFT record","operationId":"getTraceCftRecord","parameters":[{"name":"traceId","in":"query","description":"TraceId","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"entryTime","in":"query","description":"entryTime","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","description":"traceState","required":true,"schema":{"type":"string"}},{"name":"vpnIds","in":"query","description":"vpnIds","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"localColors","in":"query","description":"localColors","schema":{"type":"array","items":{"type":"string"}}},{"name":"devices","in":"query","description":"devices","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceCftRecordResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/nwpi/traceFinFlowCount":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Retrieve total Fin Flow counts","operationId":"getFinalizedFlowCount","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Finalized flow count":{"description":"Finalized flow count","value":{"total_flow_count":"10000"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceFinFlowTimeRange":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Retrieve Fin Flow time range","operationId":"getFinFlowTimeRange","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Finalized flow time range":{"description":"Finalized flow time range","value":[{"start_time":"1651543925251","end_time":"1651545413468"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceFinFlowWithQuery":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Retrieve Certain Fin Flows","operationId":"traceFinFlowWithQuery","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Severity histogram":{"description":"Severity histogram","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceFlow":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getTraceFlow","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/stream/device/nwpi/traceHistory":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getTraceHistory","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceInfoByBaseKey":{"get":{"tags":["NWPI","Troubleshooting Tools - Diagnostics"],"description":"Get TraceInfoByBaseKey","operationId":"getTraceInfoByBaseKey","parameters":[{"name":"traceId","in":"query","description":"traceId","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"entryTime","in":"query","description":"entryTime","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceInfoResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/speed":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSession","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/speed/disable/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"disableSpeedTestSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/speed/interface/bandwidth":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getInterfaceBandwidth","parameters":[{"name":"circuit","in":"query","required":true,"schema":{"type":"string"}},{"name":"deviceUUID","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Device Monitoring-read"}},"/stream/device/speed/start/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"startSpeedTest","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/speed/status/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSpeedTestStatus","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/speed/stop/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"stopSpeedTest","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/speed/{deviceUUID}/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"saveSpeedTestResults","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/speed/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSpeedTest","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},{"name":"logId","in":"query","schema":{"type":"integer","format":"int64","default":0}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/status/{deviceUUID}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get device status stream","operationId":"processDeviceStatus","parameters":[{"name":"deviceUUID","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/umts":{"post":{"tags":["Troubleshooting Tools - UMTS"],"summary":"Assign sessionId to client","description":"assign sessionId to client if there is no conflict ongoing sessions ","operationId":"enableSession","requestBody":{"description":"Input query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMTSInput"}}}},"responses":{"200":{"description":"Session info which client can start request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UMTSSession"}}}}},"400":{"description":"bad input parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"conflicts sample":{"description":"conflicts sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_enable_error.json"}}}}}}}},"/stream/device/umts/statistics/{deviceUUID}/{eventType}":{"get":{"tags":["Troubleshooting Tools - UMTS"],"summary":"get UMTS Data","description":"get UMTS result by type, time, and device uuid","operationId":"getUMTSData","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventType","in":"path","required":true,"schema":{"type":"string"}},{"name":"lastNHours","in":"query","schema":{"type":"integer","format":"int32","default":24}}],"responses":{"200":{"description":"opertion result","content":{"application/json":{"schema":{"type":"object"},"examples":{"get event-driven sample":{"description":"get event-driven sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_eventdriven_result.json"}}}}},"400":{"description":"bad input parameter"}}}},"/stream/device/umts/{deviceUUID}/save":{"post":{"tags":["Troubleshooting Tools - UMTS"],"summary":"save UMTS result","description":"Save UMTS Data, this api is called by device side ","operationId":"saveUMTSData","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"on-demand sample":{"description":"on-demand sample","$ref":"examples/elasticsearch/monitoring/parameter_example/UmtsSaveRequest.json"}}}}},"responses":{"200":{"description":"save result","content":{"application/json":{"schema":{"type":"string"},"examples":{"save result sample":{"description":"save result sample","value":"{status: success}"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Tools-write"}},"/stream/device/umts/{operation}/{sessionId}":{"get":{"tags":["Troubleshooting Tools - UMTS"],"summary":"start/stop/disable/status/download session","description":"start, stop,status,download or disable session ","operationId":"updateUmtsSessionStatus","parameters":[{"name":"operation","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"opertion result","content":{"application/json":{"schema":{"type":"object"},"examples":{"start/stop/disable/status/download sample":{"description":"start/stop/disable/status/download sample","value":"{status: success}"},"status ok sample":{"description":"status ok sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_status_result.json"},"status fail sample":{"description":"status fail sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_status_fail_result.json"},"status downloadable sample":{"description":"status downloadable sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_status_downloadable_result.json"},"download sample":{"description":"download sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_download_sample.json"}}}}},"400":{"description":"bad input parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"error sample":{"description":"error sample","$ref":"examples/elasticsearch/monitoring/response_example/umts_status_error.json"}}}}}}}},"/system/device":{"post":{"tags":["Configuration - Device Inventory"],"description":"Create new device
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createDevice","requestBody":{"description":"Create device request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceParams"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/bootstrap/device/{uuid}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Create vEdge device config","operationId":"generateBootstrapConfigForVedge","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}},{"name":"configtype","in":"query","description":"Device config type","required":true,"schema":{"type":"string"}},{"name":"inclDefRootCert","in":"query","description":"Include default root certs flag","required":true,"schema":{"type":"boolean","default":true}},{"name":"version","in":"query","description":"cloud-init format version","schema":{"type":"string","default":"v1"}},{"name":"wanif","in":"query","description":"Device WAN interface","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","value":{"bootstrapConfig":"#cloud-config\nvinitparam:\n - otp : 7f162ca042174e37ae8a633ce7b08d4a\n - vbond : 10.0.12.26\n - uuid : 71001c48-fdcf-4ac0-aaf3-ca4a20386a18\n - org : vIPtela Inc Regression\n"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/bootstrap/devices":{"post":{"tags":["Configuration - Device Inventory"],"description":"Create bootstrap config for software vEdges","operationId":"generateBootstrapConfigForVedges","requestBody":{"description":"Device bootstrap type and id","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bootstrap config type and id":{"description":"Device bootstrap config type and id","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/bootstrap/download/{id}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Download vEdge device config","operationId":"getBootstrapConfigZip","parameters":[{"name":"id","in":"path","description":"Bootstrap config id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/bootstrap/generic/devices":{"get":{"tags":["Configuration - Device Inventory"],"description":"Create bootstrap config for software vEdges","operationId":"generateGenericBootstrapConfigForVedges","parameters":[{"name":"wanif","in":"query","description":"Device WAN interface","schema":{"type":"string"}},{"name":"sdRoutingDevice","in":"query","description":"Flag to indicate if this is SD-Routing device","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/claimDevices":{"post":{"tags":["Configuration - Device Inventory"],"description":"Claim the selected unclaimed devices","operationId":"claimDevices","requestBody":{"description":"Claim device request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Claim device request":{"description":"Claim device request"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Claimed device info":{"description":"Claimed device info","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Colocation-write"}},"/system/device/controllers/vedge/status":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get controllers vEdge sync status","operationId":"getControllerVEdgeSyncStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vEdge status":{"description":"vEdge status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/system/device/decommission/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Decomission vEdge device","operationId":"decommissionVedgeCloud","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task id":{"description":"Task id","value":{"id":"4279226e-162e-4df0-a174-73215c5d839f"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/devicesWithoutSubjectSudi":{"get":{"tags":["Configuration - Device Inventory"],"description":"retrieve devices without subject sudi","operationId":"devicesWithoutSubjectSudi","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/fileupload":{"post":{"tags":["Configuration - Device Inventory"],"description":"Upload file to vEdge","operationId":"formPost","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormPostResp"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/generate-payg":{"post":{"tags":["Configuration - Device Inventory"],"description":"Authenticate vSmart user account","operationId":"validateUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access token":{"description":"Access token","value":"{accessToken: }"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/lifecycle/management/{uuid}":{"post":{"tags":["Configuration - Device Inventory"],"description":"Set device lifecycle needed flag","operationId":"setLifeCycle","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}},{"name":"enable","in":"query","description":"lifecycle needed flag","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device lifecycle needed value":{"description":"Device lifecycle needed value","value":true}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/system/device/management/systemip":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get management system IP mapping","operationId":"getManagementSystemIPInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"System IP mapping":{"description":"System IP mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/system/device/migrateDevice/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Migrate device software to vedge/cedge","operationId":"migrateDevice","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device migration result":{"description":"Device migration result","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/system/device/reset/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Reset vEdge device","operationId":"resetVedgeCloud","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task id":{"description":"Task id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/system/device/rma/candidates/{deviceType}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get RMA candidates by device type","operationId":"getRMACandidates","parameters":[{"name":"deviceType","in":"path","description":"Device Type","required":true,"schema":{"type":"string","enum":["vsmart"]}},{"name":"uuid","in":"query","description":"Excluded currently selected uuid","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device type":{"description":"Device type","value":"[\"data\": [\n {\n \"uuid\": \"347eca1b-a0ae-42be-92d1-4702b5285aae\",\n \"deviceIP\": \"8.8.8.8\",\n \"validity\": \"valid\",\n \"managementSystemIP\": \"169.254.0.1\"\n \"host-name\": \"vm130\"\n }\n\"]\"]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/system/device/rootcertchain/status":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get controllers vEdge sync status","operationId":"getRootCertStatusAll","parameters":[{"name":"state","in":"query","description":"Root certificate state","required":true,"schema":{"type":"string","enum":["pending","done"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vEdge sync status":{"description":"vEdge sync status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/system/device/selfsignedcert/iscreated":{"get":{"tags":["Configuration - Device Inventory"],"description":"Whether self signed certificate created","operationId":"checkSelfSignedCert","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Self signed certificate created":{"description":"Self signed certificate created","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/system/device/smartaccount/authenticate":{"post":{"tags":["Configuration - Device Inventory"],"description":"Authenticate vSmart user account","operationId":"validateUser_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartAccountModel"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access token":{"description":"Access token","value":"{accessToken: }"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/system/device/smartaccount/sync":{"post":{"tags":["Configuration - Device Inventory"],"description":"Sync devices from Smart-Account","operationId":"syncDevices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartAccountModel"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncDevicesResp"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/sync/rootcertchain":{"get":{"tags":["Configuration - Device Inventory"],"description":"Sync root certificate","operationId":"syncRootCertChain","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRootCertChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/tenant/management/systemip":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get management system IP
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantManagementSystemIPs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"System IP":{"description":"System IP","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/system/device/type/{deviceCategory}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get devices details","operationId":"getCloudDockDataBasedOnDeviceType","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string","enum":["vedges","controllers"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device info":{"description":"Device info","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/system/device/type/{deviceCategory}/defaultConfig":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get devices default config","operationId":"getCloudDockDefaultConfigBasedOnDeviceType","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string","enum":["vedges","controllers"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device default config":{"description":"Device default config","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/system/device/unclaimedDevices":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get list of all unclaimed devices","operationId":"getAllUnclaimedDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device info":{"description":"Device info","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/system/device/updateDeviceSubjectSUDI/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"update subject sudi value of given device uuid","operationId":"updateDeviceSubjectSUDI","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/vedgedetection":{"get":{"tags":["Configuration - Device Inventory"],"description":"Check for Vedge Device Presence","operationId":"checkvEdgeDevicePresence","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VedgeCheckResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/vmanagerootca/{uuid}":{"delete":{"tags":["Configuration - Device Inventory"],"description":"Invalidate vManage root CA","operationId":"invalidateVmanageRootCA","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/system/device/{deviceCategory}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers","operationId":"getDevicesDetails","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string"}},{"name":"model","in":"query","description":"Device model","schema":{"type":"string","enum":["vedge-cloud","vedge-1000","vedge-2000","vedge-100","vedge-ISR1100-4G","vedge-ISR1100-4GLTE","vedge-ISR1100X-4G","vedge-ISR1100-6G","vedge-ISR1100X-6G","vedge-100-B","vedge-100-WM","vedge-100-M","vEdge-5000","vedge-CSR-1000v","vedge-IR-1101","vedge-IR-1821","vedge-IR-1831","vedge-IR-1833","vedge-IR-1835","vedge-IR-8140H","vedge-IR8140H-P","vedge-IR-8340","vedge-ESR-6300","vedge-ISR-4331","vedge-ISR-4321","vedge-ISR-4351","vedge-ISR-4221","vedge-IR-1101","vedge-ESR-6300","vedge-ISR-4331","vedge-ISR-4321","vedge-ISR-4351","vedge-ISR-4221","vedge-ISR-4221X","vedge-ISR-4431","vedge-ISR-4451-X","vedge-ASR-1001-HX","vedge-ASR-1002-X","vedge-ASR-1002-HX","vedge-ASR-1006-X","vedge-C1111-8P","vedge-C1121X-8P","vedge-C1111X-8P","vedge-C1111-8PLTELAW","vedge-C1111-8PLTEEA","vedge-C1121-8PLTEPW","vedge-C1111-8PLTELA","vedge-C1117-4PLTEEA","vedge-C1126X-8PLTEP","vedge-C1127X-8PLTEP","vedge-C1127X-8PMLTEP","vedge-C1127-8PMLTEP","vedge-C1117-4PLTELA","vedge-ISRv","vedge-C8000V","vedge-ASR-1001-X","vedge-C1111-4P","vedge-C1101-4P","vedge-C1101-4PLTEP","vedge-C8500-12X4QC","vedge-C8500-12X","vedge-C8500L-8S4X","vedge-C1111-8PW","vedge-C1111-8PLTEEAW","vedge-C1111-4PLTEEA","vedge-C1101-4PLTEPW","vedge-C1109-4PLTE2PW","vedge-C1109-4PLTE2P","vedge-C1121X-8PLTEP","vedge-C1161X-8PLTEP","vedge-C1113-8PMLTEEA","vedge-C1111-4PLTELA,vedge-C1116-4P","vedge-C1116-4PLTEEA","vedge-C1117-4P","vedge-C1117-4PM","vedge-C1117-4PMLTEEA","vsmart","vmanage","vbond","vedge-ISR-4461","vedge-C8300-1N1S-4T2X","vedge-C8300-1N1S-6T","vedge-C1161X-8P","vedge-C8300-2N2S-4T2X","vedge-C8300-2N2S-6T","vedge-C8200-1N-4T","vedge-C8200L-1N-4T","vedge-C1161-8P","vedge-C1126-8PLTEP","vedge-C1127-8PLTEP","vedge-C1121-4P","vedge-C1121-4PLTEP","vedge-C1128-8PLTEP","vedge-C1121X-8PLTEPW","vedge-C1121-8PLTEP","vedge-C1121-8P","vedge-C1161-8PLTEP","vedge-C1113-8PLTEEA","vedge-C1131-8PW","vedge-C1131X-8PW","vedge-C1131-8PLTEPW","vedge-C1131X-8PLTEPW","vedge-C1113-8PLTEW","vedge-C1111-4PW","vedge-C1112-8P","vedge-C1112-8PLTEEA","vedge-C1112-8PLTEEAWE","vedge-C1112-8PWE","vedge-C1113-8P","vedge-C1113-8PLTEEAW","vedge-C1113-8PLTELA","vedge-C1113-8PLTELAWZ","vedge-C1113-8PM","vedge-C1113-8PMWE","vedge-C1113-8PW","vedge-C1116-4PLTEEAWE","vedge-C1116-4PWE","vedge-C1117-4PLTEEAW","vedge-C1117-4PLTELAWZ","vedge-C1117-4PMLTEEAWE","vedge-C1117-4PMWE","vedge-C1117-4PW","vedge-C1118-8P","vedge-C1109-2PLTEGB","vedge-C1109-2PLTEUS","vedge-C1109-2PLTEVZ"]}},{"name":"state","in":"query","description":"List of states","schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificateStates"},"enum":["tokengenerated","bootstrapconfiggenerated","csrgenerated","csrfailed","certinstalled","certinstallfailed"]}},{"name":"uuid","in":"query","description":"List of device uuid","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceUuid"}}},{"name":"deviceIP","in":"query","description":"List of device system IP","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}},{"name":"validity","in":"query","description":"List of device validity","schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificateValidity"},"enum":["valid","invalid","staging"]}},{"name":"family","in":"query","description":"The platform family to filter for","schema":{"type":"string","enum":["aon","cedge"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca,Device Inventory > Edge-read,Device Inventory > Controller-read"}},"/system/device/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Edit device","operationId":"editDevice","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"},"delete":{"tags":["Configuration - Device Inventory"],"description":"Delete vEdges","operationId":"deleteDevice","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/{uuid}/unlock":{"post":{"tags":["Configuration - Device Inventory"],"description":"Unlock device","operationId":"unlockDevice","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/system/reverseproxy/{uuid}":{"get":{"tags":["System - Reverse Proxy"],"description":"Get reverse proxy IP/Port mappings for controller","operationId":"getReverseProxyMappings","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reverse proxy mappings":{"description":"Device reverse proxy mappings","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["System - Reverse Proxy"],"description":"Create reverse proxy IP/Port mappings for controller","operationId":"createReverseProxyMappings","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device reverse proxy mappings","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reverse proxy mappings":{"description":"Device reverse proxy mappings","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag":{"get":{"tags":["Tag"],"description":"Get all tags","operationId":"getAllTags","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllTagsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Tag"],"description":"Create a tag","operationId":"createTag","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"create or associate tag":{"description":"create or associate tag","value":{"associate":[{"deviceId":"C8K-46dabbc6-ae64-49c1-8fde-01b669ae2aa4","tagList":[{"name":"tag1","tagId":"1ca0ad1c-ca96-4cba-b33b-4209225e4fdf","tagType":"device"},{"name":"tag2","tagId":"","tagType":"device"}]}],"create":[{"name":"tag2","tagId":"","tagType":"device"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag/checkRules":{"post":{"tags":["Tag"],"description":"This API will check if a rule can be created or not","operationId":"checkRule","requestBody":{"description":"Update device action status","content":{"application/json":{"schema":{"type":"object"},"examples":{"Check Tag Rules":{"description":"Check Tag Rules","value":{"configGroupId":"1433d86f-8a7c-4d4a-9bcb-660038cc82ac","deviceAttribute":"tags","rule":"equal","tagId":"","values":["tag1"]}}}}}},"responses":{"301":{"description":"Moved Permanently","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTagRulesResponse"}}}}}}},"/tag/conflictCheck":{"post":{"tags":["Tag"],"description":"Check for conflicts when tagging","operationId":"conflictCheck","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"conflict check":{"description":"conflict check","value":{"associate":[{"deviceId":"C8K-46dabbc6-ae64-49c1-8fde-01b669ae2aa4","deviceModel":"vedge-C8000V","tagList":[{"name":"tag1","tagId":"1ca0ad1c-ca96-4cba-b33b-4209225e4fdf","tagType":"device"},{"name":"tag2","tagId":"","tagType":"device"}]}],"create":[{"name":"tag2","tagId":"","tagType":"device"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConflictCheckResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag/reindex":{"get":{"tags":["Tag"],"description":"Re-index device tags for search. Only call this API very occasionally if tag search is not returning expected results","operationId":"indexTags","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag/remove":{"post":{"tags":["Tag"],"description":"Deletes multiple tags","operationId":"delete","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"delete multiple tags":{"description":"delete multiple tags","value":{"arr":["89f8ac12-03ed-40fa-a757-0fabeafbc2b7"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveTagResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag/tagRules":{"put":{"tags":["Tag"],"description":"Edit a tag rule","operationId":"editTagRule","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"edit a tag rule":{"description":"edit a tag rule","value":{"configGroupId":"1433d86f-8a7c-4d4a-9bcb-660038cc82ac","deviceAttribute":"tags","rule":"equal","tagId":"759dd533-612b-4229-b300-efd09f6eb401","values":["tag2"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRuleInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Tag"],"description":"Create a tag rule","operationId":"createTagRule","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"create a tag rule":{"description":"create a tag rule","value":{"configGroupId":"1433d86f-8a7c-4d4a-9bcb-660038cc82ac","deviceAttribute":"tags","rule":"equal","values":["tag1"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRuleInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag/tagRules/{configGroupId}":{"get":{"tags":["Tag"],"description":"Get tag rules","operationId":"getTagRules","parameters":[{"name":"configGroupId","in":"path","description":"ConfigGroup Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetTagRulesResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/tag/tagRules/{tagRuleId}":{"delete":{"tags":["Tag"],"description":"Delete a tag rule","operationId":"deleteTagRule","parameters":[{"name":"tagRuleId","in":"path","description":"tagRule Id","required":true,"schema":{"type":"string"}},{"name":"configGroupId","in":"query","description":"ConfigGroup Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/cloudx":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get CloudX feature list","operationId":"getCloudXStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX status":{"description":"CloudX status","value":{"data":[{"appType":"amazon_aws","longName":"Amazon AWS","totalSites":2,"goodSites":0,"badSites":0,"averageSites":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read"}},"/template/cloudx/addcloudx/{type}":{"post":{"tags":["Configuration - CloudExpress"],"description":"Add cloudx gateway","operationId":"addCloudxType","parameters":[{"name":"type","in":"path","description":"Cloudx type","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cloudx","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx":{"description":"Cloudx"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write,Template Deploy-write"}},"/template/cloudx/attachedclient":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get attached client site list","operationId":"getAttachedClientList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX attached client site":{"description":"CloudX attached client site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/attacheddia":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get attached Dia site list","operationId":"getAttachedDiaList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX attached Dia site":{"description":"CloudX attached Dia site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/attachedgateway":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get attached gateway list","operationId":"getAttachedGatewayList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX attached gateway":{"description":"CloudX attached gateway","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/availableapps":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get CloudX available apps list","operationId":"getCloudXAvailableApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX app list":{"description":"CloudX app list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read"}},"/template/cloudx/clientlist":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get site list","operationId":"getSiteList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX site":{"description":"CloudX site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/dialist":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get Dia site list","operationId":"getDiaList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX Dia site":{"description":"CloudX Dia site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/gatewaylist":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get gateway list","operationId":"getGatewayList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX gateway":{"description":"CloudX gateway","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/interfaces":{"post":{"tags":["Configuration - CloudExpress"],"description":"Enable cloudx gateway","operationId":"addCloudxInterfaces","requestBody":{"description":"Cloudx","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx":{"description":"Cloudx"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"}},"/template/cloudx/manage/apps":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get apps and vpns","operationId":"getApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"},"put":{"tags":["Configuration - CloudExpress"],"description":"Edit apps and vpns","operationId":"editApps","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx apps and vpns":{"description":"Cloudx apps and vpns","value":{"appList":[{"appType":"amazon_aws","longName":"Amazon AWS","appVpnList":"1,10"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Change required":{"description":"Change required","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"},"post":{"tags":["Configuration - CloudExpress"],"description":"Add apps and vpns","operationId":"addApps","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx apps and vpns":{"description":"Cloudx apps and vpns","value":{"appList":[{"appType":"amazon_aws","longName":"Amazon AWS","appVpnList":"1,5"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"}},"/template/cloudx/sig_tunnels":{"get":{"tags":["Configuration - Secure Internet Gateway Tunnels"],"description":"Get Secure Internet Gateway Tunnel List","operationId":"getSigTunnelList_1","parameters":[{"name":"deviceId","in":"query","description":"DeviceIp/SystemIp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/cloudx/status":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get sites per application per vpn","operationId":"sitePerApp","parameters":[{"name":"appName","in":"query","description":"App name","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"VPN Id","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX site":{"description":"CloudX site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read"}},"/template/config/attach/{deviceId}":{"put":{"tags":["Configuration - Template Configuration"],"description":"Upload device config","operationId":"uploadConfig","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template config":{"description":"Template config"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Template Deploy-write"}},"/template/config/attached/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get local template attached config for given device","operationId":"getAttachedConfig","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Config type","schema":{"type":"string","enum":["CFS","RFS","DRAFT_RFS","DRAFT_CFS"],"default":"CFS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attached config":{"description":"Attached config","value":{"config":"no config \nconfig\n system\n host-name vm1\n system-ip 172.16.255.11\n site-id 100\n port-offset 1\n admin-tech-on-failure\n admin-tech-on-software-rollback\n route-consistency-check\n no vrrp-advt-with-phymac\n organization-name \"vIPtela Inc Regression\"\n vbond vbond\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n !\n logging\n disk\n enable\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n support\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n !\n !\n omp\n no shutdown\n graceful-restart\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n advertise ospf external\n advertise connected\n advertise static\n !\n security\n ipsec\n integrity-type ip-udp-esp esp\n !\n !\n vpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface ge0/1\n ip address 10.0.26.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/2\n ip address 10.0.5.11/24\n no ipv6 shutdown\n tunnel-interface\n encapsulation ipsec\n color lte\n hello-tolerance 12\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n !\n interface ge0/4\n ip address 10.0.7.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/7\n ip address 10.0.100.11/24\n no ipv6 shutdown\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n !\n vpn 1\n router\n ospf\n router-id 172.16.255.11\n timers spf 200 1000 10000\n redistribute static\n redistribute omp\n area 0\n interface ge0/0\n exit\n exit\n !\n !\n interface ge0/0\n ip address 10.2.2.11/24\n no ipv6 shutdown\n no shutdown\n !\n !\n vpn 512\n interface eth0\n ip dhcp-client\n no ipv6 shutdown\n ipv6 dhcp-client\n no shutdown\n !\n !\n !\n!\n"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/template/config/device/mode/cli":{"get":{"tags":["Configuration - Template Configuration"],"description":"Generates a JSON object that contains a list of valid devices in CLI mode","operationId":"generateCLIModeDevices","parameters":[{"name":"type","in":"query","description":"Device type","required":true,"schema":{"type":"string","enum":["vedge","controller","vmanage"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":{"data":[{"deviceIP":"172.16.255.16","uuid":"C8K-0c9b3b23-bdcd-4162-8d4f-774e44e081ee","host-name":"vm6","local-system-ip":"172.16.255.16"},{"deviceIP":"172.16.255.21","uuid":"76611d8b-dca9-47fd-b204-338af931f506","host-name":"vm11","local-system-ip":"172.16.255.21"},{"deviceIP":"172.16.255.11","uuid":"9c8d59ec-e4ad-468a-8fb0-15a7747a9c30","host-name":"vm1","local-system-ip":"172.16.255.11"},{"deviceIP":"172.16.255.15","uuid":"C8K-ae0d5e97-4b0e-4a05-8582-9cc0d93c456c","host-name":"vm5","local-system-ip":"172.16.255.15"},{"deviceIP":"172.16.255.14","uuid":"554b21bf-cad3-4efe-91fa-4c68549a6616","host-name":"vm4","local-system-ip":"172.16.255.14"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-write"},"post":{"tags":["Configuration - Template Configuration"],"description":"Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template","operationId":"updateDeviceToCLIMode","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":{"deviceType":"vedge","devices":[{"deviceId":"932f70dd-5815-4712-b9ed-3d34a238f2ca","deviceIP":"172.16.255.21"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template Id":{"description":"Device template Id","value":{"id":"device_config_mode_cli-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Template Deploy-write,Device Inventory > Edge-write"}},"/template/config/device/mode/vmanage":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get list of devices that are allowable for vmanage modes","operationId":"generatevManageModeDevices","parameters":[{"name":"type","in":"query","description":"Device type","required":true,"schema":{"type":"string","enum":["vedge","controller","vmanage"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":{"data":[{"deviceIP":"169.254.10.1","uuid":"8b669639-758b-4287-b07f-09b9d334ce24","configCloudxMode":"none","host-name":"vm200","local-system-ip":"172.16.255.200"},{"deviceIP":"169.254.10.2","uuid":"b0497670-2e62-404f-8136-21b226cd4c8b","configCloudxMode":"none","host-name":"vm201","local-system-ip":"172.16.255.201"},{"deviceIP":"169.254.10.3","uuid":"d22cafc2-a0d2-4f57-b0a3-d9147818084a","configCloudxMode":"none","host-name":"vm202","local-system-ip":"172.16.255.202"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/diff/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Generates a JSON object that contains the diff for a given device","operationId":"getDeviceDiff","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Config diff":{"description":"Config diff","value":{"config":"Config diff for device 9c8d59ec-e4ad-468a-8fb0-15a7747a9c30"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/quickConnect/submitDevices":{"post":{"tags":["Configuration - Quick Connect"],"description":"Creates and pushes bootstrap configurations onto day0 devices.","operationId":"submitDay0Config","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"data":{"description":"data","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/rmalist/{oldDeviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get compatible devices of model, chassis number, certificate serial number with the old device","operationId":"getCompatibleDevices","parameters":[{"name":"oldDeviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":{"data":[{"deviceModel":"vedge","chasisNumber":"71001c48-fdcf-4ac0-aaf3-ca4a20386a18","serialNumber":"f0b1985ba82e4c4889c225c59ca9a878","uuid":"67b2de20-0564-4ba6-837f-b24bc6a686ad"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/rmaupdate":{"put":{"tags":["Configuration - Template Configuration"],"description":"Update new device","operationId":"rmaUpdate","requestBody":{"description":"Template config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template config":{"description":"Template config","value":{"oldDeviceUUID":"C8K-075aaa13-0f11-4f76-a02e-fe3750080fcf","newDeviceUUID":"C8K-3bb1154f-ae09-48fb-9fe1-5ddc3b16089e"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Template Deploy-write"}},"/template/config/running/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get device running config","operationId":"getRunningConfig","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Running config":{"description":"Running config","value":{"config":" system\n host-name vm1\n system-ip 172.16.255.11\n site-id 100\n port-offset 1\n no daemon-restart\n admin-tech-on-failure\n admin-tech-on-software-rollback\n route-consistency-check\n no vrrp-advt-with-phymac\n organization-name \"vIPtela Inc Regression\"\n vbond vbond\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n !\n logging\n disk\n enable\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n support\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n !\n!\nomp\n no shutdown\n graceful-restart\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n advertise ospf external\n advertise connected\n advertise static\n!\nsecurity\n ipsec\n integrity-type ip-udp-esp esp\n !\n!\nvpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface ge0/1\n ip address 10.0.26.11/24\n no shutdown\n !\n interface ge0/2\n ip address 10.0.5.11/24\n tunnel-interface\n encapsulation ipsec\n color lte\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n !\n interface ge0/4\n ip address 10.0.7.11/24\n no shutdown\n !\n interface ge0/7\n ip address 10.0.100.11/24\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n!\nvpn 1\n router\n ospf\n router-id 172.16.255.11\n timers spf 200 1000 10000\n redistribute static\n redistribute omp\n area 0\n interface ge0/0\n exit\n exit\n !\n !\n interface ge0/0\n ip address 10.2.2.11/24\n no shutdown\n !\n!\nvpn 512\n interface eth0\n ip dhcp-client\n ipv6 dhcp-client\n no shutdown\n !\n!\n"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/template/config/vpn/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get list of configured VPN (excluding reserved VPN) for a device","operationId":"getVpnForDevice","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN":{"description":"VPN","value":["1"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/cor":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get Cloud On Ramp list","operationId":"getCORStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cloud on ramp status":{"description":"Cloud on ramp status","value":{"data":[{"accountId":"010098612700","accountName":"010098612700","cloudType":"AWS","mappedAccountCount":0,"cloudRegionList":[{"cloudRegion":"us-west-1","transitVpcCount":1,"hostVpcCount":0,"deviceCount":2,"hostVpcReachableCount":0,"hostVpcUnreachableCount":0,"deviceReachableCount":0,"deviceUnreachableCount":2}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Map Host to Transit VPC/VNet","operationId":"createAndMap","requestBody":{"description":"Map host to transit VPC request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Map host to transit VPC request":{"description":"Map host to transit VPC request"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/accountid/{accountid}":{"delete":{"tags":["Configuration - Cloud On Ramp"],"description":"Delete transit VPC/VNet","operationId":"removeTransitVPC","parameters":[{"name":"accountid","in":"path","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"transitvpcid","in":"query","description":"Cloud VPC Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/acquireResourcePool":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Acquire IP from resource pool","operationId":"acquireResourcePool","requestBody":{"description":"Add IP from resource pool request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Add IP from resource pool request":{"description":"Add IP from resource pool request"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/ami":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get AMI list","operationId":"getAmiList","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"AMI":{"description":"AMI","value":"{\"data\":{\n \"amis\":[\n {\n \"amiId\":\"ami-00c8377340219e9fc\",\n \"version\":\"18.3.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-0136d4095d027e741\",\n \"version\":\"19.1.0-temp\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02a3c4c89a7e3294e\",\n \"version\":\"19.1.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02f9c3711e326dcb6\",\n \"version\":\"csr-CSR_SDWAN-AMI.16.12.01b-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0be17bfec080cee40.4\",\n \"modelType\":\"csr\"\n },\n {\n \"amiId\":\"ami-053eee5e68e33f25b\",\n \"version\":\"Cisco-CSR-SDWAN-16.12.03-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0379a842c0f9e5378.4\",\n \"modelType\":\"csr\"\n }\n ]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud list","operationId":"getCloudList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cloud type":{"description":"Cloud type","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud/account":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud accounts","operationId":"getCloudAccounts","parameters":[{"name":"cloudtype","in":"query","description":"Cloud type","required":true,"schema":{"type":"string"}},{"name":"cloudEnvironment","in":"query","description":"Cloud environment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud/authenticate":{"put":{"tags":["Configuration - Cloud On Ramp"],"description":"Authenticate and update cloud account credentials","operationId":"authenticateCredAndUpdate","requestBody":{"description":"Cloud account credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account credential":{"description":"Cloud account credential","value":{"cloudType":"AWS","authType":"KEY","apiKey":"dummy","secretKey":"dummy"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Authenticate cloud account credentials","operationId":"authenticateCloudOnRampCredAndAdd","requestBody":{"description":"Cloud account credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account credential":{"description":"Cloud account credential","value":{"cloudType":"AWS","authType":"KEY","apiKey":"dummy","secretKey":"dummy"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/cloud/host/accountdetails":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud host VPC account details","operationId":"getCloudHostVpcAccountDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud host account":{"description":"Cloud host account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud/mappedhostaccounts":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud mapped accounts view","operationId":"getCloudMappedHostAccounts","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud mapped host account":{"description":"Cloud mapped host account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/createResourcePool":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Add resource pool","operationId":"createResourcePool","requestBody":{"description":"Add resource pool request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Add resource pool request":{"description":"Add resource pool request"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/deleteDevicepair":{"delete":{"tags":["Configuration - Cloud On Ramp"],"description":"Remove device pair","operationId":"removeDeviceId","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"transitvpcid","in":"query","description":"VPC Id","required":true,"schema":{"type":"string"}},{"name":"transitvpcname","in":"query","description":"VPC Name","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}},{"name":"devicePairId","in":"query","description":"Device pair Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/device":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get available device list","operationId":"getCloudOnRampDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":"data"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/devicepair":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Add device pair","operationId":"addDevicePair","requestBody":{"description":"Add device pair request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Add device pair request":{"description":"Add device pair request"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/devicepair/hostvpc":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get host VPC details","operationId":"getHostVPCs","parameters":[{"name":"transitVpcId","in":"query","description":"Transit VPC Id","required":true,"schema":{"type":"string"}},{"name":"devicePairId","in":"query","description":"Device pair Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Host VPC":{"description":"Host VPC","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/externalId":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get the vManage external ID for AWS","operationId":"getExternalId","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"externalId":{"description":"externalId","value":"12345abcd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/getTransitDevicePairAndHostList":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get device and host details","operationId":"getTransitDevicePairAndHostList","parameters":[{"name":"accountId","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudRegion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device and host":{"description":"Device and host","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/getTransitVpnList":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPN list","operationId":"getTransitVpcVpnList","parameters":[{"name":"accountId","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Transit VPN":{"description":"Transit VPN","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/hostvpc":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get host VPC/VNet list","operationId":"getCloudHostVPCs","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPC/VNet":{"description":"VPC/VNet","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/map":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get mapped VPC/VNet list","operationId":"getMappedVPCs","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Map host to transit VPC/VNet","operationId":"mapVPCs","requestBody":{"description":"Map host to VPC/VNet","content":{"application/json":{"schema":{"type":"object"},"examples":{"Map host to VPC/VNet":{"description":"Map host to VPC/VNet"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"},"delete":{"tags":["Configuration - Cloud On Ramp"],"description":"Unmap host from transit VPC/VNet","operationId":"unmapVPCs","requestBody":{"description":"Unmap host to VPC/VNet","content":{"application/json":{"schema":{"type":"object"},"examples":{"Unmap host to VPC/VNet":{"description":"Unmap host to VPC/VNet"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/pem":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPC PEM key list","operationId":"getPemKeyList","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PEM key":{"description":"PEM key","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/scale/down":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Scale down cloud on ramp","operationId":"scaleDown","requestBody":{"description":"Update VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update VPC":{"description":"Update VPC"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"viptela-reserved-cloud"}},"/template/cor/scale/up":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Scale up cloud on ramp","operationId":"scaleUp","requestBody":{"description":"Update VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update VPC":{"description":"Update VPC"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"viptela-reserved-cloud"}},"/template/cor/transitvpc":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPC/VNet list","operationId":"getTransitVPCs","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPC/VNet list":{"description":"VPC/VNet list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"},"put":{"tags":["Configuration - Cloud On Ramp"],"description":"Update transit VPC/VNet","operationId":"updateTransitVPC","requestBody":{"description":"VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPC":{"description":"VPC","value":{"accountId":"010098612700","cloudRegion":"us-west-1","cloudType":"AWS","transitVpcName":"DemoVPC","transitVpcId":"vpc-0dfdd169a61492554","dia":"DISABLED"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Create transit VPC/VNet","operationId":"addTransitVPC","requestBody":{"description":"VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPC":{"description":"VPC","value":{"accountId":"010098612700","cloudRegion":"us-west-1","cloudType":"AWS","transitVpcName":"DemoVPC","transitVpcSize":"c3.large","amiId":"ami-0f0f993e800121941","deviceModelType":"vedge","transitVpcSubnet":"","maxHostVpcPerDevicePair":1,"devicePairList":[{"deviceList":[{"uuid":"f21dbb35-30b3-47f4-93bb-d2b2fe092d35","preference":"active"},{"uuid":"52c7911f-c5b0-45df-b826-3155809a2a1a","preference":"backup"}],"devicePairId":"f21dbb35-30b3-47f4-93bb-d2b2fe092d35","isPrimary":true}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"b634bf94-b47b-40a2-ba72-d289036234fd"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/transitvpc/autoscale-properties":{"put":{"tags":["Configuration - Cloud On Ramp"],"description":"Update transit VPC autoscale properties","operationId":"updateTransitVpcAutoscaleProperties","requestBody":{"description":"VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPC":{"description":"VPC","value":{"accountId":"010098612700","cloudRegion":"us-west-1","cloudType":"AWS","transitVpcName":"DemoVPC","transitVpcId":"vpc-0dfdd169a61492554","maxHostVpcPerDevicePair":2}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":""}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/transitvpc/size":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPC supported size","operationId":"getTransitVPCSupportedSize","parameters":[{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}},{"name":"cloudEnvironment","in":"query","description":"Cloud environment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPC size":{"description":"VPC size","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cortex":{"get":{"tags":["Configuration - Azure Connect"],"description":"Get Cortex List","operationId":"getCortexStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cortex status":{"description":"Cortex status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-read"}},"/template/cortex/cloud/authenticate":{"post":{"tags":["Configuration - Azure Connect"],"description":"Authenticate Cloud Account Credentials","operationId":"authenticateAzureConnectCredAndAdd","requestBody":{"description":"Credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"Credential":{"description":"Credential"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/cortex/map":{"get":{"tags":["Configuration - Azure Connect"],"description":"Get Mapped WAN Resource Groups","operationId":"getMappedWanResourceGroups","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource groups":{"description":"WAN resource groups","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/cortex/sync":{"post":{"tags":["Configuration - Azure Connect"],"description":"Sync WAN Resource Groups","operationId":"syncWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/cortex/wanrg":{"get":{"tags":["Configuration - Azure Connect"],"description":"Get WAN Resource Groups","operationId":"getWanResourceGroups","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource groups":{"description":"WAN resource groups","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"},"put":{"tags":["Configuration - Azure Connect"],"description":"Edit WAN Resource Groups","operationId":"editWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"},"post":{"tags":["Configuration - Azure Connect"],"description":"Create WAN Resource Groups","operationId":"saveWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"},"delete":{"tags":["Configuration - Azure Connect"],"description":"Delete WAN Resource Groups","operationId":"deleteWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/device":{"get":{"tags":["Configuration - Template Master"],"description":"Generate template list
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateMasterTemplateList","parameters":[{"name":"feature","in":"query","description":"Feature","required":true,"schema":{"type":"string","enum":["lawful-interception","cloud-dock","network-design","vmanage-default","all"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":{"data":[{"deviceType":"vsmart","lastUpdatedBy":"admin","factoryDefault":false,"templateName":"vSmartConfigurationTemplate","devicesAttached":0,"draftMode":false,"templateDescription":"Config template for vSmarts","templateClass":"vedge","lastUpdatedOn":1529606745011,"configType":"file","templateId":"e1f3de23-1ded-49d8-85b1-1e6ab668775f","templateAttached":0},{"deviceType":"vedge-C1111-8PLTELA","lastUpdatedBy":"system","templateClass":"cedge","configType":"template","templateId":"b6aacdc9-ae1f-4471-a359-13657ce98204","factoryDefault":true,"templateName":"Factory_Default_C1111_8PLTELA_V01","devicesAttached":0,"draftMode":false,"templateDescription":"Factory Default template for C1111-8PLTELA","lastUpdatedOn":1588082428579,"templateAttached":15}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/cli":{"post":{"tags":["Configuration - Template Master"],"description":"Create CLI template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createCLITemplate","requestBody":{"description":"Create template request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":"{\n \"templateId\":\"e1f3de23-1ded-49d8-85b1-1e6ab668775f\",\n \"templateName\":\"vSmartConfigurationTemplate\",\n \"templateDescription\":\"Config template for vSmarts\",\n \"deviceType\":\"vsmart\",\n \"templateConfiguration\":\n \"system\n host-name {{Hostname}}\n gps-location latitude {{gps-latitude}}\n gps-location longitude {{gps-longitude}}\n system-ip {{System-IP}}\n site-id {{Site-ID}}\n organization-name \"Cisco Sy1 - 19968\"\n vbond vbond.cisco.com\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n user admin\n password $6$YsNdljyTklJyRlUZ$u.vOqeMSUbzfc.aWBty9OIovNCxlUASviwfgXO2bTCJV5ddUoV7EG8Q3EA3Yl0aMv./GnJLPPbjC6uQPjtwVo.\n !\n !\n logging\n disk\n enable\n !\n !\n !\n omp\n no shutdown\n send-path-limit 8\n send-backup-paths\n graceful-restart\n !\n banner\n login \"Cisco SD-WAN/Viptela dCloud Demo V2\"\n !\n !\n vpn 0\n dns 198.18.1.1 secondary\n dns 198.18.1.254 primary\n host vbond.cisco.com ip 198.18.1.11 198.18.1.21\n interface eth0\n ip address {{Tunnel-IP-Address}}\n ipv6 dhcp-client\n tunnel-interface\n allow-service dhcp\n allow-service dns\n allow-service icmp\n allow-service sshd\n allow-service netconf\n no allow-service ntp\n no allow-service stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 {{Default GW}}\n !\n vpn 512\n!\"\n \"factoryDefault\":false,\n \"configType\":\"file\"\n}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"templateId":"81b558c9-f575-4255-ac11-2e5437be1ea0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/config/attachBootStrap":{"post":{"tags":["Configuration - Device Template"],"description":"Attach feature device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"pushMasterTemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"deviceTemplateList":[{"templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","device":[{"csv-status":"complete","csv-deviceId":"5e5f45e7-3062-44b2-b6f6-40c682149e05","csv-deviceIP":"172.16.255.11","csv-host-name":"vm1","//system/host-name":"vm1","//system/system-ip":"172.16.255.11","//system/site-id":"100","csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","selected":"true"}],"isEdited":false,"isMasterEdited":false,"isDraftDisabled":false}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attachcli":{"post":{"tags":["Configuration - Device Template"],"description":"Attach CLI device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"pushCLITemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":"{\n \"deviceTemplateList\":[\n {\n \"templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\", \n \"device\":[ \n {\n \"csv-status\":\"complete\",\n \"csv-deviceId\":\"5e5f45e7-3062-44b2-b6f6-40c682149e05\",\n \"csv-deviceIP\":\"172.16.255.11\",\n \"csv-host-name\":\"vm1\",\n \"//system/host-name\":\"vm1\",\n \"//system/system-ip\":\"172.16.255.11\",\n \"//system/site-id\":\"100\",\n \"csv-templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\",\n \"selected\":\"true\"\n \"pseudoCommitTimer\":11\n }\n ],\n \"isEdited\":false, \n \"isMasterEdited\":false, \n \"isDraftDisabled\":false \n }\n ]\n}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_file_template_configuration-d13a002a-0475-43bf-85db-ef9224112a52"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attachcloudx":{"put":{"tags":["Configuration - Device Template"],"description":"Edit already enabled gateways, clients, dias
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editCloudxConfig","requestBody":{"description":"CloudX config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudX config":{"description":"CloudX config","value":{"isEdited":true,"siteList":[100,400],"siteType":"dia"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Tenant Id":{"description":"Tenant Id","value":{"id":"push_file_template_configuration-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"},"post":{"tags":["Configuration - Device Template"],"description":"Enable gateways, clients, dias","operationId":"pushCloudxConfig","requestBody":{"description":"CloudX config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudX config":{"description":"CloudX config","value":{"isEdited":false,"siteList":[100],"siteType":"dia"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Tenant Id":{"description":"Tenant Id","value":{"id":"push_file_template_configuration-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attached/{masterTemplateId}":{"get":{"tags":["Configuration - Device Template"],"description":"Get attached device list by master template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAttachedDeviceList","parameters":[{"name":"masterTemplateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Configuration-read"}},"/template/device/config/attachedconfig":{"get":{"tags":["Configuration - Device Template"],"description":"Get attached config to device
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAttachedConfigToDevice","parameters":[{"name":"deviceId","in":"query","description":"Device Model ID","required":true,"schema":{"type":"string"}},{"name":"policyId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CLI config":{"description":"CLI config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Device Inventory-read"}},"/template/device/config/attachfeature":{"post":{"tags":["Configuration - Device Template"],"description":"Attach feature device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"pushMasterTemplate_1","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"deviceTemplateList":[{"templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","device":[{"csv-status":"complete","csv-deviceId":"5e5f45e7-3062-44b2-b6f6-40c682149e05","csv-deviceIP":"172.16.255.11","csv-host-name":"vm1","//system/host-name":"vm1","//system/system-ip":"172.16.255.11","//system/site-id":"100","csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","selected":"true"}],"isEdited":false,"isMasterEdited":false,"isDraftDisabled":false}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_feature_template_configuration-4794e7ed-8912-477b-86ec-07b87621ade4"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attachment":{"post":{"tags":["Configuration - Device Template"],"description":"Attach device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"attachDeviceTemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"deviceTemplateList":[{"templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","device":[{"csv-status":"complete","csv-deviceId":"C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0","csv-deviceIP":"172.16.255.15","csv-host-name":"vm5","//system/host-name":"vm5","//system/system-ip":"172.16.255.15","//system/site-id":"100","csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","selected":"true"}],"isEdited":false,"isMasterEdited":false,"isDraftDisabled":false}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_template_configuration-3140b324-7a4b-465d-92cc-847a6c01c340"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/available/{masterTemplateId}":{"get":{"tags":["Configuration - Device Template"],"description":"Get possible device list by master template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDeviceListByMasterTemplateId","parameters":[{"name":"masterTemplateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":{"data":[{"deviceIP":"172.16.255.16","device-groups":["No groups"],"uuid":"C8K-5783e055-2703-440e-91f0-41f4af941603","site-id":"600","host-name":"vm6","local-system-ip":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read"}},"/template/device/config/config":{"post":{"tags":["Configuration - Device Template"],"description":"Get device configuration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDeviceConfigurationPreview","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"templateId":"45d94bf1-30fb-4b00-8bde-2a62c8af97b5","device":{"csv-status":"complete","csv-deviceId":"a1d010e6-bd61-4fbd-8980-96f02db4d0b9","csv-deviceIP":"172.16.255.21","csv-host-name":"vm11","csv-templateId":"45d94bf1-30fb-4b00-8bde-2a62c8af97b5"},"isEdited":false,"isMasterEdited":false}}}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Device config":{"description":"Device config","value":"system\r\nhost-name vm11\r\ngps-location latitude 35.0\r\ngps-location longitude -78.0\r\nsystem-ip 172.16.255.21\r\nsite-id 100\norganization-name \"vIPtela Inc Regression\"\r\nclock timezone America/Los_Angeles\r\nvbond 10.0.12.26\r\naaa\r\n auth-order local radius tacacs\r\n usergroup basic\r\n task system read write\r\n task interface read write\r\n !"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write"}},"/template/device/config/detach":{"post":{"tags":["Configuration - Device Template"],"description":"Detach device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"detachDeviceTemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/template/device/config/detachcloudx":{"post":{"tags":["Configuration - Device Template"],"description":"Disable enabled gateways, clients, dias
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"detachSites","requestBody":{"description":"CloudX config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudX config":{"description":"CloudX config","value":{"siteList":[100],"siteType":"none"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Tenant Id":{"description":"Tenant Id","value":{"id":"push_file_template_configuration-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/duplicateip":{"post":{"tags":["Configuration - Device Template"],"description":"Detects duplicate system IP from a list of devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDevicesWithDuplicateIP","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":{"device":[{"csv-deviceIP":"10.1.0.1","csv-deviceId":"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de","csv-host-name":"DC1-VEDGE1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/device/config/duplicatelocationname":{"post":{"tags":["Configuration - Device Template"],"description":"Detects duplicate system IP from a list of devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDevicesWithDuplicateLocationName","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":{"locations":[{"locationName":"Milpitas, CA","csv-deviceId":"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/device/config/exportcsv":{"post":{"tags":["Configuration - Device Template"],"description":"Export the device template to CSV format for given template id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createInputWithoutDevice","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"templateId":"e1f3de23-1ded-49d8-85b1-1e6ab668775f","isEdited":false,"isMasterEdited":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device input":{"description":"Device input","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/input":{"post":{"tags":["Configuration - Device Template"],"description":"Create device input
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createDeviceInput","requestBody":{"description":"Template device input","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template device input":{"description":"Template device input","value":"{{\n \"templateId\":\"6c7d22bc-73d5-4877-9402-26c75a22bd08\",\n \"deviceIds\":[\n \"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de\"\n ],\n \"isEdited\":false,\n \"isMasterEdited\":false\n}}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device input":{"description":"Device input","value":{"data":[{"csv-status":"in_complete","csv-deviceId":"a1d010e6-bd61-4fbd-8980-96f02db4d0b9","csv-deviceIP":"172.16.255.21","csv-host-name":"vm11","//system/host-name":"vm11","//system/system-ip":"172.16.255.21","//system/site-id":"11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/process/input/file":{"post":{"tags":["Configuration - Device Template"],"description":"Process input comma separated file
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"processInputCommaSepFile","requestBody":{"description":"Device template","content":{"multipart/form-data":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Device config":{"description":"Device config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/quickconnectvariable":{"post":{"tags":["Configuration - Device Template"],"description":"Get connection variables to be configured","operationId":"getQuickConnectVariables","requestBody":{"description":"Device List","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device List":{"description":"Device List","value":[]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Variable list":{"description":"Variable list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/vbond":{"get":{"tags":["Configuration - Device Template"],"description":"Check if vBond is configured
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"checkVbond","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Is vBond configured":{"description":"Is vBond configured","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Configuration-read"}},"/template/device/config/verify":{"post":{"tags":["Configuration - Device Template"],"description":"Validate full template\"\n
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"validateTemplate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/template/device/feature":{"post":{"tags":["Configuration - Template Master"],"description":"Create a device template from feature templates and sub templates
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createMasterTemplate","requestBody":{"description":"Create template request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateName":"vEdge_Device_Template","templateDescription":"Demo device template","deviceType":"vedge-100","configType":"template","factoryDefault":false,"policyId":"","featureTemplateUidRange":[],"connectionPreferenceRequired":true,"connectionPreference":true,"generalTemplates":[{"templateId":"3b30e089-2e26-44f1-b5b2-ac44f3f4279e","templateType":"aaa"},{"templateId":"0419c4f6-eb61-4048-a3fe-78ea7f7248b0","templateType":"bfd-vedge"},{"templateId":"eb7162be-b018-47c5-b1de-bbb65ff802e3","templateType":"omp-vedge"},{"templateId":"486d419f-4e6c-44a5-a6fb-7b5ccf94ff90","templateType":"security-vedge"},{"templateId":"7d7396a2-4715-44d8-8f6e-ddf0ca06be44","templateType":"system-vedge","subTemplates":[{"templateId":"edf3d309-91d4-45be-98d9-cfd57a05a479","templateType":"logging"}]},{"templateId":"171e9bd4-7a7b-460d-b692-83f0d5ce0124","templateType":"vpn-vedge","subTemplates":[{"templateId":"a632ee5f-f489-46ec-8761-1b493d5a6a40","templateType":"vpn-vedge-interface"}]},{"templateId":"45ea940a-45d2-4fd9-8da2-570a1a6d6874","templateType":"vpn-vedge"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"templateId":"81610551-9dc5-492f-ad3b-b2c30077b992"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/is_migration_required":{"get":{"tags":["Configuration - Template Master"],"description":"Check if any device templates need migration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"isMigrationRequired","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Boolean":{"description":"Boolean","value":{"data":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/migration":{"get":{"tags":["Configuration - Template Master"],"description":"Generate a list of templates which require migration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateForMigration","parameters":[{"name":"hasAAA","in":"query","description":"Return only those uses AAA","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template":{"description":"Template","value":{"data":[{"deviceType":"vedge-CSR-1000v","lastUpdatedBy":"admin","templateClass":"cedge_vedge","templateId":"c62e6fba-fb53-4562-b436-3878de0fbbc2","configType":"template","factoryDefault":false,"templateName":"BranchType1Template-CSR","devicesAttached":2,"templateDescription":"Branch Type 1 Template for CSR Routers","lastUpdatedOn":1588093291553,"templateAttached":22}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Template Master"],"description":"Migrate the device templates given the template Ids","operationId":"migrateTemplates","parameters":[{"name":"id","in":"query","description":"Template Id","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"prefix","in":"query","description":"Prefix","schema":{"type":"string","default":"cisco"}},{"name":"includeAll","in":"query","description":"Include all flag","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"status":"Template migration started","taskId":"TEMPLATE_MIGRATIONa548c416-bfb8-46dd-9866-d0aa042f17ab"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/migration_info":{"get":{"tags":["Configuration - Template Master"],"description":"Returns the mapping between old and migrated templates
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"migrationInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Migrated templates mapping":{"description":"Migrated templates mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/object/{templateId}":{"get":{"tags":["Configuration - Template Master"],"description":"Generate template by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getMasterTemplateDefinition","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateName":"Default_EQUINIX_DHCP_DNS_ICGW_CSR1000V_Template_V02","templateDescription":"Default DHCP DNS device template for Equinix Interconnect Gateway CSR1000V","deviceType":"vedge-CSR-1000v","configType":"template","factoryDefault":true,"policyId":"","featureTemplateUidRange":[],"connectionPreference":true,"connectionPreferenceRequired":true,"generalTemplates":[{"templateId":"857c21b1-6ceb-41a6-b4f1-f6f2c2fb3de6","templateType":"cedge_aaa"},{"templateId":"154fbddf-4430-4629-8fdc-6fd12d35d8b6","templateType":"cisco_bfd"},{"templateId":"c8f31360-9b6a-451e-8d21-aba3ac0c41d9","templateType":"cisco_omp"},{"templateId":"348a0dc3-2796-4b8f-9158-6faa384fa14c","templateType":"cisco_security"},{"templateId":"32372d0e-bcf6-416f-9c16-2d2ab14bd752","templateType":"cisco_system","subTemplates":[{"templateId":"8627651a-0140-42d9-925b-706e6281dbac","templateType":"cisco_logging"}]},{"templateId":"e54fc487-46d4-4f8c-8ffd-fec76ed1826c","templateType":"cisco_vpn","subTemplates":[{"templateId":"b8415ca4-16de-4bbb-90f3-05d652747370","templateType":"cisco_vpn_interface"}]},{"templateId":"db1d1bbf-a6b3-47b5-8c05-1f6004e3d68d","templateType":"cisco_vpn","subTemplates":[{"templateId":"5f0d22ae-b5ae-4c3c-afa7-53e2c8119ebd","templateType":"cisco_vpn_interface"}]},{"templateId":"b71170bc-97be-47b5-b9f8-bcf1782a8286","templateType":"cedge_global"}],"templateClass":"cedge","templateId":"067250e7-4e82-4ce0-9e42-1a58a9634afb","deviceRole":"sdwan-edge","draftMode":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/resource-group/{resourceGroupName}/{templateId}":{"post":{"tags":["Configuration - Template Master"],"description":"Change template resource group","operationId":"changeTemplateResourceGroup_1","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"path","description":"Resource group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/syncstatus":{"get":{"tags":["Configuration - Template Master"],"description":"Get template sync status
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getOutOfSyncTemplates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/syncstatus/{templateId}":{"get":{"tags":["Configuration - Template Master"],"description":"Get out of sync devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getOutOfSyncDevices","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/{templateId}":{"put":{"tags":["Configuration - Template Master"],"description":"Edit template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editMasterTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateId":"81610551-9dc5-492f-ad3b-b2c30077b992","templateName":"vEdge_Device_Template","templateDescription":"Demo device template","deviceType":"vedge-100","configType":"template","factoryDefault":false,"policyId":"","featureTemplateUidRange":[],"connectionPreferenceRequired":true,"connectionPreference":true,"draftMode":false,"generalTemplates":[{"templateId":"3b30e089-2e26-44f1-b5b2-ac44f3f4279e","templateType":"aaa"},{"templateId":"e1b5b6e9-3b54-4279-a532-a2aaaef3e6a1","templateType":"bfd-vedge"},{"templateId":"998725f9-3572-4950-a5e5-d48827d347cd","templateType":"omp-vedge"},{"templateId":"486d419f-4e6c-44a5-a6fb-7b5ccf94ff90","templateType":"security-vedge"},{"templateId":"7d7396a2-4715-44d8-8f6e-ddf0ca06be44","templateType":"system-vedge","subTemplates":[{"templateId":"edf3d309-91d4-45be-98d9-cfd57a05a479","templateType":"logging"}]},{"templateId":"171e9bd4-7a7b-460d-b692-83f0d5ce0124","templateType":"vpn-vedge","subTemplates":[{"templateId":"a632ee5f-f489-46ec-8761-1b493d5a6a40","templateType":"vpn-vedge-interface"}]},{"templateId":"45ea940a-45d2-4fd9-8da2-570a1a6d6874","templateType":"vpn-vedge"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attached devices":{"description":"Attached devices","value":{"data":{"attachedDevices":[]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Template Master"],"description":"Delete template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteMasterTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/feature":{"get":{"tags":["Configuration - General Template"],"description":"Get feature template list
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateFeatureTemplateList","parameters":[{"name":"summary","in":"query","description":"Flag to include template definition","schema":{"type":"boolean","default":false}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit on templateId","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Feature template":{"description":"Feature template","value":{"data":[{"templateId":"07a5de3c-4dfa-4eb3-bf52-7ee8076e29a9","templateName":"Default_Azure_vWAN_C8000V_VPN0_INTF_GE1_V01","templateDescription":"Default VPN 0 Interface GigabitEthernet1 template for Azure vWAN C8000V","templateType":"cisco_vpn_interface","deviceType":["vedge-C8000V"],"lastUpdatedBy":"system","lastUpdatedOn":1631281281614,"factoryDefault":true,"devicesAttached":0,"attachedMastersCount":1,"templateMinVersion":"20.4.0","configType":"xml","createdBy":"system","createdOn":1631281281614,"resourceGroup":"global"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"},"post":{"tags":["Configuration - General Template"],"description":"Create feature template","operationId":"createFeatureTemplate","requestBody":{"description":"Feature template","content":{"application/json":{"schema":{"type":"object"},"examples":{"CedgeVoiceCard-example":{"description":"CedgeVoiceCard-example","$ref":"examples/template/general/CedgeVoiceCard.json"},"CedgeVoiceSrst-example":{"description":"CedgeVoiceSrst-example","$ref":"examples/template/general/CedgeVoiceSrst.json"},"aaa-example":{"description":"aaa-example","$ref":"examples/template/general/aaa.json"},"appqoe-example":{"description":"appqoe-example","$ref":"examples/template/general/appqoe.json"},"archive-example":{"description":"archive-example","$ref":"examples/template/general/archive.json"},"banner-example":{"description":"banner-example","$ref":"examples/template/general/banner.json"},"bfd-vedge-example":{"description":"bfd-vedge-example","$ref":"examples/template/general/bfd-vedge.json"},"bgp-example":{"description":"bgp-example","$ref":"examples/template/general/bgp.json"},"bridge-example":{"description":"bridge-example","$ref":"examples/template/general/bridge.json"},"cedge_aaa-example":{"description":"cedge_aaa-example","$ref":"examples/template/general/cedge_aaa.json"},"cedge_global-example":{"description":"cedge_global-example","$ref":"examples/template/general/cedge_global.json"},"cedge_igmp-example":{"description":"cedge_igmp-example","$ref":"examples/template/general/cedge_igmp.json"},"cedge_multicast-example":{"description":"cedge_multicast-example","$ref":"examples/template/general/cedge_multicast.json"},"cedge_pim-example":{"description":"cedge_pim-example","$ref":"examples/template/general/cedge_pim.json"},"cellular-cedge-controller-example":{"description":"cellular-cedge-controller-example","$ref":"examples/template/general/cellular-cedge-controller.json"},"cellular-cedge-gps-controller-example":{"description":"cellular-cedge-gps-controller-example","$ref":"examples/template/general/cellular-cedge-gps-controller.json"},"cellular-cedge-profile-example":{"description":"cellular-cedge-profile-example","$ref":"examples/template/general/cellular-cedge-profile.json"},"cellular-gateway-platform-example":{"description":"cellular-gateway-platform-example","$ref":"examples/template/general/cellular-gateway-platform.json"},"cellular-gateway-profile-example":{"description":"cellular-gateway-profile-example","$ref":"examples/template/general/cellular-gateway-profile.json"},"cellular-profile-example":{"description":"cellular-profile-example","$ref":"examples/template/general/cellular-profile.json"},"cisco_banner-example":{"description":"cisco_banner-example","$ref":"examples/template/general/cisco_banner.json"},"cisco_bfd-example":{"description":"cisco_bfd-example","$ref":"examples/template/general/cisco_bfd.json"},"cisco_bgp-example":{"description":"cisco_bgp-example","$ref":"examples/template/general/cisco_bgp.json"},"cisco_dhcp_server-example":{"description":"cisco_dhcp_server-example","$ref":"examples/template/general/cisco_dhcp_server.json"},"cisco_dsp_farm-example":{"description":"cisco_dsp_farm-example","$ref":"examples/template/general/cisco_dsp_farm.json"},"cisco_logging-example":{"description":"cisco_logging-example","$ref":"examples/template/general/cisco_logging.json"},"cisco_ntp-example":{"description":"cisco_ntp-example","$ref":"examples/template/general/cisco_ntp.json"},"cisco_omp-example":{"description":"cisco_omp-example","$ref":"examples/template/general/cisco_omp.json"},"cisco_ospf-example":{"description":"cisco_ospf-example","$ref":"examples/template/general/cisco_ospf.json"},"cisco_ospfv3-example":{"description":"cisco_ospfv3-example","$ref":"examples/template/general/cisco_ospfv3.json"},"cisco_secure_internet_gateway-example":{"description":"cisco_secure_internet_gateway-example","$ref":"examples/template/general/cisco_secure_internet_gateway.json"},"cisco_security-example":{"description":"cisco_security-example","$ref":"examples/template/general/cisco_security.json"},"cisco_sig_credential-example":{"description":"cisco_sig_credential-example","$ref":"examples/template/general/cisco_sig_credentials.json"},"cisco_snmp-example":{"description":"cisco_snmp-example","$ref":"examples/template/general/cisco_snmp.json"},"cisco_system-example":{"description":"cisco_system-example","$ref":"examples/template/general/cisco_system.json"},"cisco_thousandeye-example":{"description":"cisco_thousandeye-example","$ref":"examples/template/general/cisco_thousandeyes.json"},"cisco_trustsec-example":{"description":"cisco_trustsec-example","$ref":"examples/template/general/cisco_trustsec.json"},"cisco_vp-example":{"description":"cisco_vp-example","$ref":"examples/template/general/cisco_vpn.json"},"cisco_vpn_interface-example":{"description":"cisco_vpn_interface-example","$ref":"examples/template/general/cisco_vpn_interface.json"},"cisco_vpn_interface_gre-example":{"description":"cisco_vpn_interface_gre-example","$ref":"examples/template/general/cisco_vpn_interface_gre.json"},"cisco_vpn_interface_ipsec-example":{"description":"cisco_vpn_interface_ipsec-example","$ref":"examples/template/general/cisco_vpn_interface_ipsec.json"},"cisco_wireless_la-example":{"description":"cisco_wireless_la-example","$ref":"examples/template/general/cisco_wireless_lan.json"},"cli-template-example":{"description":"cli-template-example","$ref":"examples/template/general/cli-template.json"},"dhcp-server-example":{"description":"dhcp-server-example","$ref":"examples/template/general/dhcp-server.json"},"eigrp-example":{"description":"eigrp-example","$ref":"examples/template/general/eigrp.json"},"igmp-example":{"description":"igmp-example","$ref":"examples/template/general/igmp.json"},"logging-example":{"description":"logging-example","$ref":"examples/template/general/logging.json"},"multicast-example":{"description":"multicast-example","$ref":"examples/template/general/multicast.json"},"ntp-example":{"description":"ntp-example","$ref":"examples/template/general/ntp.json"},"omp-vedge-example":{"description":"omp-vedge-example","$ref":"examples/template/general/omp-vedge.json"},"omp-vsmart-example":{"description":"omp-vsmart-example","$ref":"examples/template/general/omp-vsmart.json"},"ospf-example":{"description":"ospf-example","$ref":"examples/template/general/ospf.json"},"pim-example":{"description":"pim-example","$ref":"examples/template/general/pim.json"},"probe-example":{"description":"probe-example","$ref":"examples/template/general/probes.json"},"secure-internet-gateway-example":{"description":"secure-internet-gateway-example","$ref":"examples/template/general/secure-internet-gateway.json"},"security-vedge-example":{"description":"security-vedge-example","$ref":"examples/template/general/security-vedge.json"},"security-vsmart-example":{"description":"security-vsmart-example","$ref":"examples/template/general/security-vsmart.json"},"sig-credential-example":{"description":"sig-credential-example","$ref":"examples/template/general/sig-credentials.json"},"snmp-example":{"description":"snmp-example","$ref":"examples/template/general/snmp.json"},"switchport-example":{"description":"switchport-example","$ref":"examples/template/general/switchport.json"},"system-vedge-example":{"description":"system-vedge-example","$ref":"examples/template/general/system-vedge.json"},"system-vsmart-example":{"description":"system-vsmart-example","$ref":"examples/template/general/system-vsmart.json"},"t1-e1-controller-example":{"description":"t1-e1-controller-example","$ref":"examples/template/general/t1-e1-controller.json"},"tenant-example":{"description":"tenant-example","$ref":"examples/template/general/tenant.json"},"ucse-example":{"description":"ucse-example","$ref":"examples/template/general/ucse.json"},"virtual-application-utd-example":{"description":"virtual-application-utd-example","$ref":"examples/template/general/virtual-application-utd.json"},"vpn-cedge-interface-cellular-example":{"description":"vpn-cedge-interface-cellular-example","$ref":"examples/template/general/vpn-cedge-interface-cellular.json"},"vpn-cedge-interface-multilink-controller-example":{"description":"vpn-cedge-interface-multilink-controller-example","$ref":"examples/template/general/vpn-cedge-interface-multilink-controller.json"},"vpn-interface-ethpppoe-example":{"description":"vpn-interface-ethpppoe-example","$ref":"examples/template/general/vpn-interface-ethpppoe.json"},"vpn-interface-ipoe-example":{"description":"vpn-interface-ipoe-example","$ref":"examples/template/general/vpn-interface-ipoe.json"},"vpn-interface-pppoa-example":{"description":"vpn-interface-pppoa-example","$ref":"examples/template/general/vpn-interface-pppoa.json"},"vpn-interface-pppoe-example":{"description":"vpn-interface-pppoe-example","$ref":"examples/template/general/vpn-interface-pppoe.json"},"vpn-interface-svi-example":{"description":"vpn-interface-svi-example","$ref":"examples/template/general/vpn-interface-svi.json"},"vpn-interface-t1-e1-example":{"description":"vpn-interface-t1-e1-example","$ref":"examples/template/general/vpn-interface-t1-e1.json"},"vpn-vedge-interface-bridge-example":{"description":"vpn-vedge-interface-bridge-example","$ref":"examples/template/general/vpn-vedge-interface-bridge.json"},"vpn-vedge-interface-cellular-example":{"description":"vpn-vedge-interface-cellular-example","$ref":"examples/template/general/vpn-vedge-interface-cellular.json"},"vpn-vedge-interface-gre-example":{"description":"vpn-vedge-interface-gre-example","$ref":"examples/template/general/vpn-vedge-interface-gre.json"},"vpn-vedge-interface-ipsec-example":{"description":"vpn-vedge-interface-ipsec-example","$ref":"examples/template/general/vpn-vedge-interface-ipsec.json"},"vpn-vedge-interface-natpool-example":{"description":"vpn-vedge-interface-natpool-example","$ref":"examples/template/general/vpn-vedge-interface-natpool.json"},"vpn-vedge-interface-ppp-example":{"description":"vpn-vedge-interface-ppp-example","$ref":"examples/template/general/vpn-vedge-interface-ppp.json"},"vpn-vedge-interface-vap-example":{"description":"vpn-vedge-interface-vap-example","$ref":"examples/template/general/vpn-vedge-interface-vap.json"},"vpn-vedge-interface-example":{"description":"vpn-vedge-interface-example","$ref":"examples/template/general/vpn-vedge-interface.json"},"vpn-vedge-pppoe-enabled-interface-example":{"description":"vpn-vedge-pppoe-enabled-interface-example","$ref":"examples/template/general/vpn-vedge-pppoe-enabled-interface.json"},"vpn-vedge-example":{"description":"vpn-vedge-example","$ref":"examples/template/general/vpn-vedge.json"},"vpn-vmanage-interface-example":{"description":"vpn-vmanage-interface-example","$ref":"examples/template/general/vpn-vmanage-interface.json"},"vpn-vsmart-interface-example":{"description":"vpn-vsmart-interface-example","$ref":"examples/template/general/vpn-vsmart-interface.json"},"vpn-vsmart-example":{"description":"vpn-vsmart-example","$ref":"examples/template/general/vpn-vsmart.json"},"wla-example":{"description":"wla-example","$ref":"examples/template/general/wlan.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature template":{"description":"Feature template","value":{"templateId":"ff3b31b1-0262-44d3-badf-d9cf472fb4b1"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/template/feature/clone":{"post":{"tags":["Configuration - General Template"],"description":"Clone a feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"cloneTemplate","parameters":[{"name":"id","in":"query","description":"Template Id to clone from","required":true,"schema":{"type":"string"},"example":"220a6bd0-28ef-4c88-92e6-ee7539396fd7"},{"name":"name","in":"query","description":"Name for the cloned template","required":true,"schema":{"type":"string"},"example":"BR2-VPN10-Feature"},{"name":"desc","in":"query","description":"Description for the cloned template","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"templateId":"ff3b31b1-0262-44d3-badf-d9cf472fb4b1"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/template/feature/default/networkinterface":{"get":{"tags":["Configuration - General Template"],"description":"Get default network interface
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getNetworkInterface","parameters":[{"name":"deviceModel","in":"query","description":"Device model","required":true,"schema":{"type":"string","enum":["ENCS","C8200-UCPE","C8200-UCPEVM"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Default network Interface":{"description":"Default network Interface","value":{"data":[{"lan":["GE0-2","GE0-3","GE0-4","GE0-5"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/feature/default/networks":{"get":{"tags":["Configuration - General Template"],"description":"Get default networks
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDefaultNetworks","parameters":[{"name":"deviceModel","in":"query","description":"Device model","required":true,"schema":{"type":"string","enum":["vedge-nfvis-ENCS5400","vedge-nfvis-C8200-UCPE","vedge-nfvis-C8200-UCPEVM"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Default network":{"description":"Default network","value":{"data":[{"name":"wan-net","sriov":false,"trunk":true,"bridge":"wan-br","bridgePort":"GE0-0"},{"name":"wan2-net","sriov":false,"trunk":true,"bridge":"wan2-br","bridgePort":"GE0-1"},{"name":"lan-net","sriov":false,"trunk":true,"bridge":"lan-br","bridgePort":"int-LAN"},{"name":"GE0-0-SRIOV-1","sriov":true,"trunk":true},{"name":"GE0-0-SRIOV-2","sriov":true,"trunk":true},{"name":"GE0-1-SRIOV-1","sriov":true,"trunk":true},{"name":"GE0-1-SRIOV-2","sriov":true,"trunk":true},{"name":"LAN-SRIOV-1","sriov":true,"trunk":true},{"name":"LAN-SRIOV-2","sriov":true,"trunk":true},{"name":"LAN-SRIOV-3","sriov":true,"trunk":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/feature/definition/{templateId}":{"get":{"tags":["Configuration - General Template"],"description":"Get the configured template definition for given template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTemplateDefinition","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template definition":{"description":"Template definition","value":{"appnav-controller-group":{"vipObjectType":"tree","vipType":"constant","vipValue":[{"group-name":{"vipObjectType":"object","vipType":"constant","vipValue":"ACG-APPQOE"},"appnav-controllers":{"vipObjectType":"tree","vipType":"constant","vipPrimaryKey":["address"],"vipValue":[{"address":{"vipObjectType":"object","vipType":"constant","vipValue":"10.10.10.10"},"vpn":{"vipObjectType":"object","vipType":"constant","vipValue":512}}]}}],"vipPrimaryKey":["group-name"]},"service-node-group":{"vipObjectType":"tree","vipType":"constant","vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"SNG-APPQOE"},"internal":{"vipObjectType":"node-only","vipType":"constant","vipValue":false},"service-node":{"vipObjectType":"tree","vipType":"constant","vipPrimaryKey":["address"],"vipValue":[{"address":{"vipObjectType":"object","vipType":"constant","vipValue":"10.10.11.11"},"vpg-ip":{"vipObjectType":"object","vipType":"ignore","vipValue":""}}]}}],"vipPrimaryKey":["name"]},"service-context":{"appqoe":{"vipObjectType":"tree","vipType":"constant","vipPrimaryKey":["name"],"vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"/1"},"appnav-controller-group":{"vipObjectType":"object","vipType":"constant","vipValue":"ACG-APPQOE"},"service-node-groups":{"vipObjectType":"list","vipType":"constant","vipValue":["SNG-APPQOE"]},"service-node-group":{"vipObjectType":"object","vipType":"constant","vipValue":"SNG-APPQOE"},"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true"},"vpn":{"vipObjectType":"object","vipType":"ignore","vipValue":0,"vipVariableName":"appqoe_vrf"}}]}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"}},"/template/feature/devicetemplates/{templateId}":{"get":{"tags":["Configuration - General Template"],"description":"Get all device templates for this feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDeviceTemplatesAttachedToFeature","parameters":[{"name":"templateId","in":"path","description":"Feature template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"data":[{"templateName":"Default_SDBranch_C8000V_Template_V01","templateId":"cd72321b-9ff0-4fb3-badd-965d528e71ac"},{"templateName":"Default_BOOTSTRAP_DHCP_8000V_Template_V01","templateId":"41c50079-1978-462e-8489-d4ad5d3b3644"},{"templateName":"Default_MEGAPORT_ICGW_C8000V_Template_V01","templateId":"5880350d-bdb9-4d34-85b0-782c77c96ea9"},{"templateName":"Default_EQUINIX_DHCP_DNS_ICGW_CSR1000V_Template_V02","templateId":"600ca2bc-0cc1-4c1b-a3cd-4fa4ae4dc2e1"},{"templateName":"Default_Azure_vWAN_C8000V_Template_V01","templateId":"a1e8373a-9b9b-4d22-b275-bc1671891798"},{"templateName":"Factory_Default_C8000V_V01","templateId":"0513c5c1-b1e9-4b89-875f-fbe0f8957611"},{"templateName":"Default_BOOTSTRAP_STATIC_8000V_Template_V01","templateId":"af0119de-0223-4ddd-9515-f12a03affc77"},{"templateName":"Default_AWS_TGW_C8000V_Template_V01","templateId":"7188945f-7b44-4d45-8dbc-71a24218bcbd"},{"templateName":"Default_GCP_C8000V_Template_V01","templateId":"873e7414-dd35-4706-b776-c7d2b6d1ee55"},{"templateName":"Default_AWS_TGW_CSR1000V_Template_V01","templateId":"d4e1bd4b-bec8-4522-94c5-7047b44ee02a"},{"templateName":"Factory_Default_ISR_4331_V01","templateId":"6c69af42-5cc4-4f76-92b7-f0e20d4969e4"},{"templateName":"Factory_Default_C1111_8PLTELA_V01","templateId":"ef3a49c8-87cb-41b5-913e-042d110ca1f2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/li":{"get":{"tags":["Configuration - General Template"],"description":"Get LI feature template","operationId":"listLITemplate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"LI template":{"description":"LI template","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Lawful Interception-read"},"post":{"tags":["Configuration - General Template"],"description":"Create LI feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createLITemplate","requestBody":{"description":"LI template","content":{"application/json":{"schema":{"type":"object"},"examples":{"LI template":{"description":"LI template","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Lawful Interception-write"}},"/template/feature/li/{templateId}":{"put":{"tags":["Configuration - General Template"],"description":"Update LI feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editLITemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"LI template","content":{"application/json":{"schema":{"type":"object"},"examples":{"LI template":{"description":"LI template","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Lawful Interception-write"}},"/template/feature/master/{type_name}":{"get":{"tags":["Configuration - General Template"],"description":"Generate template type definition by device type
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateMasterTemplateDefinition","parameters":[{"name":"type_name","in":"path","description":"Device type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"name":"vedge","fields":[{"min":0,"deviceModels":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vedge-ISR1100-4GLTE","vedge-100-WM","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"max":1,"displayName":"AAA","name":"aaa"},{"subtree":[{"subtree":[{"min":0,"deviceModels":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vedge-ISR1100-4GLTE","vedge-100-WM","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"max":1,"displayName":"DHCPServer","name":"dhcp-server"}]}],"min":0,"deviceModels":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vedge-ISR1100-4GLTE","vedge-100-WM","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"max":62,"displayName":"VPN","name":"vpn-vedge","type":""}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/migration":{"get":{"tags":["Configuration - General Template"],"description":"Generate a list of templates which require migration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTemplateForMigration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":{"data":[{"deviceType":"vedge-CSR-1000v","lastUpdatedBy":"admin","templateClass":"cedge_vedge","templateId":"c62e6fba-fb53-4562-b436-3878de0fbbc2","configType":"template","factoryDefault":false,"templateName":"BranchType1Template-CSR","devicesAttached":2,"templateDescription":"Branch Type 1 Template for CSR Routers","lastUpdatedOn":1588093291553,"templateAttached":22}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read,Lawful Interception-read"}},"/template/feature/object/{templateId}":{"get":{"tags":["Configuration - General Template"],"description":"Get template object definition for given template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getGeneralTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateType":"cedgeVoiceCard","templateMinVersion":"15.0.0","deviceType":["vedge-ISR-4461"],"lastUpdatedBy":"admin","editedTemplateDefinition":{"voice-card":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["port-id"],"vipValue":[{"port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0/7"},"id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0","vipVariableName":"analog_id"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"SM-X-8FXS/12FXO"},"description":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_description_"},"caller-id":{"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true","vipVariableName":"analog_caller_id_"}},"port-type":{"vipObjectType":"object","vipType":"constant","vipValue":"FXS","vipVariableName":"analog_port_type_"},"secondary":{"dialtone":{"vipObjectType":"node-only","vipType":"ignore","vipValue":"false","vipVariableName":"analog_secondary_dialtone_"}},"shutdown":{"vipObjectType":"object","vipType":"constant","vipValue":"false","vipVariableName":"analog_shutdown_"},"connection":{"plar":{"plar-num":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_connection_plarnum_"},"opx-num-only":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}},"signal":{"did-type":{"vipType":"ignore","vipValue":"","vipObjectType":"object"},"signal-choice":{"vipObjectType":"object","vipType":"ignore","vipValue":"loopStart","vipVariableName":"analog_signal_choice_"}},"port-range":{"vipObjectType":"object","vipType":"constant","vipValue":"7","vipVariableName":"analog_port_range_"},"local-bypass":{"vipType":"constant","vipValue":"true","vipObjectType":"object"}}]},"voice-card-dig":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["dig-port-id"],"vipValue":[{"dig-port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1/0"},"id-dig":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1"},"framing":{"vipObjectType":"object","vipType":"notIgnore","vipValue":"esf","vipVariableName":"framing_0"},"interface":{"vipType":"constant","vipValue":[{"port-id":{"vipType":"constant","vipValue":"0/1/0","vipObjectType":"object"},"clock-priority":{"vipType":"constant","vipValue":0,"vipObjectType":"object"},"controller-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"serial-intf-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"voiceport-shutdown":{"vipType":"constant","vipValue":true,"vipObjectType":"object"},"clock-type":{"vipType":"constant","vipValue":"line","vipObjectType":"object"},"clock-position":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}],"vipObjectType":"tree","vipPrimaryKey":["port-id"]},"interface-type":{"vipObjectType":"object","vipType":"constant","vipValue":"T1 PRI"},"line-termination":{"vipObjectType":"object","vipType":"ignore","vipValue":"120-ohm","vipVariableName":"digital_line-termination"},"linecode":{"vipObjectType":"object","vipType":"constant","vipValue":"b8zs","vipVariableName":"linecode_0"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"NIM-1MFT-T1/E1"},"network-side":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"digital_network-side"},"switch-type":{"vipObjectType":"object","vipType":"constant","vipValue":"primary-4ess","vipVariableName":"digital_switch-type"},"timeslots":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"digital_timeslots"},"delay-connect-timer":{"vipObjectType":"object","vipType":"constant","vipValue":20,"vipVariableName":"digital_delay_connect_timer"},"dsp-hairpin":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"framing-australia":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"network-participation":{"vipType":"constant","vipValue":"true","vipObjectType":"object"},"isdn-timer":{"isdn-timer-T200":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"digital_isdn-timer-T200"},"isdn-timer-T203":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T203"},"isdn-timer-T301":{"vipObjectType":"object","vipType":"ignore","vipValue":300000,"vipVariableName":"digital_isdn-timer-T301"},"isdn-timer-T303":{"vipObjectType":"object","vipType":"ignore","vipValue":4000,"vipVariableName":"digital_isdn-timer-T303"},"isdn-timer-T306":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T306"},"isdn-timer-T309":{"vipObjectType":"object","vipType":"ignore","vipValue":90000,"vipVariableName":"digital_isdn-timer-T309"},"isdn-timer-T310":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T310"},"isdn-timer-T321":{"vipObjectType":"object","vipType":"ignore","vipValue":40000,"vipVariableName":"digital_isdn-timer-T321"}},"cablelength-long":{"vipObjectType":"object","vipType":"constant","vipValue":"-7.5","vipVariableName":"digital_cablelength-long"}}]},"clock-dig":{"sync":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"digital_sync"},"wait-to-restore":{"vipObjectType":"object","vipType":"ignore","vipValue":300,"vipVariableName":"digital_wait-to-restore"}}},"gTemplateClass":"cedge","templateDefinition":{"voice-card":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["port-id"],"vipValue":[{"port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0/7"},"id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0","vipVariableName":"analog_id"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"SM-X-8FXS/12FXO"},"description":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_description_"},"caller-id":{"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true","vipVariableName":"analog_caller_id_"}},"port-type":{"vipObjectType":"object","vipType":"constant","vipValue":"FXS","vipVariableName":"analog_port_type_"},"secondary":{"dialtone":{"vipObjectType":"node-only","vipType":"ignore","vipValue":"false","vipVariableName":"analog_secondary_dialtone_"}},"shutdown":{"vipObjectType":"object","vipType":"constant","vipValue":"false","vipVariableName":"analog_shutdown_"},"connection":{"plar":{"plar-num":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_connection_plarnum_"},"opx-num-only":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}},"signal":{"did-type":{"vipType":"ignore","vipValue":"","vipObjectType":"object"},"signal-choice":{"vipObjectType":"object","vipType":"ignore","vipValue":"loopStart","vipVariableName":"analog_signal_choice_"}},"port-range":{"vipObjectType":"object","vipType":"constant","vipValue":"7","vipVariableName":"analog_port_range_"},"local-bypass":{"vipType":"constant","vipValue":"true","vipObjectType":"object"}}]},"voice-card-dig":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["dig-port-id"],"vipValue":[{"dig-port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1/0"},"id-dig":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1"},"framing":{"vipObjectType":"object","vipType":"notIgnore","vipValue":"esf","vipVariableName":"framing_0"},"interface":{"vipType":"constant","vipValue":[{"port-id":{"vipType":"constant","vipValue":"0/1/0","vipObjectType":"object"},"clock-priority":{"vipType":"constant","vipValue":0,"vipObjectType":"object"},"controller-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"serial-intf-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"voiceport-shutdown":{"vipType":"constant","vipValue":true,"vipObjectType":"object"},"clock-type":{"vipType":"constant","vipValue":"line","vipObjectType":"object"},"clock-position":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}],"vipObjectType":"tree","vipPrimaryKey":["port-id"]},"interface-type":{"vipObjectType":"object","vipType":"constant","vipValue":"T1 PRI"},"line-termination":{"vipObjectType":"object","vipType":"ignore","vipValue":"120-ohm","vipVariableName":"digital_line-termination"},"linecode":{"vipObjectType":"object","vipType":"constant","vipValue":"b8zs","vipVariableName":"linecode_0"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"NIM-1MFT-T1/E1"},"network-side":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"digital_network-side"},"switch-type":{"vipObjectType":"object","vipType":"constant","vipValue":"primary-4ess","vipVariableName":"digital_switch-type"},"timeslots":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"digital_timeslots"},"delay-connect-timer":{"vipObjectType":"object","vipType":"constant","vipValue":20,"vipVariableName":"digital_delay_connect_timer"},"dsp-hairpin":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"framing-australia":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"network-participation":{"vipType":"constant","vipValue":"true","vipObjectType":"object"},"isdn-timer":{"isdn-timer-T200":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"digital_isdn-timer-T200"},"isdn-timer-T203":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T203"},"isdn-timer-T301":{"vipObjectType":"object","vipType":"ignore","vipValue":300000,"vipVariableName":"digital_isdn-timer-T301"},"isdn-timer-T303":{"vipObjectType":"object","vipType":"ignore","vipValue":4000,"vipVariableName":"digital_isdn-timer-T303"},"isdn-timer-T306":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T306"},"isdn-timer-T309":{"vipObjectType":"object","vipType":"ignore","vipValue":90000,"vipVariableName":"digital_isdn-timer-T309"},"isdn-timer-T310":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T310"},"isdn-timer-T321":{"vipObjectType":"object","vipType":"ignore","vipValue":40000,"vipVariableName":"digital_isdn-timer-T321"}},"cablelength-long":{"vipObjectType":"object","vipType":"constant","vipValue":"-7.5","vipVariableName":"digital_cablelength-long"}}]},"clock-dig":{"sync":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"digital_sync"},"wait-to-restore":{"vipObjectType":"object","vipType":"ignore","vipValue":300,"vipVariableName":"digital_wait-to-restore"}}},"configType":"xml","attachedMastersCount":0,"templateId":"30ebbc4a-6596-45b8-acfb-c62fe2add788","createdOn":1652776377626,"@rid":918,"factoryDefault":false,"feature":"vmanage-default","templateName":"template_voice_card","createdBy":"admin","devicesAttached":0,"templateDescription":"template_voice_card","lastUpdatedOn":1652776377626}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"}},"/template/feature/resource-group/{resourceGroupName}/{templateId}":{"post":{"tags":["Configuration - General Template"],"description":"Change template resource group","operationId":"changeTemplateResourceGroup","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"path","description":"Resrouce group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"}},"/template/feature/types":{"get":{"tags":["Configuration - General Template"],"description":"Generate template types
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateTypes","parameters":[{"name":"type","in":"query","description":"Device type","required":true,"schema":{"type":"string","enum":["vedge","cedge","all","default"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template type":{"description":"Template type","value":{"data":[{"parent":"basic_info","default":"aaa/aaa.json","deviceModels":[{"name":"vedge-1000"},{"name":"vedge-2000"},{"name":"vedge-cloud"},{"name":"vedge-5000"},{"name":"vedge-ISR1100-6G"},{"name":"vedge-100-B"},{"name":"vedge-ISR1100-4G"},{"name":"vedge-100"},{"name":"vsmart"},{"name":"vedge-ISR1100-4GLTE"},{"name":"vedge-100-WM"},{"name":"vmanage"},{"name":"vbond"},{"name":"vedge-100-M"},{"name":"vedge-ISR1100X-6G"},{"name":"vedge-ISR1100X-4G"}],"displayName":"AAA","name":"aaa","typeClass":"DefaultGeneralTemplate","description":"AAA","write_permission":true,"read_permission":true,"helperType":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/types/definition/{type_name}/{version}":{"get":{"tags":["Configuration - General Template"],"description":"Generate template type definition
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateTypeDefinition","parameters":[{"name":"type_name","in":"path","description":"Feature template type","required":true,"schema":{"type":"string","example":"cisco_system"}},{"name":"version","in":"path","description":"Version","required":true,"schema":{"type":"string","example":"2"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template type":{"description":"Template type","value":{"xmlPath":[],"xmlRootTag":"system","nameSpace":"http://viptela.com/system","name":"cisco_system","fields":[{"optionType":["constant","ignore"],"description":"Enable Migration Mode to Hierarchical SDWAN","dataType":{"type":"enum","values":[{"key":"enabled","value":"Enable"},{"key":"enabled-from-bgp-core","value":"Enable from BGP Core"}]},"defaultOption":"ignore","dataPath":[],"details":"Enable migration mode to Hierarchical SDWAN","key":"enable-hsdwan-migration","objectType":"object"},{"optionType":["constant","ignore"],"description":"Migration BGP Community","dataType":{"max":4294967295,"type":"number","min":1},"defaultOption":"ignore","dataPath":[],"details":"Set BGP community during migration from BGP-core based network","key":"migration-bgp-community","objectType":"object"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/{deviceType}":{"get":{"tags":["Configuration - General Template"],"description":"Generate template based on device
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateByDeviceType","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Feature template":{"description":"Feature template","value":{"data":[{"templateMinVersion":"20.1.0","templateType":"logging","deviceType":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vsmart","vedge-ISR1100-4GLTE","vedge-100-WM","vmanage","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"lastUpdatedBy":"system","editedTemplateDefinition":"{\"disk\":{\"enable\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"file\":{\"size\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"},\"rotate\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"}},\"priority\":{\"vipObjectType\":\"object\",\"vipValue\":\"information\",\"vipType\":\"ignore\"}}}","gTemplateClass":"vedge","templateDefinition":"{\"disk\":{\"enable\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"file\":{\"size\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"},\"rotate\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"}},\"priority\":{\"vipObjectType\":\"object\",\"vipValue\":\"information\",\"vipType\":\"ignore\"}}}","configType":"xml","attachedMastersCount":1,"templateId":"5f459c3b-2e77-4399-8b0d-f1d5cf048035","createdOn":1652417246799,"@rid":108,"factoryDefault":true,"feature":"vmanage-default","templateName":"Factory_Default_Logging_Template_V01","createdBy":"system","devicesAttached":0,"templateDescription":"DefaultLoggingtemplatesettingsVersion01","lastUpdatedOn":1652417246799}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/feature/{templateId}":{"put":{"tags":["Configuration - General Template"],"description":"Update feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editFeatureTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template","content":{"application/json":{"schema":{"type":"object"},"examples":{"CedgeVoiceCard-example":{"description":"CedgeVoiceCard-example","$ref":"examples/template/general/CedgeVoiceCard.json"},"CedgeVoiceSrst-example":{"description":"CedgeVoiceSrst-example","$ref":"examples/template/general/CedgeVoiceSrst.json"},"aaa-example":{"description":"aaa-example","$ref":"examples/template/general/aaa.json"},"appqoe-example":{"description":"appqoe-example","$ref":"examples/template/general/appqoe.json"},"archive-example":{"description":"archive-example","$ref":"examples/template/general/archive.json"},"banner-example":{"description":"banner-example","$ref":"examples/template/general/banner.json"},"bfd-vedge-example":{"description":"bfd-vedge-example","$ref":"examples/template/general/bfd-vedge.json"},"bgp-example":{"description":"bgp-example","$ref":"examples/template/general/bgp.json"},"bridge-example":{"description":"bridge-example","$ref":"examples/template/general/bridge.json"},"cedge_aaa-example":{"description":"cedge_aaa-example","$ref":"examples/template/general/cedge_aaa.json"},"cedge_global-example":{"description":"cedge_global-example","$ref":"examples/template/general/cedge_global.json"},"cedge_igmp-example":{"description":"cedge_igmp-example","$ref":"examples/template/general/cedge_igmp.json"},"cedge_multicast-example":{"description":"cedge_multicast-example","$ref":"examples/template/general/cedge_multicast.json"},"cedge_pim-example":{"description":"cedge_pim-example","$ref":"examples/template/general/cedge_pim.json"},"cellular-cedge-controller-example":{"description":"cellular-cedge-controller-example","$ref":"examples/template/general/cellular-cedge-controller.json"},"cellular-cedge-gps-controller-example":{"description":"cellular-cedge-gps-controller-example","$ref":"examples/template/general/cellular-cedge-gps-controller.json"},"cellular-cedge-profile-example":{"description":"cellular-cedge-profile-example","$ref":"examples/template/general/cellular-cedge-profile.json"},"cellular-gateway-platform-example":{"description":"cellular-gateway-platform-example","$ref":"examples/template/general/cellular-gateway-platform.json"},"cellular-gateway-profile-example":{"description":"cellular-gateway-profile-example","$ref":"examples/template/general/cellular-gateway-profile.json"},"cellular-profile-example":{"description":"cellular-profile-example","$ref":"examples/template/general/cellular-profile.json"},"cisco_banner-example":{"description":"cisco_banner-example","$ref":"examples/template/general/cisco_banner.json"},"cisco_bfd-example":{"description":"cisco_bfd-example","$ref":"examples/template/general/cisco_bfd.json"},"cisco_bgp-example":{"description":"cisco_bgp-example","$ref":"examples/template/general/cisco_bgp.json"},"cisco_dhcp_server-example":{"description":"cisco_dhcp_server-example","$ref":"examples/template/general/cisco_dhcp_server.json"},"cisco_dsp_farm-example":{"description":"cisco_dsp_farm-example","$ref":"examples/template/general/cisco_dsp_farm.json"},"cisco_logging-example":{"description":"cisco_logging-example","$ref":"examples/template/general/cisco_logging.json"},"cisco_ntp-example":{"description":"cisco_ntp-example","$ref":"examples/template/general/cisco_ntp.json"},"cisco_omp-example":{"description":"cisco_omp-example","$ref":"examples/template/general/cisco_omp.json"},"cisco_ospf-example":{"description":"cisco_ospf-example","$ref":"examples/template/general/cisco_ospf.json"},"cisco_ospfv3-example":{"description":"cisco_ospfv3-example","$ref":"examples/template/general/cisco_ospfv3.json"},"cisco_secure_internet_gateway-example":{"description":"cisco_secure_internet_gateway-example","$ref":"examples/template/general/cisco_secure_internet_gateway.json"},"cisco_security-example":{"description":"cisco_security-example","$ref":"examples/template/general/cisco_security.json"},"cisco_sig_credential-example":{"description":"cisco_sig_credential-example","$ref":"examples/template/general/cisco_sig_credentials.json"},"cisco_snmp-example":{"description":"cisco_snmp-example","$ref":"examples/template/general/cisco_snmp.json"},"cisco_system-example":{"description":"cisco_system-example","$ref":"examples/template/general/cisco_system.json"},"cisco_thousandeye-example":{"description":"cisco_thousandeye-example","$ref":"examples/template/general/cisco_thousandeyes.json"},"cisco_trustsec-example":{"description":"cisco_trustsec-example","$ref":"examples/template/general/cisco_trustsec.json"},"cisco_vp-example":{"description":"cisco_vp-example","$ref":"examples/template/general/cisco_vpn.json"},"cisco_vpn_interface-example":{"description":"cisco_vpn_interface-example","$ref":"examples/template/general/cisco_vpn_interface.json"},"cisco_vpn_interface_gre-example":{"description":"cisco_vpn_interface_gre-example","$ref":"examples/template/general/cisco_vpn_interface_gre.json"},"cisco_vpn_interface_ipsec-example":{"description":"cisco_vpn_interface_ipsec-example","$ref":"examples/template/general/cisco_vpn_interface_ipsec.json"},"cisco_wireless_la-example":{"description":"cisco_wireless_la-example","$ref":"examples/template/general/cisco_wireless_lan.json"},"cli-template-example":{"description":"cli-template-example","$ref":"examples/template/general/cli-template.json"},"dhcp-server-example":{"description":"dhcp-server-example","$ref":"examples/template/general/dhcp-server.json"},"eigrp-example":{"description":"eigrp-example","$ref":"examples/template/general/eigrp.json"},"igmp-example":{"description":"igmp-example","$ref":"examples/template/general/igmp.json"},"logging-example":{"description":"logging-example","$ref":"examples/template/general/logging.json"},"multicast-example":{"description":"multicast-example","$ref":"examples/template/general/multicast.json"},"ntp-example":{"description":"ntp-example","$ref":"examples/template/general/ntp.json"},"omp-vedge-example":{"description":"omp-vedge-example","$ref":"examples/template/general/omp-vedge.json"},"omp-vsmart-example":{"description":"omp-vsmart-example","$ref":"examples/template/general/omp-vsmart.json"},"ospf-example":{"description":"ospf-example","$ref":"examples/template/general/ospf.json"},"pim-example":{"description":"pim-example","$ref":"examples/template/general/pim.json"},"probe-example":{"description":"probe-example","$ref":"examples/template/general/probes.json"},"secure-internet-gateway-example":{"description":"secure-internet-gateway-example","$ref":"examples/template/general/secure-internet-gateway.json"},"security-vedge-example":{"description":"security-vedge-example","$ref":"examples/template/general/security-vedge.json"},"security-vsmart-example":{"description":"security-vsmart-example","$ref":"examples/template/general/security-vsmart.json"},"sig-credential-example":{"description":"sig-credential-example","$ref":"examples/template/general/sig-credentials.json"},"snmp-example":{"description":"snmp-example","$ref":"examples/template/general/snmp.json"},"switchport-example":{"description":"switchport-example","$ref":"examples/template/general/switchport.json"},"system-vedge-example":{"description":"system-vedge-example","$ref":"examples/template/general/system-vedge.json"},"system-vsmart-example":{"description":"system-vsmart-example","$ref":"examples/template/general/system-vsmart.json"},"t1-e1-controller-example":{"description":"t1-e1-controller-example","$ref":"examples/template/general/t1-e1-controller.json"},"tenant-example":{"description":"tenant-example","$ref":"examples/template/general/tenant.json"},"ucse-example":{"description":"ucse-example","$ref":"examples/template/general/ucse.json"},"virtual-application-utd-example":{"description":"virtual-application-utd-example","$ref":"examples/template/general/virtual-application-utd.json"},"vpn-cedge-interface-cellular-example":{"description":"vpn-cedge-interface-cellular-example","$ref":"examples/template/general/vpn-cedge-interface-cellular.json"},"vpn-cedge-interface-multilink-controller-example":{"description":"vpn-cedge-interface-multilink-controller-example","$ref":"examples/template/general/vpn-cedge-interface-multilink-controller.json"},"vpn-interface-ethpppoe-example":{"description":"vpn-interface-ethpppoe-example","$ref":"examples/template/general/vpn-interface-ethpppoe.json"},"vpn-interface-ipoe-example":{"description":"vpn-interface-ipoe-example","$ref":"examples/template/general/vpn-interface-ipoe.json"},"vpn-interface-pppoa-example":{"description":"vpn-interface-pppoa-example","$ref":"examples/template/general/vpn-interface-pppoa.json"},"vpn-interface-pppoe-example":{"description":"vpn-interface-pppoe-example","$ref":"examples/template/general/vpn-interface-pppoe.json"},"vpn-interface-svi-example":{"description":"vpn-interface-svi-example","$ref":"examples/template/general/vpn-interface-svi.json"},"vpn-interface-t1-e1-example":{"description":"vpn-interface-t1-e1-example","$ref":"examples/template/general/vpn-interface-t1-e1.json"},"vpn-vedge-interface-bridge-example":{"description":"vpn-vedge-interface-bridge-example","$ref":"examples/template/general/vpn-vedge-interface-bridge.json"},"vpn-vedge-interface-cellular-example":{"description":"vpn-vedge-interface-cellular-example","$ref":"examples/template/general/vpn-vedge-interface-cellular.json"},"vpn-vedge-interface-gre-example":{"description":"vpn-vedge-interface-gre-example","$ref":"examples/template/general/vpn-vedge-interface-gre.json"},"vpn-vedge-interface-ipsec-example":{"description":"vpn-vedge-interface-ipsec-example","$ref":"examples/template/general/vpn-vedge-interface-ipsec.json"},"vpn-vedge-interface-natpool-example":{"description":"vpn-vedge-interface-natpool-example","$ref":"examples/template/general/vpn-vedge-interface-natpool.json"},"vpn-vedge-interface-ppp-example":{"description":"vpn-vedge-interface-ppp-example","$ref":"examples/template/general/vpn-vedge-interface-ppp.json"},"vpn-vedge-interface-vap-example":{"description":"vpn-vedge-interface-vap-example","$ref":"examples/template/general/vpn-vedge-interface-vap.json"},"vpn-vedge-interface-example":{"description":"vpn-vedge-interface-example","$ref":"examples/template/general/vpn-vedge-interface.json"},"vpn-vedge-pppoe-enabled-interface-example":{"description":"vpn-vedge-pppoe-enabled-interface-example","$ref":"examples/template/general/vpn-vedge-pppoe-enabled-interface.json"},"vpn-vedge-example":{"description":"vpn-vedge-example","$ref":"examples/template/general/vpn-vedge.json"},"vpn-vmanage-interface-example":{"description":"vpn-vmanage-interface-example","$ref":"examples/template/general/vpn-vmanage-interface.json"},"vpn-vsmart-interface-example":{"description":"vpn-vsmart-interface-example","$ref":"examples/template/general/vpn-vsmart-interface.json"},"vpn-vsmart-example":{"description":"vpn-vsmart-example","$ref":"examples/template/general/vpn-vsmart.json"},"wla-example":{"description":"wla-example","$ref":"examples/template/general/wlan.json"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - General Template"],"description":"Delete feature template","operationId":"deleteGeneralTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write"}},"/template/lock/{processId}":{"put":{"tags":["Configuration - Template Lock"],"description":"Update lease","operationId":"updateLeaseTime","parameters":[{"name":"processId","in":"path","description":"Process Id","required":true,"schema":{"type":"string","example":"push_feature_template_configuration-ea4fe240-520c-4aaf-b674-7dfb46b0105e"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Template Lock"],"description":"Remove lock","operationId":"removeLock","parameters":[{"name":"processId","in":"path","description":"Process Id","required":true,"schema":{"type":"string","example":"push_feature_template_configuration-ea4fe240-520c-4aaf-b674-7dfb46b0105e"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/template/policy/assembly/security":{"post":{"tags":["Configuration - Policy Security Assembler"],"description":"Get policy assembly preview","operationId":"preview","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/security/{id}":{"get":{"tags":["Configuration - Policy Security Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vedge":{"post":{"tags":["Configuration - Policy vEdge Assembler"],"description":"Get policy assembly preview","operationId":"preview_1","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vedge/{id}":{"get":{"tags":["Configuration - Policy vEdge Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/voice":{"post":{"tags":["Configuration - Policy Voice Assembler"],"description":"Get policy assembly preview","operationId":"preview_2","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/voice/{id}":{"get":{"tags":["Configuration - Policy Voice Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vsmart":{"post":{"tags":["Configuration - Policy vSmart Assembler"],"description":"Get policy assembly preview","operationId":"preview_3","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vsmart/{id}":{"get":{"tags":["Configuration - Policy vSmart Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/clouddiscoveredapp":{"get":{"tags":["Configuration - Policy Cloud Application Builder"],"description":"Get all cloud discovered applications","operationId":"getCloudDiscoveredApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cloud Discovered App":{"description":"Cloud Discovered App","value":{"data":[{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05","appName":"DemoApp","lastUpdated":"1590201349732","owner":"admin"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Set SLA class for policy cloud discovered applications","operationId":"MapTrafficProfiles","requestBody":{"description":"App payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"App payload":{"description":"App payload","value":"[\n {\n \"appId\":\"71001c48-fdcf-4ac0-aaf3-ca4a20386a18\",\n \"slaClass\":\"video\",\n }\n]"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App":{"description":"App","value":{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/customapp":{"get":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Get all policy custom applications","operationId":"getCustomApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Custom App":{"description":"Custom App","value":{"data":[{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05","appName":"DemoApp","lastUpdated":"1590201349732","owner":"admin"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Create a policy custom applications","operationId":"createCustomApp","requestBody":{"description":"App payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"App payload":{"description":"App payload","value":{"appName":"DemoApp"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App Id":{"description":"App Id","value":{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/customapp/{id}":{"get":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Get a policy custom applications","operationId":"getCustomAppById","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Custom App":{"description":"Custom App","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Edit a policy custom applications","operationId":"editCustomApp","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"App payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"App payload":{"description":"App payload","value":{}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Delete a policy custom applications","operationId":"deleteCustomApp","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/definition/acl":{"get":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"post":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_8","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/acl/bulk":{"put":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_8","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/acl/multiple/{id}":{"put":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/acl/preview":{"post":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_8","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/acl/preview/{id}":{"get":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/acl/{id}":{"get":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"put":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"},"delete":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/aclv6":{"get":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"post":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_9","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/aclv6/bulk":{"put":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_9","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/aclv6/multiple/{id}":{"put":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/aclv6/preview":{"post":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_9","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/aclv6/preview/{id}":{"get":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/aclv6/{id}":{"get":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"put":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"},"delete":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/advancedMalwareProtection":{"get":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_11","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedMalwareProtection/bulk":{"put":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_11","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedMalwareProtection/multiple/{id}":{"put":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedMalwareProtection/preview":{"post":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_11","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedMalwareProtection/preview/{id}":{"get":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedMalwareProtection/{id}":{"get":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile":{"get":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Get policy definitions","operationId":"getDefinitions_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_10","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile/bulk":{"put":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_10","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile/multiple/{id}":{"put":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile/preview":{"post":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_10","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedinspectionprofile/preview/{id}":{"get":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedinspectionprofile/{id}":{"get":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/approute":{"get":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write"},"post":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_12","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-writeAppRoute Policy-write"}},"/template/policy/definition/approute/bulk":{"put":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_12","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/approute/multiple/{id}":{"put":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/approute/preview":{"post":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_12","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/approute/preview/{id}":{"get":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/approute/{id}":{"get":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write"},"put":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-writeAppRoute Policy-write"},"delete":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-writeAppRoute Policy-write"}},"/template/policy/definition/cflowd":{"get":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write"},"post":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_13","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,CFlowD Policy-write"}},"/template/policy/definition/cflowd/bulk":{"put":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_13","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/cflowd/multiple/{id}":{"put":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/cflowd/preview":{"post":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_13","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/cflowd/preview/{id}":{"get":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/cflowd/{id}":{"get":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write"},"put":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,CFlowD Policy-write"},"delete":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,CFlowD Policy-write"}},"/template/policy/definition/control":{"get":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"post":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_14","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/control/bulk":{"put":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_14","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/control/multiple/{id}":{"put":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/control/preview":{"post":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_14","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/control/preview/{id}":{"get":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/control/{id}":{"get":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"put":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/data":{"get":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_15","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/data/bulk":{"put":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_15","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/data/multiple/{id}":{"put":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/data/preview":{"post":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_15","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/data/preview/{id}":{"get":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/data/{id}":{"get":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicy":{"get":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"post":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_16","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/deviceaccesspolicy/bulk":{"put":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_16","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicy/multiple/{id}":{"put":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicy/preview":{"post":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_16","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicy/preview/{id}":{"get":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicy/{id}":{"get":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"put":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"},"delete":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/deviceaccesspolicyv6":{"get":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"post":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_17","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/deviceaccesspolicyv6/bulk":{"put":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_17","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicyv6/multiple/{id}":{"put":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicyv6/preview":{"post":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_17","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicyv6/preview/{id}":{"get":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicyv6/{id}":{"get":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"put":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"},"delete":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/dialpeer":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_25","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dialpeer/bulk":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_25","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dialpeer/multiple/{id}":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dialpeer/preview":{"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_25","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dialpeer/preview/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dialpeer/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity":{"get":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity/bulk":{"put":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity/multiple/{id}":{"put":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity/preview":{"post":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dnssecurity/preview/{id}":{"get":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dnssecurity/{id}":{"get":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport":{"get":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_26","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport/bulk":{"put":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_26","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport/multiple/{id}":{"put":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport/preview":{"post":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_26","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxoport/preview/{id}":{"get":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxoport/{id}":{"get":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport":{"get":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_28","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport/bulk":{"put":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_28","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport/multiple/{id}":{"put":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport/preview":{"post":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_28","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsdidport/preview/{id}":{"get":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsdidport/{id}":{"get":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport":{"get":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_27","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport/bulk":{"put":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_27","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport/multiple/{id}":{"put":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport/preview":{"post":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_27","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsport/preview/{id}":{"get":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsport/{id}":{"get":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/hubandspoke":{"get":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"post":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_4","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/hubandspoke/bulk":{"put":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_4","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/hubandspoke/multiple/{id}":{"put":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/hubandspoke/preview":{"post":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_4","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/hubandspoke/preview/{id}":{"get":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/hubandspoke/{id}":{"get":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"put":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/intrusionprevention":{"get":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_18","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/intrusionprevention/bulk":{"put":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_18","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/intrusionprevention/multiple/{id}":{"put":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/intrusionprevention/preview":{"post":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_18","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/intrusionprevention/preview/{id}":{"get":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/intrusionprevention/{id}":{"get":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/mesh":{"get":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"post":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_5","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/mesh/bulk":{"put":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_5","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/mesh/multiple/{id}":{"put":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/mesh/preview":{"post":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_5","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/mesh/preview/{id}":{"get":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/mesh/{id}":{"get":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"put":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/priisdnport":{"get":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_29","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_29","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/priisdnport/bulk":{"put":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_29","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/priisdnport/multiple/{id}":{"put":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/priisdnport/preview":{"post":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_29","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/priisdnport/preview/{id}":{"get":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/priisdnport/{id}":{"get":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/qosmap":{"get":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write"},"post":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_1","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/qosmap/bulk":{"put":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_1","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/qosmap/multiple/{id}":{"put":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/qosmap/preview":{"post":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_1","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/qosmap/preview/{id}":{"get":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/qosmap/{id}":{"get":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write"},"put":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/rewriterule":{"get":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write"},"post":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_19","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Rewrite Policy-write"}},"/template/policy/definition/rewriterule/bulk":{"put":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_19","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/rewriterule/multiple/{id}":{"put":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/rewriterule/preview":{"post":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_19","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/rewriterule/preview/{id}":{"get":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/rewriterule/{id}":{"get":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write"},"put":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Rewrite Policy-write"},"delete":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Rewrite Policy-write"}},"/template/policy/definition/ruleset":{"get":{"tags":["Configuration - Rule Set Definition"],"description":"Get policy definitions","operationId":"getDefinitions_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Rule Set Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_20","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ruleset/bulk":{"put":{"tags":["Configuration - Rule Set Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_20","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ruleset/multiple/{id}":{"put":{"tags":["Configuration - Rule Set Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ruleset/preview":{"post":{"tags":["Configuration - Rule Set Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_20","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ruleset/preview/{id}":{"get":{"tags":["Configuration - Rule Set Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ruleset/{id}":{"get":{"tags":["Configuration - Rule Set Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Rule Set Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Rule Set Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup":{"get":{"tags":["Configuration - Security Group Definition"],"description":"Get policy definitions","operationId":"getDefinitions_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Security Group Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_21","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup/bulk":{"put":{"tags":["Configuration - Security Group Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_21","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup/multiple/{id}":{"put":{"tags":["Configuration - Security Group Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup/preview":{"post":{"tags":["Configuration - Security Group Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_21","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/securitygroup/preview/{id}":{"get":{"tags":["Configuration - Security Group Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/securitygroup/{id}":{"get":{"tags":["Configuration - Security Group Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Security Group Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Security Group Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_30","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_30","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile/bulk":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_30","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile/multiple/{id}":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile/preview":{"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_30","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/srstphoneprofile/preview/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/srstphoneprofile/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption":{"get":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_3","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption/bulk":{"put":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_3","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption/multiple/{id}":{"put":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption/preview":{"post":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_3","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ssldecryption/preview/{id}":{"get":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ssldecryption/{id}":{"get":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile":{"get":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Get policy definitions","operationId":"getDefinitions_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_22","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile/bulk":{"put":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_22","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile/multiple/{id}":{"put":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile/preview":{"post":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_22","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/sslutdprofile/preview/{id}":{"get":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/sslutdprofile/{id}":{"get":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering":{"get":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_23","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering/bulk":{"put":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_23","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering/multiple/{id}":{"put":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering/preview":{"post":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_23","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/urlfiltering/preview/{id}":{"get":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/urlfiltering/{id}":{"get":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vedgeroute":{"get":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write"},"post":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_24","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Route Policy-write"}},"/template/policy/definition/vedgeroute/bulk":{"put":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_24","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vedgeroute/multiple/{id}":{"put":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vedgeroute/preview":{"post":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_24","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vedgeroute/preview/{id}":{"get":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vedgeroute/{id}":{"get":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write"},"put":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Route Policy-write"},"delete":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Route Policy-write"}},"/template/policy/definition/vpnmembershipgroup":{"get":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write"},"post":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_6","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,VPN Membership Policy-write"}},"/template/policy/definition/vpnmembershipgroup/bulk":{"put":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_6","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnmembershipgroup/multiple/{id}":{"put":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnmembershipgroup/preview":{"post":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_6","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnmembershipgroup/preview/{id}":{"get":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnmembershipgroup/{id}":{"get":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write"},"put":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,VPN Membership Policy-write"},"delete":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,VPN Membership Policy-write"}},"/template/policy/definition/vpnqosmap":{"get":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write"},"post":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_2","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/vpnqosmap/bulk":{"put":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_2","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnqosmap/multiple/{id}":{"put":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnqosmap/preview":{"post":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_2","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnqosmap/preview/{id}":{"get":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnqosmap/{id}":{"get":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write"},"put":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/zonebasedfw":{"get":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_7","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/zonebasedfw/bulk":{"put":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_7","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/zonebasedfw/multiple/{id}":{"put":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/zonebasedfw/preview":{"post":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_7","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/zonebasedfw/preview/{id}":{"get":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/zonebasedfw/{id}":{"get":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/ise/identity/deleteAllLists":{"delete":{"tags":["Configuration - Ise Server"],"description":"Delete all lists of the specified list type","operationId":"deleteAllLists","requestBody":{"description":"type of list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAllListsBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"},"examples":{"Delete All Lists":{"description":"Delete All Lists","value":true},"Delete Some Or No Lists":{"description":"Delete Some Or No Lists","value":false}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/referenced/{listType}":{"get":{"tags":["Configuration - Ise Server"],"description":"Get all referenced Lists","operationId":"getListReference","parameters":[{"name":"listType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferencedList"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/sgt":{"get":{"tags":["Configuration - Ise Server"],"description":"Get trustsec Scalable Group Tags","operationId":"sgts","responses":{"200":{"description":"All Scalable Group Tags","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SGTResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/usergroups":{"post":{"tags":["Configuration - Ise Server"],"description":"Get all identity user groups","operationId":"getIdentityUserGroups","requestBody":{"description":"Get Users Groups from ISE associated with Active Directory Domain. Body can be an empty object or null to return all User Groups. For filtering a group must be specified, you cannot use a regex.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupsBody"},"examples":{"User Group Filter":{"description":"User Group Filter","value":{"filter":"Cert Publishers"}},"User Group Filter Empty Braces":{"description":"User Group Filter Empty Braces","value":{}},"User Group Filter No Entry":{"description":"User Group Filter No Entry"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupsResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/users":{"post":{"tags":["Configuration - Ise Server"],"description":"Get all identity users","operationId":"getIdentityUsers","requestBody":{"description":"Get Users from ISE associated with Active Directory Domain. Body can be empty object or null to return all users. For filtering can be like the example with a regex or a specific user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersBody"},"examples":{"User Filter":{"description":"User Filter","value":{"filter":"admin"}},"User Filter Wild Card":{"description":"User Filter Wild Card","value":{"filter":"a*"}},"User Filter Empty Braces":{"description":"User Filter Empty Braces","value":{}},"User Filter No Entry":{"description":"User Filter No Entry"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list":{"get":{"tags":["Configuration - Policy List Builder"],"description":"Get all policy lists","operationId":"getAllPolicyLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/app":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Create policy list","operationId":"createPolicyList_3","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_3","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/app/filtered":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_3","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/app/preview":{"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_3","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/app/preview/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/app/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Application List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/appprobe":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_4","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_4","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/appprobe/filtered":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_4","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/appprobe/preview":{"post":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_4","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/appprobe/preview/{id}":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/appprobe/{id}":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/aspath":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Create policy list","operationId":"createPolicyList_5","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_5","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/aspath/filtered":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_5","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/aspath/preview":{"post":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_5","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/aspath/preview/{id}":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/aspath/{id}":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/class":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_14","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_14","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/class/filtered":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_14","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/class/preview":{"post":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_14","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/class/preview/{id}":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/class/{id}":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/color":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Color List Builder"],"description":"Create policy list","operationId":"createPolicyList_6","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Color List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_6","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/color/filtered":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_6","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/color/preview":{"post":{"tags":["Configuration - Policy Color List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_6","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/color/preview/{id}":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/color/{id}":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Color List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Color List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/community":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Community List Builder"],"description":"Create policy list","operationId":"createPolicyList_7","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Community List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_7","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/community/filtered":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_7","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/community/preview":{"post":{"tags":["Configuration - Policy Community List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_7","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/community/preview/{id}":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/community/{id}":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Community List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Community List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataipv6prefix":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_8","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_8","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataipv6prefix/filtered":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_8","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataipv6prefix/preview":{"post":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_8","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataipv6prefix/preview/{id}":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataipv6prefix/{id}":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataprefix":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_10","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_10","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefix/filtered":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_10","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefix/preview":{"post":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_10","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefix/preview/{id}":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefix/{id}":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataprefixall":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Get policy lists for all data prefixes","operationId":"getListsForAllDataPrefixes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Create policy list","operationId":"createPolicyList_9","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_9","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixall/filtered":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_9","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixall/preview":{"post":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_9","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixall/preview/{id}":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixall/{id}":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataprefixfqdn":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Get lists for all all data-prefix(IPv4) and Fqdn lists","operationId":"getAllDataPrefixAndFQDNLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Data prefix and FQDN":{"description":"Data prefix and FQDN","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Create policy list","operationId":"createPolicyList_15","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_15","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixfqdn/filtered":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_15","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixfqdn/preview":{"post":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_15","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixfqdn/preview/{id}":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixfqdn/{id}":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/expandedcommunity":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Create policy list","operationId":"createPolicyList_11","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_11","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/expandedcommunity/filtered":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_11","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/expandedcommunity/preview":{"post":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_11","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/expandedcommunity/preview/{id}":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/expandedcommunity/{id}":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/extcommunity":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Create policy list","operationId":"createPolicyList_12","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_12","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/extcommunity/filtered":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_12","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/extcommunity/preview":{"post":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_12","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/extcommunity/preview/{id}":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/extcommunity/{id}":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/faxprotocol":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Create policy list","operationId":"createPolicyList_13","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_13","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/faxprotocol/filtered":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_13","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/faxprotocol/preview":{"post":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_13","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/faxprotocol/preview/{id}":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/faxprotocol/{id}":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/fqdn":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - FQDN List Builder"],"description":"Create policy list","operationId":"createPolicyList_16","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - FQDN List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_16","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/fqdn/filtered":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_16","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/fqdn/preview":{"post":{"tags":["Configuration - FQDN List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_16","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/fqdn/preview/{id}":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/fqdn/{id}":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - FQDN List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - FQDN List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/geolocation":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Create policy list","operationId":"createPolicyList_17","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_17","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/geolocation/entries":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get list of countries and continents for geo location","operationId":"getGeoLocationLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/geolocation/filtered":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_17","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/geolocation/preview":{"post":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_17","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/geolocation/preview/{id}":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/geolocation/{id}":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/identity":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Identity List Builder"],"description":"Create policy list","operationId":"createPolicyList_18","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Identity List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_18","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/identity/filtered":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_18","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/identity/preview":{"post":{"tags":["Configuration - Policy Identity List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_18","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/identity/preview/{id}":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/identity/{id}":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Identity List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Identity List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/ipprefixall":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Get lists for all prefixes","operationId":"getListsForAllPrefixes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Prefixes":{"description":"Prefixes","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Create policy list","operationId":"createPolicyList_21","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_21","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipprefixall/filtered":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_21","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipprefixall/preview":{"post":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_21","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipprefixall/preview/{id}":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipprefixall/{id}":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/ipssignature":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Create policy list","operationId":"createPolicyList_19","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_19","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipssignature/filtered":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_19","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipssignature/preview":{"post":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_19","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipssignature/preview/{id}":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipssignature/{id}":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/ipv6prefix":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_20","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_20","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipv6prefix/filtered":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_20","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipv6prefix/preview":{"post":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_20","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipv6prefix/preview/{id}":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipv6prefix/{id}":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/localapp":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Create policy list","operationId":"createPolicyList_22","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_22","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localapp/filtered":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_22","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localapp/preview":{"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_22","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localapp/preview/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localapp/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Application List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/localdomain":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Create policy list","operationId":"createPolicyList_23","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_23","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localdomain/filtered":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_23","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localdomain/preview":{"post":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_23","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localdomain/preview/{id}":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localdomain/{id}":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/mediaprofile":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Get policy lists","operationId":"getPolicyLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Create policy list","operationId":"createPolicyList","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mediaprofile/filtered":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mediaprofile/preview":{"post":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mediaprofile/preview/{id}":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mediaprofile/{id}":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/mirror":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Create policy list","operationId":"createPolicyList_24","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_24","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mirror/filtered":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_24","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mirror/preview":{"post":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_24","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mirror/preview/{id}":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mirror/{id}":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/modempassthrough":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Create policy list","operationId":"createPolicyList_25","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_25","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/modempassthrough/filtered":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_25","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/modempassthrough/preview":{"post":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_25","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/modempassthrough/preview/{id}":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/modempassthrough/{id}":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/policer":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_26","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_26","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/policer/filtered":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_26","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/policer/preview":{"post":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_26","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/policer/preview/{id}":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/policer/{id}":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/port":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Port List Builder"],"description":"Create policy list","operationId":"createPolicyList_27","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Port List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_27","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/port/filtered":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_27","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/port/preview":{"post":{"tags":["Configuration - Policy Port List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_27","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/port/preview/{id}":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/port/{id}":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Port List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Port List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/preferredcolorgroup":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Create policy list","operationId":"createPolicyList_28","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_28","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/preferredcolorgroup/filtered":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_28","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/preferredcolorgroup/preview":{"post":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_28","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/preferredcolorgroup/preview/{id}":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/preferredcolorgroup/{id}":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/prefix":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_29","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_29","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/prefix/filtered":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_29","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/prefix/preview":{"post":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_29","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/prefix/preview/{id}":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/prefix/{id}":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/protocolname":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Create policy list","operationId":"createPolicyList_30","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_30","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/protocolname/filtered":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_30","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/protocolname/preview":{"post":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_30","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/protocolname/preview/{id}":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/protocolname/{id}":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/region":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Region List Builder"],"description":"Create policy list","operationId":"createPolicyList_31","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Region List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_31","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/region/filtered":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_31","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/region/preview":{"post":{"tags":["Configuration - Policy Region List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_31","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/region/preview/{id}":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/region/{id}":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Region List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Region List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/scalablegrouptag":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_29","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Create policy list","operationId":"createPolicyList_32","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_32","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/scalablegrouptag/filtered":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_32","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/scalablegrouptag/preview":{"post":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_32","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/scalablegrouptag/preview/{id}":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/scalablegrouptag/{id}":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/site":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_30","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Site List Builder"],"description":"Create policy list","operationId":"createPolicyList_33","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Site List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_33","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/site/defaultsite":{"post":{"tags":["Configuration - Policy Site List Builder"],"description":"Create default site list for sites missing from centralized policy","operationId":"createDefaultSiteList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Site list":{"description":"Site list","value":{"name":"Demo_site_list","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"200"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/template/policy/list/site/filtered":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_33","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/site/preview":{"post":{"tags":["Configuration - Policy Site List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_33","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/site/preview/{id}":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/site/{id}":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Site List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Site List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/sla":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_31","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_34","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_34","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/sla/filtered":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_34","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/sla/preview":{"post":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_34","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/sla/preview/{id}":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/sla/{id}":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/supervisorydisc":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_32","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Create policy list","operationId":"createPolicyList_35","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_35","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/supervisorydisc/filtered":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_35","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/supervisorydisc/preview":{"post":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_35","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/supervisorydisc/preview/{id}":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/supervisorydisc/{id}":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/tgapikey":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Get policy lists","operationId":"getPolicyLists_33","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Create policy list","operationId":"createPolicyList_36","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_36","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tgapikey/filtered":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_36","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tgapikey/preview":{"post":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_36","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tgapikey/preview/{id}":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tgapikey/{id}":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Get a specific policy list based on the id","operationId":"getListsById_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/tloc":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_34","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Create policy list","operationId":"createPolicyList_37","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_37","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tloc/filtered":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_37","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tloc/preview":{"post":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_37","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tloc/preview/{id}":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tloc/{id}":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/translationprofile":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Create policy list","operationId":"createPolicyList_1","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_1","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationprofile/filtered":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_1","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationprofile/preview":{"post":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_1","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationprofile/preview/{id}":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationprofile/{id}":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/translationrules":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Create policy list","operationId":"createPolicyList_2","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_2","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationrules/filtered":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_2","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationrules/preview":{"post":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_2","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationrules/preview/{id}":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationrules/{id}":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/trunkgroup":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_35","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Create policy list","operationId":"createPolicyList_38","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_38","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/trunkgroup/filtered":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_38","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/trunkgroup/preview":{"post":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_38","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/trunkgroup/preview/{id}":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/trunkgroup/{id}":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/umbrelladata":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_36","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Create policy list","operationId":"createPolicyList_39","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_39","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/umbrelladata/filtered":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_39","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/umbrelladata/preview":{"post":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_39","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/umbrelladata/preview/{id}":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/umbrelladata/{id}":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/urlblacklist":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Get policy lists","operationId":"getPolicyLists_37","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Create policy list","operationId":"createPolicyList_40","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_40","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlblacklist/filtered":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_40","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlblacklist/preview":{"post":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_40","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlblacklist/preview/{id}":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlblacklist/{id}":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/urlwhitelist":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Get policy lists","operationId":"getPolicyLists_38","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Create policy list","operationId":"createPolicyList_41","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_41","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlwhitelist/filtered":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_41","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlwhitelist/preview":{"post":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_41","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlwhitelist/preview/{id}":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlwhitelist/{id}":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/vpn":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_39","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy VPN List Builder"],"description":"Create policy list","operationId":"createPolicyList_42","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy VPN List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_42","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/vpn/filtered":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_42","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/vpn/preview":{"post":{"tags":["Configuration - Policy VPN List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_42","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/vpn/preview/{id}":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/vpn/{id}":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy VPN List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy VPN List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/webex":{"post":{"tags":["Configuration - Policy List Builder"],"description":"TEMP-Create Webex policy lists","operationId":"createWebexPrefixLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/webex/update":{"post":{"tags":["Configuration - Policy List Builder"],"description":"TEMP-Update Webex policy lists from Webex config","operationId":"createWebexPrefixLists_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/zone":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_40","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Zone List Builder"],"description":"Create policy list","operationId":"createPolicyList_43","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Zone List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_43","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/zone/filtered":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_43","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/zone/preview":{"post":{"tags":["Configuration - Policy Zone List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_43","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/zone/preview/{id}":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/zone/{id}":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Zone List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Zone List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/security":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Generate template list","operationId":"generateSecurityTemplateList","parameters":[{"name":"mode","in":"query","description":"Mode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Security Template Policy"],"description":"Create Template","operationId":"createSecurityTemplate","requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"Security Policy","policyType":"feature","policyName":"securitypolicy","policyUseCase":"guestAccess","policyDefinition":{"assembly":[{"definitionId":"840f9d3e-b31d-48b6-8365-79b75ba206a9","type":"urlFiltering"}],"settings":{"logging":[{"vpn":"512","serverIP":"10.0.0.1"}],"failureMode":"open"}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/definition/{policyId}":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get Template","operationId":"getSecurityTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/devices":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get device list","operationId":"getSecurityPolicyDeviceList_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/devices/{policyId}":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get device list by Id","operationId":"getDeviceListById","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/staging/{policyId}":{"put":{"tags":["Configuration - Security Template Policy"],"description":"Edit Template","operationId":"editTemplateWithLenientLock","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/summary":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Generate security policy summary","operationId":"generateSecurityPolicySummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Security policy summary":{"description":"Security policy summary","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/{deviceModel}":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get templates that map a device model","operationId":"getSecurityTemplatesForDevice","parameters":[{"name":"deviceModel","in":"path","description":"Device model","required":true,"schema":{"$ref":"#/components/schemas/DeviceModel"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/{policyId}":{"put":{"tags":["Configuration - Security Template Policy"],"description":"Edit Template","operationId":"editSecurityTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"Security Policy","policyType":"feature","policyName":"securitypolicy","policyUseCase":"guestAccess","policyDefinition":{"assembly":[{"definitionId":"f41167bd-6948-42ff-bc06-94f450e43999","type":"zoneBasedFW"},{"definitionId":"840f9d3e-b31d-48b6-8365-79b75ba206a9","type":"urlFiltering"}],"settings":{"zoneToNozoneInternet":"deny","logging":[{"vpn":"512","serverIP":"10.0.0.1"}],"failureMode":"open"}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Security Template Policy"],"description":"Delete Template","operationId":"deleteSecurityTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get policy details","operationId":"generatePolicyTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - vEdge Template Policy"],"description":"Create template","operationId":"createVEdgeTemplate","requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"policyDescription":"Demo","policyType":"feature","policyName":"demo-policy","policyDefinition":{"assembly":[{"definitionId":"b628d664-d4ec-428f-831c-aff2b688c54c","type":"vedgeRoute"},{"definitionId":"e4b25c74-f594-49db-b78b-61bbb41464ba","type":"acl"}],"settings":{"appVisibility":true,"logFrequency":60}},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy Id":{"description":"Policy Id","value":{"policyId":"f8efb9ed-7524-41ff-aa12-1b6635087ce1"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/definition/{policyId}":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get template","operationId":"getVEdgeTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"data":[{"mastersAttached":0,"lastUpdatedBy":"admin","policyName":"AppVisibility","policyDefinition":"policy\n app-visibility\n flow-visibility\n!\n","policyDefinitionEdit":"policy\n app-visibility\n flow-visibility\n!\n","createdOn":1505676829880,"policyDescription":"Application Visibility Only","@rid":481,"policyId":"0b860b3a-9446-4c19-86f4-49699f4ed2c7","createdBy":"admin","devicesAttached":0,"lastUpdatedOn":1505676829880,"policyType":"cli"},{"mastersAttached":1,"lastUpdatedBy":"admin","policyName":"BaselinePolicy","policyDefinition":"{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}","policyDefinitionEdit":"{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}","createdOn":1548341101877,"policyDescription":"Baseline dCloud Policy for all WAN Edge","@rid":2095,"policyId":"f73b285f-72eb-4f6d-865f-eae0e453bd8e","createdBy":"admin","devicesAttached":2,"policyType":"feature","lastUpdatedOn":1548341101877}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/devices":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get device list","operationId":"getVEdgePolicyDeviceList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/devices/{policyId}":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get device list by policy","operationId":"getDeviceListByPolicy","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/{policyId}":{"put":{"tags":["Configuration - vEdge Template Policy"],"description":"Edit template","operationId":"editVEdgeTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":"{\n \"policyId\":\"8715a21d-9367-47ea-9bc6-e25163ed9513\",\n \"policyState\":\"edit\",\n \"mastersAttached\":2,\n \"lastUpdatedBy\":\"admin\",\n \"policyName\":\"LocalizedPolicyBaseline\",\n \"policyDefinition\": \"\"\n \"policyDefinitionEdit\":\"\"\n \"createdOn\":1548015105326,\n \"policyDescription\":\"Baseline Localized Policiy for dcloud\",\n \"@rid\":483,\n \"createdBy\":\"admin\",\n \"devicesAttached\":2,\n \"policyType\":\"cli\",\n \"lastUpdatedOn\":1548015105326\n}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - vEdge Template Policy"],"description":"Delete template","operationId":"deleteVEdgeTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/{resourceGroupName}/{policyId}":{"post":{"tags":["Configuration - vEdge Template Policy"],"description":"Change policy resource group","operationId":"changePolicyResourceGroup","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"path","description":"Resrouce group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Generate template list","operationId":"generateVoiceTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":{"data":[{"lastUpdatedBy":"admin","mastersAttached":0,"policyName":"SIPpolicy","virtualApplicationTemplates":[],"policyDefinition":"{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}","policyDefinitionEdit":"{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}","createdOn":1590272854518,"policyDescription":"SIP dail peers","policyUseCase":"custom","@rid":1124,"policyId":"87fed5e0-3b95-47a3-9dae-bed8b68562ed","createdBy":"admin","devicesAttached":0,"policyType":"feature","lastUpdatedOn":1590272854518,"supportedDevices":["vedge-C8300-2N2S-4T2X","vedge-C8200-1N-4T","vedge-C8200L-1N-4T","vedge-C8300-2N2S-6T","vedge-C8300-1N1S-4T2X","vedge-C8300-1N1S-6T","vedge-ISR-4451-X","vedge-ISR-4351","vedge-ISR-4461","vedge-ISR-4431","vedge-ISR-4321","vedge-ISR-4331"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Voice Template Policy"],"description":"Create Template","operationId":"createVoiceTemplate","requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"SIP dail peers","policyType":"feature","policyName":"SIPpolicy","policyDefinition":{"assembly":[{"definitionId":"5557cab0-b8f7-43d6-97d5-2dc572007aac","type":"dialPeer","portType":"sipDialPeer"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy Id":{"description":"Policy Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/definition/{policyId}":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get templates by policy Id","operationId":"getTemplateById","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/devices":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get all device list","operationId":"getVoicePolicyDeviceList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/devices/{policyId}":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get device list by policy Id","operationId":"getDeviceListByPolicyId","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/summary":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get templates that map a device model","operationId":"generateVoicePolicySummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy summary":{"description":"Policy summary","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/{deviceModel}":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get templates that map a device model","operationId":"getVoiceTemplatesForDevice","parameters":[{"name":"deviceModel","in":"path","description":"Device model","required":true,"schema":{"$ref":"#/components/schemas/DeviceModel"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/{policyId}":{"put":{"tags":["Configuration - Voice Template Policy"],"description":"Edit Template","operationId":"editVoiceTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"SIP dail peers","policyType":"feature","policyName":"SIPpolicy","policyDefinition":{"assembly":[{"definitionId":"5557cab0-b8f7-43d6-97d5-2dc572007aac","type":"dialPeer","portType":"sipDialPeer"}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Voice Template Policy"],"description":"Delete Template","operationId":"deleteVoiceTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Get all template vsmart policy list","operationId":"generateVSmartPolicyTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template vSmart policy list":{"description":"Template vSmart policy list","value":{"data":[{"policyVersion":"12282017T235740495","lastUpdatedBy":"admin","policyName":"StrictHub-n-Spoke","policyDefinition":"{\"assembly\":[{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"4ddd51c0-d8a4-4dff-8874-09c24742b518\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}","createdOn":1514732091489,"isPolicyActivated":false,"policyDescription":"BFD/IPSec based Hub-n-Spoke Topology","@rid":6,"policyId":"a8205140-92d9-4688-a127-c70d5f1b93a5","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514732091489},{"policyVersion":"12302017T143348286","lastUpdatedBy":"admin","policyName":"MultiTopologyPolicy","policyDefinition":"{\"assembly\":[{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]}]}","createdOn":1514732164516,"isPolicyActivated":false,"policyDescription":"Multi-Topology Policy","@rid":7,"policyId":"45f0b251-bce6-4b6b-bb8c-de7dbf13ea0f","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514732164516},{"policyVersion":"12312017T143840434","lastUpdatedBy":"admin","policyName":"MultiTopologyPlusFWInsertion","policyDefinition":"{\"assembly\":[{\"definitionId\":\"1ded189f-4c6b-41cf-a686-655120fdf179\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"73096eaf-8bfe-43bd-a67a-9fcaaa2f8c38\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}","createdOn":1514732296993,"isPolicyActivated":false,"policyDescription":"Adding FW for inter-branch communication in VPN 10","@rid":8,"policyId":"b33477d1-1ebc-4080-ba44-b89dbf14fef7","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514732296993},{"policyVersion":"12312017T153128841","lastUpdatedBy":"admin","policyName":"MultiTopologyPlusACL","policyDefinition":"{\"assembly\":[{\"definitionId\":\"968d1ce3-7ff7-4f97-8b69-01e4e06ecad2\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"19f53630-0ce6-4f6b-8e4f-6a527cd15ca4\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}","createdOn":1514734542150,"isPolicyActivated":false,"policyDescription":"Application/ACL Policy for inter-branch traffic in VPN 20","@rid":9,"policyId":"7f156d32-537d-493f-9a7d-53d9e1f05a19","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514734542150},{"policyVersion":"04092018T121824907","lastUpdatedBy":"admin","policyName":"MultiTopologyPlusAppRoute","policyDefinition":"{\"assembly\":[{\"definitionId\":\"433db0fb-c89a-4642-a498-e3b9a257faef\",\"type\":\"appRoute\",\"entries\":[{\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]},{\"siteLists\":[\"1baf2339-97c0-43fb-98d2-285428a61820\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}","createdOn":1514736045181,"isPolicyActivated":false,"policyDescription":"App Aware Routing Policy based on SLA","@rid":10,"policyId":"12df3ed9-6b1f-4b0a-91a2-377cefb8039f","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514736045181},{"policyVersion":"06212018T190131728","lastUpdatedBy":"admin","policyName":"cflowd_policy","policyDefinition":"policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template\n ","createdOn":1530540307108,"isPolicyActivated":false,"policyDescription":"cflowd","@rid":12,"policyId":"1c865c35-05ac-43a7-a6ee-6328138cd1c4","createdBy":"admin","policyType":"cli","lastUpdatedOn":1530540307108},{"policyVersion":"02242019T10524417","lastUpdatedBy":"admin","policyName":"Hub-Spoke-Policy-PCI","policyDefinition":"{\"assembly\":[{\"definitionId\":\"605fabbd-4c99-4be4-8842-aebb256f7010\",\"type\":\"hubAndSpoke\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"}]}","createdOn":1551005623067,"isPolicyActivated":false,"policyDescription":"Enforce PCI VPN to be Hub and Spoke per corporate requirements","@rid":1365,"policyId":"67b2d453-671f-4eaf-b79a-d1c4c0069f1a","createdBy":"admin","policyType":"feature","lastUpdatedOn":1551005623067}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Create template for given policy","operationId":"createVSmartTemplate","requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"policyDescription":"demoVPN","policyType":"feature","policyName":"demoVPN","policyDefinition":{"assembly":[{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]},"isPolicyActivated":false}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy Id":{"description":"Policy Id","value":{"policyId":"05917007-14e4-42b0-9575-3d3d11f8a371"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/activate/central/{policyId}":{"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Activate vsmart policy for a given policy id","operationId":"activatePolicyForCloudServices","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/activate/{policyId}":{"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Activate vsmart policy for a given policy id","operationId":"activatePolicy","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Activate policy":{"description":"Activate policy","value":{"isEdited":false}},"Deactivate policy":{"description":"Deactivate policy","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"vsmart_policy_config-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/central/{policyId}":{"put":{"tags":["Configuration - vSmart Template Policy"],"description":"Edit template for given policy id to allow for multiple component edits","operationId":"editTemplateWithoutLockChecks","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template policy":{"description":"Template policy","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/connectivity/status":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Check VSmart Connectivity Status","operationId":"checkVSmartConnectivityStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connectivity Status":{"description":"Connectivity Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/deactivate/{policyId}":{"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Deactivate vsmart policy for a given policy id","operationId":"deActivatePolicy","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"vsmart_policy_config-60851f10-d9f0-4f41-a27e-9eedbd1bae65"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/definition/{policyId}":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Get template policy definition by policy id","operationId":"getTemplateByPolicyId","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template vSmart policy":{"description":"Template vSmart policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/qosmos_nbar_migration_warning":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Qosmos Nbar migration","operationId":"QosmosNbarMigrationWarning","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NBAR list":{"description":"NBAR list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/{policyId}":{"put":{"tags":["Configuration - vSmart Template Policy"],"description":"Edit template for given policy id","operationId":"editVSmartTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"policyId":"1c865c35-05ac-43a7-a6ee-6328138cd1c4","policyState":"edit","policyVersion":"06212018T190131728","lastUpdatedBy":"admin","policyName":"cflowd_policy","policyDefinition":"policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n \n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template\n ","createdOn":1530540307108,"isPolicyActivated":false,"policyDescription":"cflowd","@rid":12,"createdBy":"admin","policyType":"cli","lastUpdatedOn":1530540307108,"isEdited":true}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template policy":{"description":"Template policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - vSmart Template Policy"],"description":"Delete template for a given policy id","operationId":"deleteVSmartTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/security/encryptText/encrypt":{"post":{"tags":["Configuration - General Template"],"description":"Get Type 6 Encryptedd String for a given value","operationId":"getEncryptedString","requestBody":{"description":"Type6 Encryption","content":{"application/json":{"schema":{"type":"object"},"examples":{"Encryption":{"description":"Encryption","value":{"inputString":"string "}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Encrypted String":{"description":"Encrypted String","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/tenant":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Lists all the tenants on the vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAllTenants","parameters":[{"name":"deviceId","in":"query","description":"List all tenants associated with a vSmart or MTEdge","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Tenant models":{"description":"Tenant models","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca,Manage LI-read"},"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Create a new tenant in Multi-Tenant vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createTenant","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/async":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Create a new tenant in Multi-Tenant vManage asynchronously
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createTenantAsync","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/bulk/async":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Create multiple tenants on vManage asynchronously
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createTenantAsyncBulk","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":[{"orgName":"fq-tenan1 - 19442","subDomain":"tenant1-fq-dev-dev.viptela.info","name":"fq-tenan1 - 19442","desc":"fq-tenan1 - 19442","wanEdgeForecast":"100"},{"orgName":"fq-tenan2 - 19442","subDomain":"tenant1-fq-dev-dev.viptela.info","name":"fq-tenan1 - 19442","desc":"fq-tenan1 - 19442","wanEdgeForecast":"100","vSmarts":"[vSmartUUID1, vSmartUUID2]"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"[{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"},"delete":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Delete multiple tenants on vManage asynchronously
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteTenantAsyncBulk","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{"password":"12345","tenantIdList":["0f4f1c6e-47da-40c4-8517-9d1e918965d9","6b7b23bf-5dba-4cca-a36c-1c3cc2254d68"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{[\n \"id\": \u201c537911061561\u201d .\n]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/vsmart":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Retrieve mapping of tenants to vSmarts
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantvSmartMapping","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart tenant mapping":{"description":"vSmart tenant mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca"}},"/tenant/vsmart-mt/migrate":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"tenantvSmartMtMigrate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/vsmart/capacity":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Lists all the vsmarts on the vManage and its tenant hosting capacity
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantHostingCapacityOnvSmarts","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart Capacity":{"description":"vSmart Capacity","value":"[\"data\": [\n {\n \"vSmartUuid\": \"6dbf3f8d-d537-4650-9200-154d8b98b302\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"05aab9ac-44f7-4292-b8c5-2cc40f3afb5a\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"b20b4468-7a5f-48f1-8ee6-f393afd3ac72\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n }\n ]]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca"}},"/tenant/{tenantId}":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Get a tenant by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read"},"put":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Update a tenant in Multi-Tenant vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"updateTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{"orgName":"fq-tenan1 - 19442","subDomain":"tenant1-fq-dev-dev.viptela.info","desc":"fq-tenan1 - 19442"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"id\": \u201c537911061561\u201d .\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/{tenantId}/delete":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Delete a tenant by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{"password":"password"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/{tenantId}/switch":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Switch to a specific tenant
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"switchTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vSession model":{"description":"vSession model","value":"{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read"}},"/tenant/{tenantId}/vsessionid":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Get VSessionId for a specific tenant
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"vSessionId","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vSession model":{"description":"vSession model","value":"{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca"}},"/tenant/{tenantId}/vsmart":{"put":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Update placement of the Tenant from source vSmart to destination vSmart
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"updateTenantvSmartPlacement","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"UpdateTenantvSmartModel":{"description":"UpdateTenantvSmartModel","value":{"srcvSmartUuid":"UUID","destvSmartUuid":"UUID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenantbackup/delete":{"delete":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Delete all or a specific backup file stored in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteTenantBackup","parameters":[{"name":"fileName","in":"query","description":"File name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Deleted file list":{"description":"Deleted file list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write,Tenant Status-write"}},"/tenantbackup/download/{path}":{"get":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Download a Backup File that is already stored in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"downloadExistingBackupFile","parameters":[{"name":"path","in":"path","description":"File path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Backup file stream":{"description":"Backup file stream"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write"}},"/tenantbackup/export":{"get":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Trigger a backup of configuration database and store it in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"exportTenantBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write"}},"/tenantbackup/import":{"post":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Submit a previously backed up file and import the data and apply it to the configuraion database
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"importTenantBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write,Tenant Status-write"}},"/tenantbackup/list":{"get":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"List all backup files of a tenant stored in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"listTenantBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Backup file list":{"description":"Backup file list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write"}},"/tenantmigration/download/{path}":{"get":{"tags":["Tenant Migration"],"description":"Download tenant data","operationId":"downloadTenantData","parameters":[{"name":"path","in":"path","description":"File path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Tenant data":{"description":"Tenant data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/export":{"post":{"tags":["Tenant Migration"],"description":"Export tenant data","operationId":"exportTenantData","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateTenantModel"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/import":{"post":{"tags":["Tenant Migration"],"description":"Import tenant data","operationId":"importTenantData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/migrationToken":{"get":{"tags":["Tenant Migration"],"description":"Get migration token","operationId":"getMigrationToken","parameters":[{"name":"migrationId","in":"query","description":"Migration Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Migration token":{"description":"Migration token","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/networkMigration":{"get":{"tags":["Tenant Migration"],"description":"Re-trigger network migration","operationId":"reTriggerNetworkMigration","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"},"post":{"tags":["Tenant Migration"],"description":"Migrate network","operationId":"migrateNetwork","requestBody":{"description":"Network migration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network migration":{"description":"Network migration","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantstatus":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"List all tenant status
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAllTenantStatuses","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Tenant status":{"description":"Tenant status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read"}},"/tenantstatus/force":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Force tenant status collection
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"forceStatusCollection","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/token/{regionBaseUri}/{clientId}":{"post":{"tags":["Monitoring - SecureX Integration"],"description":"Get Access Token and Refresh Token for authorized user","operationId":"token","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/topology":{"get":{"tags":["Configuration - Topology"],"description":"Create full topology","operationId":"createFullTopology","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Topologies":{"description":"Topologies","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/topology/device":{"get":{"tags":["Configuration - Topology"],"description":"Create device topology","operationId":"createDeviceTopology","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topology":{"description":"Topology","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/topology/device/site/{siteId}":{"get":{"tags":["Configuration - Topology"],"description":"Get topology for a given site id","operationId":"getSiteTopology","parameters":[{"name":"siteId","in":"path","description":"Site Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write"}},"/topology/monitor/site/{siteId}":{"get":{"tags":["Configuration - Topology"],"description":"Get topology monitor data for a given site id","operationId":"getSiteTopologyMonitorData","parameters":[{"name":"siteId","in":"path","description":"Site Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Site topology monitor":{"description":"Site topology monitor","value":{"data":[{"device-id":"C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88","device-health":"yellow","circuits":[{"color":"lte","system_ip":"172.16.255.14","circuit-health":"yellow","tunnels":[{"name":"172.16.255.14:lte-172.16.255.15:lte","health":"yellow","state":"Up","vqoe_score":7}]}],"if-speed":[{"interface":"GigabitEthernet1","count":34,"tx_kbps":0,"rx_kbps":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/topology/physical":{"get":{"tags":["Configuration - Topology"],"description":"Create pysical topology","operationId":"createPhysicalTopology","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topology":{"description":"Topology","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/troubleshooting/control/{uuid}":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Troubleshoot control connections","operationId":"getControlConnections","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device control connection":{"description":"Device control connection","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/troubleshooting/devicebringup":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Debug device bring up","operationId":"getDeviceConfiguration","parameters":[{"name":"uuid","in":"query","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device configuration":{"description":"Device configuration","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/umbrella/getkeys":{"get":{"tags":["Umbrella"],"description":"Get keys from Umbrella","operationId":"getAllKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/getkeys/management":{"get":{"tags":["Umbrella"],"description":"Get management keys from Umbrella","operationId":"getManagementKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/getkeys/networkdevices":{"get":{"tags":["Umbrella"],"description":"Get network devices keys from Umbrella","operationId":"getNetworkKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/getkeys/reporting":{"get":{"tags":["Umbrella"],"description":"Get reporting keys from Umbrella","operationId":"getReportingKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/syncnow":{"get":{"tags":["Umbrella"],"description":"Get metadata from db and send to Umbrella","operationId":"sendMetaDataToUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ump/status":{"get":{"tags":["Monitoring - UMP Details"],"description":"Get last N minutes UMP historic data","operationId":"getStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UMP_Summary":{"description":"UMP_Summary","value":"total_db_query=23684439, total_return_size=387230767, totoal_sdn_query=1874632 umpKey=execute_select, last_60s_query=7813 umpKey=execute_update, last_60s_query=8"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/configdb/metrics":{"get":{"tags":["Utility - Configuration DB"],"summary":"Return the values of the specific metric within the timeframe","description":"By passing in the appropriate metric, it will return the values of the respective metric within the timeframe provided ","operationId":"returnMetric","parameters":[{"name":"metricName","in":"query","description":"Pass the metric name","required":true,"schema":{"type":"string"},"example":"neo4j.bolt.connections_running"},{"name":"startDate","in":"query","description":"Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as and respectively.","required":true,"schema":{"type":"string"},"examples":{"yyyy-MM-dd":{"description":"yyyy-MM-dd","value":"2022-11-20"},"number (minutes)":{"description":"number (minutes)","value":10}}},{"name":"endDate","in":"query","description":"Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.","schema":{"type":"string"},"example":"2022-11-23"},{"name":"start","in":"query","description":"Start Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":142430},{"name":"end","in":"query","description":"End Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":235830},{"name":"pageNo","in":"query","description":"Page Number","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"The numbers of items to return on given Page Number","schema":{"type":"integer","format":"int32","default":500}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neo4jMetricsResponse"}}}},"400":{"description":"Bad input parameter"},"500":{"description":"Internal Error"}}}},"/util/configdb/metrics/downloadfiles":{"get":{"tags":["Utility - Configuration DB"],"summary":"Return the tar file consisting of files of the specific metric within the timeframe","description":"By passing in the appropriate metric, date, start and end time, it will return a tar file consisting of all the metric files of the respective metric within the timeframe provided ","operationId":"returnMetricFiles","parameters":[{"name":"metricName","in":"query","description":"Pass the metric name","required":true,"schema":{"type":"string"},"example":"neo4j.bolt.connections_running"},{"name":"startDate","in":"query","description":"Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as and respectively.","required":true,"schema":{"type":"string"},"examples":{"yyyy-MM-dd":{"description":"yyyy-MM-dd","value":"2022-11-20"},"number (minutes)":{"description":"number (minutes)","value":10}}},{"name":"endDate","in":"query","description":"Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.","schema":{"type":"string"},"example":"2022-11-23"},{"name":"start","in":"query","description":"Start Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":142430},{"name":"end","in":"query","description":"End Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":235830}],"responses":{"200":{"description":"return tarball file matching criteria","content":{"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad input parameter"},"500":{"description":"Internal Error"}}}},"/util/configdb/metrics/listmetrics":{"get":{"tags":["Utility - Configuration DB"],"summary":"Provides the list of all the generated metrics","description":"Fetches the list of enabled metrics","operationId":"getMetricsList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/configdb/size":{"get":{"tags":["Utility - Configuration DB"],"description":"Fetches the disk usage by configuration-db","operationId":"getDBSizeOnFile","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/logfile/appserver":{"get":{"tags":["Utility - Logging"],"description":"Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.","operationId":"listLogFileDetails","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"log content":{"description":"log content"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/util/logfile/appserver/lastnlines":{"get":{"tags":["Utility - Logging"],"description":"List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.","operationId":"listVManageServerLogLastNLines","parameters":[{"name":"lines","in":"query","description":"Number of lines","schema":{"type":"integer","format":"int64","default":100}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"log content":{"description":"log content"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/util/logging/debuglog":{"post":{"tags":["Utility - Logging"],"description":"Test whether logging works","operationId":"debugLog","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["logMessage","loggerName"],"type":"object","properties":{"loggerName":{"type":"string"},"logMessage":{"type":"string"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin"}},"/util/logging/level":{"post":{"tags":["Utility - Logging"],"description":"Set log level for logger","operationId":"setLogLevel","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["logLevel","loggerName"],"type":"object","properties":{"loggerName":{"type":"string"},"logLevel":{"type":"string"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/util/logging/loggers":{"get":{"tags":["Utility - Logging"],"description":"List loggers","operationId":"listLoggers","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Loggers":{"description":"Loggers","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/v1/config-group":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get a Configuration Group by Solution","operationId":"GetConfigGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfigGroup"}},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"},"post":{"tags":["Configuration - Configuration Group"],"description":"Create a new Configuration Group","operationId":"CreateConfigGroup","requestBody":{"description":"Config Group","content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/post/request_schema.json"},"examples":{"AON-ConfigGroup1-SF":{"$ref":"schema/configgroup/common/post/request_schema.json#/propertyNames/examples/AON-ConfigGroup1-SF"},"CEDGE-ConfigGroup1-NY":{"$ref":"schema/configgroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup1-NY"},"CEDGE-ConfigGroup2-DualDeviceSiteDeployment":{"$ref":"schema/configgroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup2-DualDeviceSiteDeployment"},"NFVIRTUAL-ConfigGroup1-SF":{"$ref":"schema/configgroup/common/post/request_schema.json#/propertyNames/examples/NFVIRTUAL-ConfigGroup1-SF"},"CEDGE-ConfigGroup1-COPY":{"$ref":"schema/configgroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/post/response_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/configgroup/common/post/response_schema.json#/propertyNames/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Workflows-write,Config Group-write"}},"/v1/config-group/schema/sdwan":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get a Cedge famiy Configuration Group Schema by Schema Type","operationId":"GetCedgeConfigGroupSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","schema":{"type":"string","enum":["post","put","associate/post","associate/put","associate/delete","deploy/post"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"}},"/v1/config-group/{configGroupId}":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get a Configuration Group by ID","operationId":"GetConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigGroup"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"},"put":{"tags":["Configuration - Configuration Group"],"description":"Edit a Configuration Group","operationId":"EditConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Config Group","content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/put/request_schema.json"},"examples":{"AON-ConfigGroup1-SF":{"$ref":"schema/configgroup/common/put/request_schema.json#/propertyNames/examples/AON-ConfigGroup1-SF"},"CEDGE-ConfigGroup1-NY":{"$ref":"schema/configgroup/common/put/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup1-NY"},"CEDGE-ConfigGroup2-DualDeviceSiteDeployment":{"$ref":"schema/configgroup/common/put/request_schema.json#/propertyNames/examples/CEDGE-ConfigGroup2-DualDeviceSiteDeployment"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/put/response_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/configgroup/common/put/response_schema.json#/propertyNames/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"},"delete":{"tags":["Configuration - Configuration Group"],"description":"Delete Config Group","operationId":"DeleteConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"}},"/v1/config-group/{configGroupId}/device/associate":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get devices association with a config group","operationId":"GetConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-read"},"put":{"tags":["Configuration - Configuration Group"],"description":"Move the devices from one config group to another","operationId":"UpdateConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/associate/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/associate/put/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/configgroup/common/associate/put/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-write"},"post":{"tags":["Configuration - Configuration Group"],"description":"Create associations with device and a config group","operationId":"CreateConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/associate/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/associate/post/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/configgroup/common/associate/post/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-write"},"delete":{"tags":["Configuration - Configuration Group"],"description":"Delete Config Group Association from devices","operationId":"DeleteConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/associate/delete/request_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/associate/delete/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/configgroup/common/associate/delete/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-write"}},"/v1/config-group/{configGroupId}/device/deploy":{"post":{"tags":["Configuration - Configuration Group"],"description":"deploy config group to devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deployConfigGroup","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/deploy/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/deploy/post/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/configgroup/common/deploy/post/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/deploy/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/deploy/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device > Deploy-write"}},"/v1/config-group/{configGroupId}/device/variables":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get device variables","operationId":"getConfigGroupDeviceVariables","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}},{"name":"device-id","in":"query","description":"Comma separated device id's like d1,d2","schema":{"type":"string"}},{"name":"suggestions","in":"query","description":"Suggestions for possible values","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"},"put":{"tags":["Configuration - Configuration Group"],"description":"assign values to device variables","operationId":"createConfigGroupDeviceVariables","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/variables/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/variables/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"},"post":{"tags":["Configuration - Configuration Group"],"description":"Fetch device variables","operationId":"fetchConfigGroupDeviceVariables","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/variables/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/variables/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"}},"/v1/config-group/{configGroupId}/device/variables/schema":{"get":{"tags":["Configuration - Configuration Group"],"description":"get device variables schema","operationId":"getConfigGroupDeviceVariablesSchema","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}},{"name":"all","in":"query","description":"All variables(including sub-feature)","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"}},"/v1/config-group/{configGroupId}/device/{deviceId}/preview":{"post":{"tags":["Configuration - Configuration Group"],"description":"Get a preview of the configuration for a device","operationId":"getConfigGroupDeviceConfigurationPreview","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/configgroup/common/preview/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/configgroup/common/preview/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device > Deploy-read"}},"/v1/config-group/{configGroupId}/rules":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get Rule by associated object Id, example : get rules by config group Id","operationId":"getRuleAssociationByConfigGroupId","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Config Group":{"description":"Config Group","value":{"name":"C8KV_East_Coast_Rule","description":"All C8KV devices in the east cost","useCase":"config-group-device","matchCriteria":{"match-type":"all","conditions":[{"attribute":"tags","operator":"equals","value":"East_Coast"},{"attribute":"model","operator":"equals","value":"C8000v"}]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/mobility/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get a Mobility Feature Profile with Cli profile type","operationId":"GetMobilityCliFeatureProfileByCliId","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cliId":{"description":"cliId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On-read"}},"/v1/feature-profile/mobility/cli/{cliId}/config":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get config Features for cli feature profile","operationId":"GetAllConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a config Feature for cli feature profile","operationId":"CreateConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/cli/config/post/request_schema.json"},"examples":{"CliConfigParcel1":{"$ref":"schema/profileparcel/mobility/cli/config/post/request_schema.json#/propertyNames/examples/CliConfigParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-write"}},"/v1/feature-profile/mobility/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get config Feature by configId for cli feature profile","operationId":"GetConfigFeatureForMobilityByParcelId","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a config Feature for cli feature profile","operationId":"EditConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/cli/config/put/request_schema.json"},"examples":{"CliConfigParcel1":{"$ref":"schema/profileparcel/mobility/cli/config/put/request_schema.json#/propertyNames/examples/CliConfigParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a config Feature for cli feature profile","operationId":"DeleteConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-write"}},"/v1/feature-profile/mobility/global/basic/schema":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get a Mobility Global Basic Parcel Schema by Schema Type","operationId":"GetMobilityGlobalBasicParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-read"}},"/v1/feature-profile/mobility/global/{globalId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get a Mobility Global Feature Profile by profileId","operationId":"GetMobilityFeatureProfileByGlobalId","parameters":[{"name":"globalId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"globalId":{"description":"globalId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker-read"}},"/v1/feature-profile/mobility/global/{profileId}/aaaservers":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get aaaservers Profile Parcels for Mobility Global Feature Profile","operationId":"GetAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a aaaservers Profile Parcel for Mobility Global Feature Profile","operationId":"CreateAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"aaaservers Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/aaaservers/post/request_schema.json"},"examples":{"AonAAAServersParcelConfig":{"$ref":"schema/profileparcel/mobility/global/aaaservers/post/request_schema.json#/propertyNames/examples/AonAAAServersParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-write"}},"/v1/feature-profile/mobility/global/{profileId}/aaaservers/{aaaserversId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get aaaservers Profile Parcel by parcelId for Mobility Global Feature Profile","operationId":"GetAaaServersProfileParcelByParcelIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaserversId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a aaaservers Profile Parcel for Mobility Global Feature Profile","operationId":"EditAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaserversId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"aaaservers Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/aaaservers/put/request_schema.json"},"examples":{"AonAAAServersParcelConfig":{"$ref":"schema/profileparcel/mobility/global/aaaservers/put/request_schema.json#/propertyNames/examples/AonAAAServersParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a aaaservers Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaserversId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-write"}},"/v1/feature-profile/mobility/global/{profileId}/basic":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Basic Profile Parcels for Mobility Global Feature Profile","operationId":"GetBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a Basic Profile Parcel for Mobility Global Feature Profile","operationId":"CreateBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/basic/post/request_schema.json"},"examples":{"AonBasicParcelConfig":{"$ref":"schema/profileparcel/mobility/global/basic/post/request_schema.json#/propertyNames/examples/AonBasicParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"profileId":{"description":"profileId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-write"}},"/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile","operationId":"GetBasicProfileParcelByParcelIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"parcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Basic Profile Parcel for Mobility Global Feature Profile","operationId":"EditBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"parcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/basic/put/request_schema.json"},"examples":{"AonBasicParcelConfig":{"$ref":"schema/profileparcel/mobility/global/basic/put/request_schema.json#/propertyNames/examples/AonBasicParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"profileId":{"description":"profileId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Basic Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"parcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-write"}},"/v1/feature-profile/mobility/global/{profileId}/cellular":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile","operationId":"GetCellularProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729307062},"data":[{"parcelId":"8b698d5b-be6e-47bd-8567-1e5087b4b8d9","parcelType":"cellular","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729253148,"lastUpdatedOn":1628729253148,"payload":{"id":"1","name":"ATTSingleSimPap","variables":null,"simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none","userName":null,"password":null}],"dataProfileIdList":[1],"attachProfile":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none","userName":null,"password":null}],"dataProfileIdList":[1],"attachProfile":1},"primarySlot":1,"wanConfig":null,"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"cellular"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an cellular Profile Parcel for Mobility Global Feature Profile","operationId":"CreateCellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CellularProfile"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"type":"cellular","simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"primarySlot":1,"id":"1","name":"ATTSingleSimPap"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile","operationId":"GetCellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"type":"cellular","simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"primarySlot":1,"id":"1","name":"ATTSingleSimPap"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Cellular Profile Parcel for Mobility Global Feature Profile","operationId":"EditCellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cellular"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"type":"cellular","simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"primarySlot":1,"id":"1","name":"ATTSingleSimPap"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Cellular Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteACellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/esimcellular":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get EsimCellular Profile Features for Mobility Global Feature Profile","operationId":"GetEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a EsimCellular Profile Feature for Mobility Global Feature Profile","operationId":"CreateEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/esimcellular/post/request_schema.json"},"examples":{"AON_CG1_eSim_Cellular_Profile_Feature1":{"$ref":"schema/profileparcel/mobility/global/esimcellular/post/request_schema.json#/propertyNames/examples/AON_CG1_eSim_Cellular_Profile_Feature1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/esimcellular/{esimCellularId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get EsimCellular Profile Feature by Feature Id for Mobility Global Feature Profile","operationId":"GetEsimCellularProfileFeatureByEsimCellularIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a EsimCellular Profile Feature for Mobility Global Feature Profile","operationId":"EditEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/esimcellular/put/request_schema.json"},"examples":{"AON_CG1_eSim_Cellular_Profile_Feature1":{"$ref":"schema/profileparcel/mobility/global/esimcellular/put/request_schema.json#/propertyNames/examples/AON_CG1_eSim_Cellular_Profile_Feature1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a EsimCellular Profile Feature for Mobility Global Feature Profile","operationId":"DeleteEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/ethernet":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Ethernet Profile Parcels for feature profile","operationId":"GetEthernetProfileParcels","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Ethernet Profile Parcel For Mobility Global Feature Profile":{"description":"Ethernet Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","portType":"WAN","wanConfiguration":"Active","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"5.5.5.5"},{"interfaceName":"GigabitEthernet0/1","portType":"LAN","adminState":"enabled","corporateLan":true},{"interfaceName":"GigabitEthernet0/2","portType":"LAN","adminState":"disabled"}],"parcelType":"ethernet","subparcels":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an ethernet Profile Parcel for Mobility Global Feature Profile","operationId":"CreateEthernetProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ethernet"},"examples":{"Ethernet Profile Parcel For Aon Feature Profile":{"description":"Ethernet Profile Parcel For Aon Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","portType":"WAN","wanConfiguration":"Active","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"5.5.5.5"},{"interfaceName":"GigabitEthernet0/1","portType":"LAN","adminState":"enabled","corporateLan":true},{"interfaceName":"GigabitEthernet0/2","portType":"LAN","adminState":"disabled"}],"parcelType":"ethernet","subparcels":[]}]}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"ethernetId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-write"}},"/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Ethernet Profile Parcels for feature profile","operationId":"GetEthernetProfileParcel","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Ethernet Profile Parcel For Mobility Global Feature Profile":{"description":"Ethernet Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","portType":"WAN","wanConfiguration":"Active","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"5.5.5.5"},{"interfaceName":"GigabitEthernet0/1","portType":"LAN","adminState":"enabled","corporateLan":true},{"interfaceName":"GigabitEthernet0/2","portType":"LAN","adminState":"disabled"}],"parcelType":"ethernet","subparcels":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Ethernet Profile Parcel for feature profile","operationId":"EditEthernetProfileParcelForSystem","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ethernet Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Ethernet Profile Parcel For Mobility Global Feature Profile":{"description":"Ethernet Profile Parcel For Mobility Global Feature Profile","value":{"type":"ethernet","ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","wanConfiguration":"Active","portType":"WAN","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"3.3.3.3"},{"interfaceName":"GigabitEthernet0/1","adminState":"enabled"},{"interfaceName":"GigabitEthernet0/2","adminState":"disabled"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Ethernet Profile Parcel for feature profile","operationId":"DeleteEthernetProfileParcelForSystem","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-write"}},"/v1/feature-profile/mobility/global/{profileId}/logging":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Logging Profile Features for Mobility Global Feature Profile","operationId":"GetLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a Logging Profile Feature for Mobility Global Feature Profile","operationId":"CreateLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/logging/post/request_schema.json"},"examples":{"AON_CG1_MOBILITY_Logging_parcel1":{"$ref":"schema/profileparcel/mobility/global/logging/post/request_schema.json#/propertyNames/examples/AON_CG1_MOBILITY_Logging_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-write"}},"/v1/feature-profile/mobility/global/{profileId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Logging Profile Feature by parcelId for Mobility Global Feature Profile","operationId":"GetLoggingProfileFeatureByFeatureIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Logging Profile Feature for Mobility Global Feature Profile","operationId":"EditLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/logging/put/request_schema.json"},"examples":{"AON_CG1_MOBILITY_Logging_parcel1":{"$ref":"schema/profileparcel/mobility/global/logging/put/request_schema.json#/propertyNames/examples/AON_CG1_MOBILITY_Logging_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Logging Profile Feature for Mobility Global Feature Profile","operationId":"DeleteLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-write"}},"/v1/feature-profile/mobility/global/{profileId}/networkProtocol":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile","operationId":"GetNetworkProtocolProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"NetworkProtocol Profile Parcel For Mobility Global Feature Profile":{"description":"NetworkProtocol Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729936548},"data":[{"parcelId":"4e958a77-03dc-4558-a45b-eeba554bb873","parcelType":"networkProtocol","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729896431,"lastUpdatedOn":1628729896431,"payload":{"id":null,"name":null,"variables":null,"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":2,"startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DNSSettings":"1.1.1.1","NTPInherit":false,"NTPSettings":["1.1.1.1","1.1.1.2"],"DHCPOptions":[{"type":2,"dhcpValue":"2","dataType":"integer"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test","interface":"Cellular1/0"}],"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"networkProtocol"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile","operationId":"CreateNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NetworkProtocol Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkProtocol"},"examples":{"NetworkProtocol Profile Parcel For Mobility Global Feature Profile":{"description":"NetworkProtocol Profile Parcel For Mobility Global Feature Profile","value":{"type":"networkProtocol","DNSSettings":"1.1.1.1","NTPInherit":false,"NTPSettings":["1.1.1.1","1.1.1.2"],"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":"2","startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DHCPOptions":[{"type":2,"dataType":"integer","dhcpValue":"2"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-write"}},"/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile","operationId":"GetNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"networkProtocolId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"NetworkProtocol Profile Parcel For Mobility Global Feature Profile":{"description":"NetworkProtocol Profile Parcel For Mobility Global Feature Profile","value":{"type":"networkProtocol","DNSSettings":"1.1.1.1","NTPInherit":false,"NTPSettings":["1.1.1.1","1.1.1.2"],"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":"2","startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DHCPOptions":[{"type":2,"dataType":"integer","dhcpValue":"2"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile","operationId":"EditNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"networkProtocolId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network Protocol Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkProtocol"},"examples":{"Network Protocol Profile Parcel For Mobility Global Feature Profile":{"description":"Network Protocol Profile Parcel For Mobility Global Feature Profile","value":{"type":"networkProtocol","DNSSettings":"1.1.1.1","NTPInherit":true,"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":"2","startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DHCPOptions":[{"type":2,"dataType":"integer","dhcpValue":"2"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"networkProtocolId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-write"}},"/v1/feature-profile/mobility/global/{profileId}/securityPolicy":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile","operationId":"GetSecurityPolicyProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"SecurityPolicy Profile Parcel For Mobility Global Feature Profile":{"description":"SecurityPolicy Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729560981},"data":[{"parcelId":"b79d5ede-263f-4229-aa9b-7b6581058c50","parcelType":"securityPolicy","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729517699,"lastUpdatedOn":1628729517699,"payload":{"policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}],"type":"securityPolicy"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile","operationId":"CreateSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SecurityPolicy Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityPolicy"},"examples":{"SecurityPolicy Profile Parcel For Mobility Global Feature Profile":{"description":"SecurityPolicy Profile Parcel For Mobility Global Feature Profile","value":{"type":"securityPolicy","policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-write"}},"/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile","operationId":"GetSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"SecurityPolicy Profile Parcel For Mobility Global Feature Profile":{"description":"SecurityPolicy Profile Parcel For Mobility Global Feature Profile","value":{"type":"securityPolicy","policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Security Policy Profile Parcel for Mobility Global Feature Profile","operationId":"EditSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Policy Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityPolicy"},"examples":{"Security Policy Profile Parcel For Mobility Global Feature Profile":{"description":"Security Policy Profile Parcel For Mobility Global Feature Profile","value":{"type":"securityPolicy","policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Security Policy Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-write"}},"/v1/feature-profile/mobility/global/{profileId}/vpn":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get VPN Profile Parcels for Mobility Global Feature Profile","operationId":"GetVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"CreateVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/vpn/post/request_schema.json"},"examples":{"AonVPNParcelConfig":{"$ref":"schema/profileparcel/mobility/global/vpn/post/request_schema.json#/propertyNames/examples/AonVPNParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"profileId":{"description":"profileId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-write"}},"/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get VPN Profile Parcel by parcelId for Mobility Global Feature Profile","operationId":"GetVpnProfileParcelByParcelIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"EditVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/mobility/global/vpn/put/request_schema.json"},"examples":{"AonVPNParcelConfig":{"$ref":"schema/profileparcel/mobility/global/vpn/put/request_schema.json#/propertyNames/examples/AonVPNParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"profileId":{"description":"profileId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-write"}},"/v1/feature-profile/mobility/global/{profileId}/wifi":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Wifi Profile Parcel List for Mobility feature profile","operationId":"GetWifiProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729177130},"data":[{"parcelId":"70c55c19-5043-4c6f-9b64-d710ee174bfd","parcelType":"wifi","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729108424,"lastUpdatedOn":1628729108424,"payload":{"id":null,"name":null,"ssid0":{"ssid":"myWIFI","security":"WLAN_VAP_SECURITY_WPA","password":"mypasswd","qosSettings":"WLAN_QOS_BEST_EFFORT","visibility":true},"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_NONE","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1","encryptionKey":"B1C2DE1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1WPA2","encryptionKey":"A4B5EA1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_8021X","wpaEncryptionMode":"WPA2","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"}}},"variables":null,"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"wifi"}},{"parcelId":"ef215fe9-af7f-4fa1-83c5-0d1e281749a0","parcelType":"wifi","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628716782903,"lastUpdatedOn":1628716782903,"payload":{"id":null,"name":null,"ssid0":{"ssid":"myWIFI","security":"WLAN_VAP_SECURITY_WPA","password":"mypasswd","qosSettings":"WLAN_QOS_BEST_EFFORT","visibility":true},"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_NONE","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1","encryptionKey":"B1C2DE1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1WPA2","encryptionKey":"A4B5EA1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_8021X","wpaEncryptionMode":"WPA2","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"}}},"variables":null,"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"wifi"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an Wifi Profile Parcel for Mobility feature profile","operationId":"CreateWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wifi Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wifi"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"OPEN","wpaPskKey":"","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"B1C2DE1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A4B5EA1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WPA2-Enterprise","wpaPskKey":"","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":"11","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":"36","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"}}},"parcelType":"wifi","subparcels":[]}]}]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-write"}},"/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Wifi Profile Parcel for Mobility feature profile","operationId":"GetWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wifiId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"OPEN","wpaPskKey":"","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"B1C2DE1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A4B5EA1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WPA2-Enterprise","wpaPskKey":"","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":"11","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":"36","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"}}},"parcelType":"wifi","subparcels":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Wifi Profile Parcel for Mobility feature profile","operationId":"EditWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wifiId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wifi Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wifi"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"OPEN","wpaPskKey":"","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"B1C2DE1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A4B5EA1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WPA2-Enterprise","wpaPskKey":"","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":"11","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":"36","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"}}},"parcelType":"wifi","subparcels":[]}]}]}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete an Wifi Profile Parcel for Mobility feature profile","operationId":"DeleteWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wifiId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-write"}},"/v1/feature-profile/nfvirtual/cli":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual CLI Feature Profiles","operationId":"GetAllNfvirtualCLIFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cliId":{"description":"cliId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-read"},"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a Nfvirtual CLI Feature Profile","operationId":"CreateNfvirtualCLIFeatureProfile","requestBody":{"description":"Nfvirtual Feature profile for CLI","content":{"application/json":{"schema":{"type":"string"},"examples":{"Nfvirtual Feature Profile for Cli":{"description":"Nfvirtual Feature Profile for Cli","value":{"name":"SF-Site-CLI-Profile","description":"CLI profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"id":{"description":"id","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-write"}},"/v1/feature-profile/nfvirtual/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get nfvirtual CLI Feature Profile with cliId","operationId":"GetNfvirtualCLIFeatureProfileByid","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cliId":{"description":"cliId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Nfvirtual CLI Feature Profile","operationId":"EditNfvirtualCLIFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nfvirtual Feature profile fo CLI","content":{"application/json":{"schema":{"type":"string"},"examples":{"Nfvirtual Feature Profile for CLI":{"description":"Nfvirtual Feature Profile for CLI","value":{"name":"SF-Site-CLI-Profile","description":"CLI profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete nfvirtual CLI Feature Profile","operationId":"DeleteNfvirtualCLIFeatureProfile","parameters":[{"name":"cliId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-write"}},"/v1/feature-profile/nfvirtual/cli/{cliId}/config":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create CLI Profile Parcel for CLI feature profile","operationId":"CreateNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"CLI Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"CLI Profile Parcel For CLI Feature Profile":{"description":"CLI Profile Parcel For CLI Feature Profile","value":{"name":"Config-test","description":"config-test","data":{"config":"log-data get-logs limit-lines 10"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-write"}},"/v1/feature-profile/nfvirtual/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get CLI Profile Parcels for CLI feature profile","operationId":"getNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit CLI Profile Parcel for CLI feature profile","operationId":"EditNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"CLI Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Config Profile Parcel For CLI Feature Profile":{"description":"Config Profile Parcel For CLI Feature Profile","value":{"name":"Config-test","description":"config-test","data":{"config":"log-data get-logs limit-lines 10"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete CLI Profile Parcel for CLI feature profile","operationId":"DeleteNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-write"}},"/v1/feature-profile/nfvirtual/networks":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual Feature Profiles","operationId":"GetAllNfvirtualNetworksFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a nfvirtual Networks Feature Profile","operationId":"CreateNfvirtualNetworksFeatureProfile","requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"type":"string"},"examples":{"Nfvirtual Feature Profile for Networks":{"description":"Nfvirtual Feature Profile for Networks","value":{"name":"SF-Site-Network-Profile","description":"Network profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/networks/ovsnetwork/{networkId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual OVS Networks Feature Profile with networkId","operationId":"GetAllNfvirtualOvsNetworksFeatureProfileByProfileId","parameters":[{"name":"networkId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"}},"/v1/feature-profile/nfvirtual/networks/{networkId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get a Nfvirtual Networks Feature Profile with networkId","operationId":"GetNfvirtualNetworksFeatureProfileByProfileId","parameters":[{"name":"networkId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Nfvirtual Networks Feature Profile","operationId":"EditNfvirtualNetworksFeatureProfile","parameters":[{"name":"networkId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"type":"string"},"examples":{"Nfvirtual Feature Profile for Networks":{"description":"Nfvirtual Feature Profile for Networks","value":{"name":"SF-Site-Network-Profile","description":"Network profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Nfvirtual Networks Feature Profile","operationId":"DeleteNfvirtualNetworksFeatureProfile","parameters":[{"name":"networkId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/lan":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create LAN Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"LAN config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"LAN Profile Parcel for Networks feature profile":{"description":"LAN Profile Parcel for Networks feature profile","value":{"name":"LAN-test","description":"lan-test","data":{"interface_name":{"optionType":"global","value":"GE0-1"},"ip_address":{"optionType":"global","value":"1.1.1.3"},"netmask":{"optionType":"global","value":"255.255.255.0"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/lan/{lanId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get LAN Profile Parcels for Networks feature profile","operationId":"GetNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"lanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a LAN Profile Parcel for networks feature profile","operationId":"EditNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"lanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"LAN Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"LAN Profile Parcel For Networks Feature Profile":{"description":"LAN Profile Parcel For Networks Feature Profile","value":{"name":"LAN-test","description":"lan-test","data":{"interface_name":{"optionType":"global","value":"GE0-1"},"ip_address":{"optionType":"global","value":"1.1.1.1"},"netmask":{"optionType":"global","value":"255.255.255.0"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a LAN Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"lanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/ovsnetwork":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create OVS Network Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OVS Network Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"OVS Network Profile Parcel for Networks feature profile":{"description":"OVS Network Profile Parcel for Networks feature profile","value":{"name":"OvsNetwork-test","description":"ovsnetwork-test","data":{"network_name":{"optionType":"global","value":"service-net"},"bridge":{"optionType":"global","value":"service-br"},"vlan":{"optionType":"global","value":"2"},"mode":{"optionType":"global","value":"access"},"ip_address":{"optionType":"global","value":"171.29.1.0"},"netmask":{"optionType":"global","value":"255.255.255.0"},"dhcp":{"optionType":"global","value":false}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/ovsnetwork/{ovsNetworkId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get OVS Network Profile Parcels for Networks feature profile","operationId":"GetNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ovsNetworkId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a OVS Network Profile Parcel for Networks feature profile","operationId":"EditNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ovsNetworkId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OVS Network Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"OVS Network Profile Parcel For Networks Feature Profile":{"description":"OVS Network Profile Parcel For Networks Feature Profile","value":{"name":"OvsNetwork-test","description":"ovsnetwork-test","data":{"network_name":{"optionType":"global","value":"service-net"},"bridge":{"optionType":"global","value":"service-br"},"vlan":{"optionType":"global","value":"2"},"mode":{"optionType":"global","value":"access"},"ip_address":{"optionType":"global","value":"171.29.1.0"},"netmask":{"optionType":"global","value":"255.255.255.0"},"dhcp":{"optionType":"global","value":false}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a OVS Network Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ovsNetworkId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/routes":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Routes Profile config for Networks feature profile","operationId":"CreateNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routes config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Routes Profile Parcel for Networks feature profile":{"description":"Routes Profile Parcel for Networks feature profile","value":{"name":"routes-test","description":"routes-test","data":{"routes":[{"network_address":{"optionType":"global","value":"1.1.1.10/24"},"nexthop_address":{"optionType":"global","value":"1.1.1.2"}}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/routes/{routesId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Routes Profile Parcels for Networks feature profile","operationId":"GetNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"routesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Routes Profile Parcel for networks feature profile","operationId":"EditNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"routesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routes Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Routes Profile Parcel For Networks Feature Profile":{"description":"Routes Profile Parcel For Networks Feature Profile","value":{"name":"routes-test","description":"routes-test","data":{"routes":[{"network_address":{"optionType":"global","value":"1.1.1.10/24"},"nexthop_address":{"optionType":"global","value":"1.1.1.2"}}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete Routes Profile config for Networks feature profile","operationId":"DeleteNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"routesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create VNF Attributes Profile config for Networks feature profile","operationId":"CreateNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF Attributes config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"VNF Attributes Profile Parcel for Networks feature profile":{"description":"VNF Attributes Profile Parcel for Networks feature profile","value":{"name":"vnfAttributes-test","description":"vnfAttributes-test","data":{"image_name":{"optionType":"global","value":"OTHER_rhel7_image_7_rhel7_image.qcow2"},"src":{"optionType":"global","value":"http://:8080/software/package/virtualmachine/virtualmachine-diskimg/OTHER_rhel7_image_7_rhel7_image.qcow2"},"username":{"optionType":"global","value":"user"},"password":{"optionType":"global","value":"Test123"},"version":{"optionType":"global","value":"17.10.1"},"vnf_type":{"optionType":"global","value":"ROUTER"},"low_latency":{"optionType":"global","value":true},"sriov_supported":{"optionType":"global","value":true},"nocloud":{"optionType":"global","value":false},"thick_disk_provisioning":{"optionType":"global","value":false},"bootstrap_cloud_init_drive_type":{"optionType":"global","value":"cdrom"},"console_type_serial":{"optionType":"global","value":false},"vendor":{"optionType":"global","value":"cisco"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get VNF Attributes Profile Parcels for Networks feature profile","operationId":"GetNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a VNF Attributes Profile Parcel for networks feature profile","operationId":"EditNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF Attributes Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"VNF Attributes Profile Parcel For Networks Feature Profile":{"description":"VNF Attributes Profile Parcel For Networks Feature Profile","value":{"name":"vnfAttributes-test","description":"vnfAttributes-test","data":{"image_name":{"optionType":"global","value":"OTHER_rhel7_image_7_rhel7_image.qcow2"},"src":{"optionType":"global","value":"http://:8080/software/package/virtualmachine/virtualmachine-diskimg/OTHER_rhel7_image_7_rhel7_image.qcow2"},"username":{"optionType":"global","value":"user"},"password":{"optionType":"global","value":"Test123"},"version":{"optionType":"global","value":"17.10.1"},"vnf_type":{"optionType":"global","value":"ROUTER"},"low_latency":{"optionType":"global","value":true},"sriov_supported":{"optionType":"global","value":true},"nocloud":{"optionType":"global","value":false},"thick_disk_provisioning":{"optionType":"global","value":false},"bootstrap_cloud_init_drive_type":{"optionType":"global","value":"cdrom"},"console_type_serial":{"optionType":"global","value":false},"vendor":{"optionType":"global","value":"cisco"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete VNF Attributes Profile config for Networks feature profile","operationId":"DeleteNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}/vnf":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create VNF Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"VNF Profile Parcel for Networks feature profile":{"description":"VNF Profile Parcel for Networks feature profile","value":{"name":"vnfAttributes-test","description":"vnfAttributes-test-demo","data":{"name":{"optionType":"global","value":"deployment-Linux"},"image":{"optionType":"global","value":"OTHER_rhel7_image_7_rhel7_image.qcow2"},"bootup_time":{"optionType":"global","value":-1},"deployment_datastore":{"optionType":"global","value":"datastore1"},"vcpus":{"optionType":"global","value":1},"memory_mb":{"optionType":"global","value":1024},"root_disk_mb":{"optionType":"global","value":4096},"dayZero":[{"mount_point":{"optionType":"global","value":"bootstrap"},"dayZeroFileContent":{"optionType":"global","value":"Content-Type: multipart/mixed; boundary=\"===============2587222130433519110==\"\nMIME-Version: 1.0\n--===============2587222130433519110==\nContent-Type: text/cloud-config; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-Disposition: attachment; filename=\"cloud-config\"\n#cloud-config\nvinitparam:\n - otp : {{OTP}}\n - vbond :10.25.30.1\n - org : {{ORGNAME}\n - uuid : {{UUID}}\n--===============2587222130433519110==\nContent-Type: text/cloud-boothook; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-Disposition: attachment;\n filename=\"config-default.txt\"\n#cloud-boothook\nsystem\n host-name Router\n system-ip {{SYSTEM_IP}}\n overlay-id 1\n site-id 500\n port-offset 0\n control-session-pps 300\n admin-tech-on-failure\n sp-organization-name \"Cisco\"\n organization-name \"Cisco\"\n port-hop\n track-transport\n track-default-gateway\n console-baud-rate 115200\n vbond {{VBOND}} port 12346\n logging\n disk\n enable\n !\n !\n !\n bfd app-route multiplier 6\n bfd app-route poll-interval 600000\n sslproxy\n no enable\n rsa-key-modulus 2048\n certificate-lifetime 730\n eckey-type P256\n ca-tp-label PROXY-SIGNING-CA\n settings expired-certificate drop\n settings untrusted-certificate drop\n settings unknown-status drop\n settings unsupported-protocol-versions drop\n settings unsupported-cipher-suites drop\n settings failure-mode close\n settings minimum-tls-ver TLSv1\n !\n no tcpproxy enable\n sdwan\n interface GigabitEthernet2\n tunnel-interface\n encapsulation ipsec weight 1\n no border\n color default\n no last-resort-circuit\n no low-bandwidth-link\n no vbond-as-stun-server\n vmanage-connection-preference 5\n port-hop\n carrier default\n nat-refresh-interval 5\n hello-interval 1000\n hello-tolerance 12\n no allow-service all\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n no allow-service snmp\n exit\n exit\n appqoe\n no tcpopt enable\n !\n omp\n no shutdown\n send-path-limit 4\n ecmp-limit 4\n graceful-restart\n no as-dot-notation\n timers\n holdtime 60\n advertisement-interval 1\n graceful-restart-timer 43200\n eor-timer 300\n exit\n address-family ipv4\n advertise connected\n advertise static\n !\n address-family ipv6\n advertise connected\n advertise static\n !\n !\n !\n security\n ipsec\n rekey 86400\n replay-window 512\n authentication-type sha1-hmac ah-sha1-hmac\n !\n !\n no service pad\n service tcp-keepalives-in\n service tcp-keepalives-out\n no service tcp-small-servers\n no service udp-small-servers\n hostname Router\n username admin privilege 15 secret 0 admin\n vrf definition Mgmt-intf\n description Transport VPN\n rd 1:512\n address-family ipv4\n route-target export 1:512\n route-target import 1:512\n exit-address-family\n !\n address-family ipv6\n exit-address-family\n !\n !\n ip arp proxy disable\n no ip finger\n no ip rcmd rcp-enable\n no ip rcmd rsh-enable\n no ip dhcp use class\n ip multicast route-limit 2147483647\n ip name-server 171.70.168.183\n ip route vrf Mgmt-intf 0.0.0.0 0.0.0.0 ${NICID_0_GATEWAY}\n ip route 0.0.0.0 0.0.0.0 {{VPN0_WAN_GATEWAY}}\n ip bootp server\n no ip source-route\n no ip http server\n no ip http secure-server\n no ip http ctc authentication\n no ip igmp ssm-map query dns\n interface GigabitEthernet1\n description MGMT\n no shutdown\n arp timeout 1200\n vrf forwarding Mgmt-intf\n ip address ${NICID_0_IP_ADDRESS} ${NICID_0_NETMASK}\n ip redirects\n ip mtu 1500\n mtu 1500\n negotiation auto\n exit\n interface GigabitEthernet2\n description Transport\n no shutdown\n arp timeout 1200\n ip address ${VPN0_WAN_IP} ${VPN0_MASK}\n ip redirects\n ip mtu 1500\n mtu 1500\n negotiation auto\n exit\n interface Tunnel2\n no shutdown\n ip unnumbered GigabitEthernet2\n no ip redirects\n ipv6 unnumbered GigabitEthernet2\n no ipv6 redirects\n tunnel source GigabitEthernet2\n tunnel mode sdwan\n exit\n clock timezone UTC 0 0\n logging persistent size 104857600 filesize 10485760\n logging buffered 512000\n no logging rate-limit\n logging persistent\n aaa authentication login default local\n aaa authorization exec default local\n aaa session-id common\n no crypto ikev2 diagnose error\n no crypto isakmp diagnose error\n snmp-server ifindex persist\n line con 0\n login authentication default\n speed 115200\n stopbits 1\n !\n line vty 0 4\n transport input ssh\n !\n line vty 5 80\n transport input ssh\n !\n lldp run\n nat64 translation timeout tcp 60\n nat64 translation timeout udp 1\n !\n!\n\n--===============2587222130433519110==\n"}}],"interfaces":[{"name":{"optionType":"global","value":"service-net"},"nicid":{"optionType":"global","value":0},"sriov":{"optionType":"global","value":false},"vlan":{"optionType":"global","value":2},"mode":{"optionType":"global","value":"access"}}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}/vnf/{vnfId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get VNF Profile Parcels for Networks feature profile","operationId":"GetNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"vnfId","in":"path","description":"VNF Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a VNF Profile Parcel for networks feature profile","operationId":"EditNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"vnfId","in":"path","description":"VNF Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"VNF Profile Parcel For Networks Feature Profile":{"description":"VNF Profile Parcel For Networks Feature Profile","value":{"name":"vnfAttributes-test","description":"vnfAttributes-test-demo","data":{"name":{"optionType":"global","value":"deployment-Linux"},"image":{"optionType":"global","value":"OTHER_rhel7_image_7_rhel7_image.qcow2"},"bootup_time":{"optionType":"global","value":-1},"deployment_datastore":{"optionType":"global","value":"datastore1"},"vcpus":{"optionType":"global","value":1},"memory_mb":{"optionType":"global","value":1024},"root_disk_mb":{"optionType":"global","value":4096},"dayZero":[{"mount_point":{"optionType":"global","value":"bootstrap"},"dayZeroFileContent":{"optionType":"global","value":"Content-Type: multipart/mixed; boundary=\"===============2587222130433519110==\"\nMIME-Version: 1.0\n--===============2587222130433519110==\nContent-Type: text/cloud-config; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-Disposition: attachment; filename=\"cloud-config\"\n#cloud-config\nvinitparam:\n - otp : {{OTP}}\n - vbond :10.25.30.1\n - org : {{ORGNAME}\n - uuid : {{UUID}}\n--===============2587222130433519110==\nContent-Type: text/cloud-boothook; charset=\"us-ascii\"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nContent-Disposition: attachment;\n filename=\"config-default.txt\"\n#cloud-boothook\nsystem\n host-name Router\n system-ip {{SYSTEM_IP}}\n overlay-id 1\n site-id 500\n port-offset 0\n control-session-pps 300\n admin-tech-on-failure\n sp-organization-name \"Cisco\"\n organization-name \"Cisco\"\n port-hop\n track-transport\n track-default-gateway\n console-baud-rate 115200\n vbond {{VBOND}} port 12346\n logging\n disk\n enable\n !\n !\n !\n bfd app-route multiplier 6\n bfd app-route poll-interval 600000\n sslproxy\n no enable\n rsa-key-modulus 2048\n certificate-lifetime 730\n eckey-type P256\n ca-tp-label PROXY-SIGNING-CA\n settings expired-certificate drop\n settings untrusted-certificate drop\n settings unknown-status drop\n settings unsupported-protocol-versions drop\n settings unsupported-cipher-suites drop\n settings failure-mode close\n settings minimum-tls-ver TLSv1\n !\n no tcpproxy enable\n sdwan\n interface GigabitEthernet2\n tunnel-interface\n encapsulation ipsec weight 1\n no border\n color default\n no last-resort-circuit\n no low-bandwidth-link\n no vbond-as-stun-server\n vmanage-connection-preference 5\n port-hop\n carrier default\n nat-refresh-interval 5\n hello-interval 1000\n hello-tolerance 12\n no allow-service all\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n no allow-service snmp\n exit\n exit\n appqoe\n no tcpopt enable\n !\n omp\n no shutdown\n send-path-limit 4\n ecmp-limit 4\n graceful-restart\n no as-dot-notation\n timers\n holdtime 60\n advertisement-interval 1\n graceful-restart-timer 43200\n eor-timer 300\n exit\n address-family ipv4\n advertise connected\n advertise static\n !\n address-family ipv6\n advertise connected\n advertise static\n !\n !\n !\n security\n ipsec\n rekey 86400\n replay-window 512\n authentication-type sha1-hmac ah-sha1-hmac\n !\n !\n no service pad\n service tcp-keepalives-in\n service tcp-keepalives-out\n no service tcp-small-servers\n no service udp-small-servers\n hostname Router\n username admin privilege 15 secret 0 admin\n vrf definition Mgmt-intf\n description Transport VPN\n rd 1:512\n address-family ipv4\n route-target export 1:512\n route-target import 1:512\n exit-address-family\n !\n address-family ipv6\n exit-address-family\n !\n !\n ip arp proxy disable\n no ip finger\n no ip rcmd rcp-enable\n no ip rcmd rsh-enable\n no ip dhcp use class\n ip multicast route-limit 2147483647\n ip name-server 171.70.168.183\n ip route vrf Mgmt-intf 0.0.0.0 0.0.0.0 ${NICID_0_GATEWAY}\n ip route 0.0.0.0 0.0.0.0 {{VPN0_WAN_GATEWAY}}\n ip bootp server\n no ip source-route\n no ip http server\n no ip http secure-server\n no ip http ctc authentication\n no ip igmp ssm-map query dns\n interface GigabitEthernet1\n description MGMT\n no shutdown\n arp timeout 1200\n vrf forwarding Mgmt-intf\n ip address ${NICID_0_IP_ADDRESS} ${NICID_0_NETMASK}\n ip redirects\n ip mtu 1500\n mtu 1500\n negotiation auto\n exit\n interface GigabitEthernet2\n description Transport\n no shutdown\n arp timeout 1200\n ip address ${VPN0_WAN_IP} ${VPN0_MASK}\n ip redirects\n ip mtu 1500\n mtu 1500\n negotiation auto\n exit\n interface Tunnel2\n no shutdown\n ip unnumbered GigabitEthernet2\n no ip redirects\n ipv6 unnumbered GigabitEthernet2\n no ipv6 redirects\n tunnel source GigabitEthernet2\n tunnel mode sdwan\n exit\n clock timezone UTC 0 0\n logging persistent size 104857600 filesize 10485760\n logging buffered 512000\n no logging rate-limit\n logging persistent\n aaa authentication login default local\n aaa authorization exec default local\n aaa session-id common\n no crypto ikev2 diagnose error\n no crypto isakmp diagnose error\n snmp-server ifindex persist\n line con 0\n login authentication default\n speed 115200\n stopbits 1\n !\n line vty 0 4\n transport input ssh\n !\n line vty 5 80\n transport input ssh\n !\n lldp run\n nat64 translation timeout tcp 60\n nat64 translation timeout udp 1\n !\n!\n\n--===============2587222130433519110==\n"}}],"interfaces":[{"name":{"optionType":"global","value":"service-net"},"nicid":{"optionType":"global","value":0},"sriov":{"optionType":"global","value":false},"vlan":{"optionType":"global","value":2},"mode":{"optionType":"global","value":"access"}}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a VNF Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"vnfId","in":"path","description":"VNF Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/wan":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a WAN Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualWanParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WAN config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"WAN Profile Parcel for Networks feature profile":{"description":"WAN Profile Parcel for Networks feature profile","value":{"name":"wan-test","description":"wan-test","data":{"color":{"optionType":"global","value":"gold"},"interface_name":{"optionType":"global","value":"GE0-0"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"1.1.1.8"},"netmask":{"optionType":"global","value":"255.255.255.0"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"1.1.1.6"},"type":{"optionType":"global","value":"primary"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/wan/{wanId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get WAN Profile Parcels for Networks feature profile","operationId":"GetNfvirtualWANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a WAN Profile Parcel for networks feature profile","operationId":"EditNfvirtualWANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WAN Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"WAN Profile Parcel For Networks Feature Profile":{"description":"WAN Profile Parcel For Networks Feature Profile","value":{"name":"wan-test","description":"wan-test","data":{"color":{"optionType":"global","value":"gold"},"interface_name":{"optionType":"global","value":"GE0-0"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"1.1.1.8"},"netmask":{"optionType":"global","value":"255.255.255.0"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"1.1.1.6"},"type":{"optionType":"global","value":"primary"},"network_name":{"optionType":"global","value":"wan-net"},"bridge":{"optionType":"global","value":"wan-br"},"mode":{"optionType":"default","value":"trunk"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a WAN Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualWANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-write"}},"/v1/feature-profile/nfvirtual/system":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual System Feature Profiles","operationId":"GetAllNfvirtualSystemFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a nfvirtual System Feature Profile","operationId":"CreateNfvirtualSystemFeatureProfile","requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"type":"string"},"examples":{"Nfvirtual Feature Profile for System":{"description":"Nfvirtual Feature Profile for System","value":{"name":"SF-Site-System-Profile","description":"System profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get a Nfvirtual System Feature Profile with systemId","operationId":"GetNfvirtualSystemFeatureProfileByProfileId","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Nfvirtual System Feature Profile","operationId":"EditNfvirtualSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"type":"string"},"examples":{"Nfvirtual Feature Profile for System":{"description":"Nfvirtual Feature Profile for System","value":{"name":"SF-Site-System-Profile","description":"System profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Nfvirtual System Feature Profile","operationId":"DeleteNfvirtualSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/aaa":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create AAA Profile Parcel for System feature profile","operationId":"CreateNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"AAA config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"AAA Profile Parcel for System feature profile":{"description":"AAA Profile Parcel for System feature profile","value":{"name":"aaa-test","description":"aaa-test","data":{"auth-order":[{"authentication":{"optionType":"global","value":"local"}},{"authentication":{"optionType":"global","value":"tacacs"}}],"user":[{"name":{"optionType":"global","value":"marketingUser"},"role":{"optionType":"global","value":"operators"},"nfvisPassword":{"optionType":"global","value":"reachGoals_2022"}}],"tacacs":[{"host":{"optionType":"global","value":"209.165.201.20"},"key":{"optionType":"default","value":"0"},"shared-secret":{"optionType":"global","value":"test1"},"admin-priv":{"optionType":"default","value":15},"oper-priv":{"optionType":"default","value":11}}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/aaa/{aaaId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get AAA Profile Parcels for System feature profile","operationId":"GetNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a AAA Profile Parcel for System feature profile","operationId":"EditNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"AAA Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"AAA Profile Parcel For System Feature Profile":{"description":"AAA Profile Parcel For System Feature Profile","value":{"name":"aaa-test","description":"aaa-test","data":{"auth-order":[{"authentication":{"optionType":"global","value":"local"}},{"authentication":{"optionType":"global","value":"tacacs"}}],"user":[{"name":{"optionType":"global","value":"marketingUser"},"role":{"optionType":"global","value":"operators"},"nfvisPassword":{"optionType":"global","value":"reachGoals_2022"}}],"tacacs":[{"host":{"optionType":"global","value":"209.165.201.20"},"key":{"optionType":"default","value":"0"},"shared-secret":{"optionType":"global","value":"test1"},"admin-priv":{"optionType":"default","value":15},"oper-priv":{"optionType":"default","value":11}}]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a AAA Profile Parcel for System feature profile","operationId":"DeleteNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/banner":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Banner Profile Parcel for System feature profile","operationId":"CreateNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Banner Profile Parcel for System feature profile":{"description":"Banner Profile Parcel for System feature profile","value":{"name":"banner-test","description":"banner-test","data":{"motd":{"optionType":"global","value":"hi"},"login":{"optionType":"global","value":"admin"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/banner/{bannerId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Banner Profile Parcels for System feature profile","operationId":"GetNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Banner Profile Parcel for System feature profile","operationId":"EditNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Banner Profile Parcel For System Feature Profile":{"description":"Banner Profile Parcel For System Feature Profile","value":{"name":"banner-test","description":"banner-test","data":{"motd":{"optionType":"global","value":"hi"},"login":{"optionType":"global","value":"admin"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Banner Profile Parcel for System feature profile","operationId":"DeleteNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/logging":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Logging Profile Parcel for System feature profile","operationId":"CreateNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Logging Profile Parcel for System feature profile":{"description":"Logging Profile Parcel for System feature profile","value":{"name":"logging-test","description":"logging-test","data":{"host-ip-address":[{"name":{"optionType":"global","value":"1.2.3.4"}},{"name":{"optionType":"global","value":"1.2.3.5"}}],"severity":{"optionType":"global","value":"alert"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Logging Profile Parcels for System feature profile","operationId":"GetNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Logging Profile Parcel for System feature profile","operationId":"EditNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Logging Profile Parcel For System Feature Profile":{"description":"Logging Profile Parcel For System Feature Profile","value":{"name":"logging-test","description":"logging-test","data":{"host-ip-address":[{"name":{"optionType":"global","value":"1.2.3.4"}},{"name":{"optionType":"global","value":"1.2.3.5"}}],"severity":{"optionType":"global","value":"alert"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Logging Profile Parcel for System feature profile","operationId":"DeleteNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/ntp":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create NTP Profile Parcel for System feature profile","operationId":"CreateNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NTP config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"NTP Profile Parcel for System feature profile":{"description":"NTP Profile Parcel for System feature profile","value":{"name":"ntp-test","description":"ntp-test","data":{"preferred_server":{"optionType":"global","value":"xxx"},"backup_server":{"optionType":"global","value":"xxx"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/ntp/{ntpId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get NTP Profile Parcels for System feature profile","operationId":"GetNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a NTP Profile Parcel for System feature profile","operationId":"EditNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NTP Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"NTP Profile Parcel For System Feature Profile":{"description":"NTP Profile Parcel For System Feature Profile","value":{"name":"ntp-test","description":"ntp-test","data":{"preferred_server":{"optionType":"global","value":"xxx"},"backup_server":{"optionType":"global","value":"xxx"}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a NTP Profile Parcel for System feature profile","operationId":"DeleteNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/snmp":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create SNMP Profile Parcel for System feature profile","operationId":"CreateNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SNMP config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"SNMP Profile Parcel for System feature profile":{"description":"SNMP Profile Parcel for System feature profile","value":{"name":"snmp-test","description":"snmp-test","data":{"community":[],"group":[{"name":{"optionType":"global","value":"user"},"context":{"optionType":"global","value":"snmp"},"version":{"optionType":"global","value":"3"},"securityLevel":{"optionType":"global","value":"noAuthNoPriv"},"notify":{"optionType":"global","value":"snmpNotify"},"read":{"optionType":"global","value":"snmpRead"},"write":{"optionType":"global","value":"snmpWrite"}}],"user":[],"host":[],"linkUp":{"optionType":"global","value":true},"linkDown":{"optionType":"global","value":true}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/snmp/{snmpId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get SNMP Profile Parcels for System feature profile","operationId":"GetNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a SNMP Profile Parcel for System feature profile","operationId":"EditNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SNMP Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"SNMP Profile Parcel For System Feature Profile":{"description":"SNMP Profile Parcel For System Feature Profile","value":{"name":"snmp-test","description":"snmp-test","data":{"community":[],"group":[{"name":{"optionType":"global","value":"user"},"context":{"optionType":"global","value":"snmp"},"version":{"optionType":"global","value":"3"},"securityLevel":{"optionType":"global","value":"noAuthNoPriv"},"notify":{"optionType":"global","value":"snmpNotify"},"read":{"optionType":"global","value":"snmpRead"},"write":{"optionType":"global","value":"snmpWrite"}}],"user":[],"host":[],"linkUp":{"optionType":"global","value":true},"linkDown":{"optionType":"global","value":true}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a SNMP Profile Parcel for System feature profile","operationId":"DeleteNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/system-settings":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create System settings Profile Parcel for System feature profile","operationId":"CreateNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"System Settings config Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"System settings Profile Parcel for System feature profile":{"description":"System settings Profile Parcel for System feature profile","value":{"name":"nfvisystem-test","description":"nfvisystem-test","data":{"nameServer":[{"name":{"optionType":"global","value":"1.2.3.4"}},{"name":{"optionType":"global","value":"nameserver.orgname.com"}}],"dpdk":{"optionType":"global","value":true}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/system-settings/{systemSettingsId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get System Settings Profile Parcels for System feature profile","operationId":"GetNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"systemSettingsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a System Settings Profile Parcel for System feature profile","operationId":"EditNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"systemSettingsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"System Settings Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"System Settings Profile Parcel For System Feature Profile":{"description":"System Settings Profile Parcel For System Feature Profile","value":{"name":"nfvisystem-test","description":"nfvisystem-test","data":{"nameServer":[{"name":{"optionType":"global","value":"1.2.3.4"}},{"name":{"optionType":"global","value":"nameserver.orgname.com"}}],"dpdk":{"optionType":"global","value":true}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete System settings Profile Parcel for System feature profile","operationId":"DeleteNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"systemSettingsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-write"}},"/v1/feature-profile/sdwan":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles","operationId":"GetSdwanFeatureProfileBySdwanFamily","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cliId":{"description":"cliId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile-read"}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/qos-policy":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create QOS Policy feature for application-priority feature profile","operationId":"createPolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"QOS Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/application-priority/qos-policy/post/request_schema.json"},"examples":{"Qos2":{"$ref":"schema/profileparcel/sdwan/application-priority/qos-policy/post/request_schema.json#/propertyNames/examples/Qos2"}}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/qos-policy/{qosPolicyId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get QOS Policy feature for application-priority feature profile","operationId":"getPolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"qosPolicyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit QOS Policy feature for application-priority feature profile","operationId":"editPolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"qosPolicyId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"QOS Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/application-priority/qos-policy/put/request_schema.json"},"examples":{"Qos2":{"$ref":"schema/profileparcel/sdwan/application-priority/qos-policy/put/request_schema.json#/propertyNames/examples/Qos2"}}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete QOS Policy feature for application-priority feature profile","operationId":"deletePolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"qosPolicyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/traffic-policy":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Traffic Policy Profile Parcel for application-priority feature profile","operationId":"CreateTrafficPolicyProfileParcelForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Traffic Policy Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/application-priority/traffic-policy/post/request_schema.json"},"examples":{"traffic-policy-1":{"$ref":"schema/profileparcel/sdwan/application-priority/traffic-policy/post/request_schema.json#/propertyNames/examples/traffic-policy-1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/traffic-policy/{trafficPolicyId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Traffic Policy Profile Parcel by parcelId for application-priority feature profile","operationId":"GetTrafficPolicyProfileParcelByParcelIdForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trafficPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Application Priority > Traffic Policy-read,Feature Profile > Application Priority > Traffic Policy-write"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Traffic Policy Profile Parcel for application-priority feature profile","operationId":"EditTrafficPolicyProfileParcelForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trafficPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Traffic Policy Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/application-priority/traffic-policy/put/request_schema.json"},"examples":{"traffic-policy-1":{"$ref":"schema/profileparcel/sdwan/application-priority/traffic-policy/put/request_schema.json#/propertyNames/examples/traffic-policy-1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Traffic Policy Profile Parcel for application-priority feature profile","operationId":"DeleteTrafficPolicyProfileParcelForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trafficPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Application Priority > Traffic Policy-write"}},"/v1/feature-profile/sdwan/cli":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanFeatureProfilesByFamilyAndType","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cliId":{"description":"cliId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Feature Profile with profile type","operationId":"CreateSdwanFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-write"}},"/v1/feature-profile/sdwan/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Feature Profile with Cli profile type","operationId":"GetSdwanFeatureProfileByProfileId","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cliId":{"description":"cliId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Feature Profile","operationId":"EditSdwanFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanFeatureProfileForCli","parameters":[{"name":"cliId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-write"}},"/v1/feature-profile/sdwan/cli/{cliId}/config":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get config Profile Parcels for cli feature profile","operationId":"GetConfigProfileParcelForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a config Profile Parcel for cli feature profile","operationId":"CreateSdwanConfigProfileParcelForCli","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/cli/config/post/request_schema.json"},"examples":{"CliConfigParcel1":{"$ref":"schema/profileparcel/sdwan/cli/config/post/request_schema.json#/propertyNames/examples/CliConfigParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-write"}},"/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get config Profile Parcel by configId for cli feature profile","operationId":"GetConfigProfileParcelByParcelIdForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a config Profile Parcel for cli feature profile","operationId":"EditConfigProfileParcelForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/cli/config/put/request_schema.json"},"examples":{"CliConfigParcel1":{"$ref":"schema/profileparcel/sdwan/cli/config/put/request_schema.json#/propertyNames/examples/CliConfigParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a config Profile Parcel for cli feature profile","operationId":"DeleteConfigProfileParcelForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-write"}},"/v1/feature-profile/sdwan/dns-security":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanDnsSecurityFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Dns Security Feature Profile","operationId":"CreateSdwanDnsSecurityFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-write"}},"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Dns Security Feature Profile with dnsSecurityId","operationId":"GetSdwanDnsSecurityFeatureProfileByProfileId","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Dns Security Feature Profile","operationId":"EditSdwanDnsSecurityFeatureProfile","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanDnsSecurityFeatureProfile","parameters":[{"name":"dnsSecurityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-write"}},"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}/dns":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Sig Security Profile Parcels for a given ParcelType","operationId":"GetSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Sig Security Policy","operationId":"CreateSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/dns-security/dns/post/request_schema.json"},"examples":{"targetVpnsDnsSecurity":{"$ref":"schema/profileparcel/sdwan/dns-security/dns/post/request_schema.json#/propertyNames/examples/targetVpnsDnsSecurity"},"matchAllVpnsDnsSecurity":{"$ref":"schema/profileparcel/sdwan/dns-security/dns/post/request_schema.json#/propertyNames/examples/matchAllVpnsDnsSecurity"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-write"}},"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}/dns/{dnsSecurityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get SigSecurity Profile Parcel by parcelId","operationId":"GetSigSecurityProfileParcelByParcelId","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dnsSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Sig Security Profile Parcel","operationId":"EditSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dnsSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/dns-security/dns/put/request_schema.json"},"examples":{"targetVpnsDnsSecurity":{"$ref":"schema/profileparcel/sdwan/dns-security/dns/put/request_schema.json#/propertyNames/examples/targetVpnsDnsSecurity"},"matchAllVpnsDnsSecurity":{"$ref":"schema/profileparcel/sdwan/dns-security/dns/put/request_schema.json#/propertyNames/examples/matchAllVpnsDnsSecurity"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a SigSecurity Profile Parcel ","operationId":"DeleteSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dnsSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/policy":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcels for a given ParcelType","operationId":"GetSecurityProfileParcel_1","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Security Policy","operationId":"CreateEmbeddedSecurityProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/embedded-security/policy/post/request_schema.json"},"examples":{"PolicyParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/embedded-security/policy/post/request_schema.json#/propertyNames/examples/PolicyParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/policy/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcel by parcelId","operationId":"GetSecurityProfileParcelByParcelId_1","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Security Profile Parcel","operationId":"EditSecurityProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/embedded-security/policy/put/request_schema.json"},"examples":{"PolicyParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/embedded-security/policy/put/request_schema.json#/propertyNames/examples/PolicyParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Security Profile Parcel ","operationId":"DeleteSecurityProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/unified/ngfirewall":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ngfirewall Profile Parcel","operationId":"GetNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Ngfirewall Policy","operationId":"CreateNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ngfirewall Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/embedded-security/unified/ngfirewall/post/request_schema.json"},"examples":{"ngfirewallParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/embedded-security/unified/ngfirewall/post/request_schema.json#/propertyNames/examples/ngfirewallParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/unified/ngfirewall/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ngfirewall Profile Parcel by parcelId","operationId":"GetNgfirewallProfileParcelByParcelId","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Ngfirewall Profile Parcel","operationId":"EditNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ngfirewall Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/embedded-security/unified/ngfirewall/put/request_schema.json"},"examples":{"ngfirewallParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/embedded-security/unified/ngfirewall/put/request_schema.json#/propertyNames/examples/ngfirewallParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Ngfirewall Profile Parcel ","operationId":"DeleteNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"}},"/v1/feature-profile/sdwan/other":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanOtherFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Other Feature Profile","operationId":"CreateSDWANOtherFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-write"}},"/v1/feature-profile/sdwan/other/thousandeyes/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Other Thousandeyes Parcel Schema by Schema Type","operationId":"GetSdwanOtherThousandeyesParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-read"}},"/v1/feature-profile/sdwan/other/{otherId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Other Feature Profile with otherId","operationId":"GetSdwanOtherFeatureProfileByProfileId","parameters":[{"name":"otherId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Other Feature Profile","operationId":"EditSdwanOtherFeatureProfile","parameters":[{"name":"otherId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanOtherFeatureProfile","parameters":[{"name":"otherId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-write"}},"/v1/feature-profile/sdwan/other/{otherId}/cybervision":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cybervision Profile feature for Other feature profile","operationId":"GetCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Cybervision-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Cybervision Profile feature for Other feature profile","operationId":"CreateCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cybervision Profile feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/other/cybervision/post/request_schema.json"},"examples":{"cybervisionFeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/other/cybervision/post/request_schema.json#/propertyNames/examples/cybervisionFeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Cybervision-write"}},"/v1/feature-profile/sdwan/other/{otherId}/cybervision/{cybervisionId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cybervision Profile feature by FeatureId for Other feature profile","operationId":"GetCybervisionProfileFeatureByFeatureIdForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cybervisionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Cybervision-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Cybervision Profile feature for Other feature profile","operationId":"EditCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cybervisionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cybervision Profile feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/other/cybervision/put/request_schema.json"},"examples":{"cybervisionFeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/other/cybervision/put/request_schema.json#/propertyNames/examples/cybervisionFeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Cybervision-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Cybervision Profile feature for Other feature profile","operationId":"DeleteCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cybervisionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Cybervision-write"}},"/v1/feature-profile/sdwan/other/{otherId}/thousandeyes":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Thousandeyes Profile Parcels for Other feature profile","operationId":"GetThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Thousandeyes Profile Parcel for Other feature profile","operationId":"CreateThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Thousandeyes Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/other/thousandeyes/post/request_schema.json"},"examples":{"thousandeyesParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/other/thousandeyes/post/request_schema.json#/propertyNames/examples/thousandeyesParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-write"}},"/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Thousandeyes Profile Parcel by parcelId for Other feature profile","operationId":"GetThousandeyesProfileParcelByParcelIdForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"thousandeyesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Thousandeyes Profile Parcel for Other feature profile","operationId":"EditThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"thousandeyesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Thousandeyes Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/other/thousandeyes/put/request_schema.json"},"examples":{"thousandeyesParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/other/thousandeyes/put/request_schema.json#/propertyNames/examples/thousandeyesParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Thousandeyes Profile Parcel for Other feature profile","operationId":"DeleteThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"thousandeyesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-write"}},"/v1/feature-profile/sdwan/other/{otherId}/ucse":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ucse Profile feature for Other feature profile","operationId":"GetUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Ucse Profile feature for Other feature profile","operationId":"CreateUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ucse Profile feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/other/ucse/common/request_schema.json"},"examples":{"UcsefeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/other/ucse/common/request_schema.json#/propertyNames/examples/UcsefeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-write"}},"/v1/feature-profile/sdwan/other/{otherId}/ucse/{ucseId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ucse Profile feature by FeatureId for Other feature profile","operationId":"GetUcseProfileFeatureByIdFFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ucseId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Ucse Profile feature for Other feature profile","operationId":"EditUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ucseId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ucse Profile feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/other/ucse/common/request_schema.json"},"examples":{"UcsefeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/other/ucse/common/request_schema.json#/propertyNames/examples/UcsefeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Ucse Profile feature for Other feature profile","operationId":"DeleteUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ucseId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/unified/{securityProfileParcelType}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcels for a given ParcelType","operationId":"GetSecurityProfileParcel","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-read,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-read,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Security Policy","operationId":"CreateSecurityProfileParcel","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedSecurityprofileparceltypePost"},"examples":{"SecurityprofileparceltypePostAIP1":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-inspection-profile/post/request_schema.json#/propertyNames/examples/AIP1"},"SecurityprofileparceltypePostIntrusionPreventionParcel":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/intrusion-prevention/post/request_schema.json#/propertyNames/examples/IntrusionPreventionParcel"},"SecurityprofileparceltypePostsecurity-urlfilteringParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/url-filtering/post/request_schema.json#/propertyNames/examples/security-urlfilteringParcelGlobalDefault"},"SecurityprofileparceltypePostAMP1":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-malware-protection/post/request_schema.json#/propertyNames/examples/AMP1"},"SecurityprofileparceltypePostssl-decryption-profileParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption-profile/post/request_schema.json#/propertyNames/examples/ssl-decryption-profileParcelGlobalDefault"},"SecurityprofileparceltypePostssl-decryptionParcel":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption/post/request_schema.json#/propertyNames/examples/ssl-decryptionParcel"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-write,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-write,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/unified/{securityProfileParcelType}/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcel by parcelId","operationId":"GetSecurityProfileParcelByParcelId","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-read,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-read,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Security Profile Parcel","operationId":"EditSecurityProfileParcel_1","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedSecurityprofileparceltypePut"},"examples":{"SecurityprofileparceltypePutAIP1":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-inspection-profile/put/request_schema.json#/propertyNames/examples/AIP1"},"SecurityprofileparceltypePutIntrusionPreventionParcel":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/intrusion-prevention/put/request_schema.json#/propertyNames/examples/IntrusionPreventionParcel"},"SecurityprofileparceltypePutsecurity-urlfilteringParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/url-filtering/put/request_schema.json#/propertyNames/examples/security-urlfilteringParcelGlobalDefault"},"SecurityprofileparceltypePutAMP1":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-malware-protection/put/request_schema.json#/propertyNames/examples/AMP1"},"SecurityprofileparceltypePutssl-decryption-profileParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption-profile/put/request_schema.json#/propertyNames/examples/ssl-decryption-profileParcelGlobalDefault"},"SecurityprofileparceltypePutssl-decryptionParcel":{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption/put/request_schema.json#/propertyNames/examples/ssl-decryptionParcel"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-write,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-write,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Security Profile Parcel ","operationId":"DeleteSecurityProfileParcel_1","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-write,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-write,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/{policyObjectListType}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Data Prefix Profile Parcels for Policy Object feature profile","operationId":"GetDataPrefixProfileParcelForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-read,Feature Profile > Policy Object > Security FQDN Prefix-read,Feature Profile > Policy Object > Security Port-read,Feature Profile > Policy Object > Security Zone-read,Feature Profile > Policy Object > Security Local App-read,Feature Profile > Policy Object > Security Local Domain-read,Feature Profile > Policy Object > Security IPS Signature-read,Feature Profile > Policy Object > Security URL List-read,Feature Profile > Policy Object > Security Protocol Name-read,Feature Profile > Policy Object > Security Geo Location-read,Feature Profile > Policy Object > Security Identity-read,Feature Profile > Policy Object > Security Scalable Group Tag-read,Feature Profile > Policy Object > As Path-read,Feature Profile > Policy Object > Class-read,Feature Profile > Policy Object > Data Ipv6-read,Feature Profile > Policy Object > Data Prefix-read,Feature Profile > Policy Object > Community-read,Feature Profile > Policy Object > Ext Community-read,Feature Profile > Policy Object > Ipv6 Prefix-read,Feature Profile > Policy Object > Mirror-read,Feature Profile > Policy Object > Policer-read,Feature Profile > Policy Object > Prefix-read,Feature Profile > Policy Object > Standard Community-read,Feature Profile > Policy Object > VPN Group-read,Feature Profile > Policy Object > App List-read,Feature Profile > Policy Object > SLA Class-read,Feature Profile > Policy Object > Color List-read,Feature Profile > Policy Object > App Probe-read,Feature Profile > Policy Object > TLOC-read,Feature Profile > Policy Object > Preferred Color Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Data Prefix Profile Parcel for Security Policy Object feature profile","operationId":"CreateDataPrefixProfileParcelForSecurityPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}}],"requestBody":{"description":"Data Prefix Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedPolicyobjectlisttypePost"},"examples":{"PolicyobjectlisttypePostsecurity-data-ip-prefixParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-data-ip-prefix/post/request_schema.json#/propertyNames/examples/security-data-ip-prefixParcelGlobalDefault"},"PolicyobjectlisttypePostsecurity-data-fqdn-prefixParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-fqdn/post/request_schema.json#/propertyNames/examples/security-data-fqdn-prefixParcelGlobalDefault"},"PolicyobjectlisttypePostPortList":{"$ref":"schema/profileparcel/sdwan/policy-object/security-port/post/request_schema.json#/propertyNames/examples/PortList"},"PolicyobjectlisttypePostsecurity-localappParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localapp/post/request_schema.json#/propertyNames/examples/security-localappParcelGlobalDefault"},"PolicyobjectlisttypePostsecurity-localdomainParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localdomain/post/request_schema.json#/propertyNames/examples/security-localdomainParcelGlobalDefault"},"PolicyobjectlisttypePostsecurity-ipssignatureParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-ipssignature/post/request_schema.json#/propertyNames/examples/security-ipssignatureParcelGlobalDefault"},"PolicyobjectlisttypePostUrlList":{"$ref":"schema/profileparcel/sdwan/policy-object/security-urllist/post/request_schema.json#/propertyNames/examples/UrlList"},"PolicyobjectlisttypePostsecurity-protocolnameParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-protocolname/post/request_schema.json#/propertyNames/examples/security-protocolnameParcelGlobalDefault"},"PolicyobjectlisttypePostGeolocationParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-geolocation/post/request_schema.json#/propertyNames/examples/GeolocationParcelGlobalDefault"},"PolicyobjectlisttypePosttestIdentityList":{"$ref":"schema/profileparcel/sdwan/policy-object/security-identity/post/request_schema.json#/propertyNames/examples/testIdentityList"},"PolicyobjectlisttypePostsecurity-scalablegrouptagParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-scalablegrouptag/post/request_schema.json#/propertyNames/examples/security-scalablegrouptagParcelGlobalDefault"},"PolicyobjectlisttypePostzoneList1":{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/post/request_schema.json#/propertyNames/examples/zoneList1"},"PolicyobjectlisttypePostzoneList2":{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/post/request_schema.json#/propertyNames/examples/zoneList2"},"PolicyobjectlisttypePostcentralized-appListParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/app-list/post/request_schema.json#/propertyNames/examples/centralized-appListParcelGlobalDefault"},"PolicyobjectlisttypePostcentralized-slaclassParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/sla-class/post/request_schema.json#/propertyNames/examples/centralized-slaclassParcelGlobalDefault"},"PolicyobjectlisttypePostIpv6DataPrefixList":{"$ref":"schema/profileparcel/sdwan/policy-object/data-ipv6-prefix/post/request_schema.json#/propertyNames/examples/Ipv6DataPrefixList"},"PolicyobjectlisttypePostIpv4DataPrefixList":{"$ref":"schema/profileparcel/sdwan/policy-object/data-prefix/post/request_schema.json#/propertyNames/examples/Ipv4DataPrefixList"},"PolicyobjectlisttypePostmirrorList1":{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/post/request_schema.json#/propertyNames/examples/mirrorList1"},"PolicyobjectlisttypePostmirrorList2":{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/post/request_schema.json#/propertyNames/examples/mirrorList2"},"PolicyobjectlisttypePostPolicerList":{"$ref":"schema/profileparcel/sdwan/policy-object/policer/post/request_schema.json#/propertyNames/examples/PolicerList"},"PolicyobjectlisttypePostapp-probeParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/app-probe/post/request_schema.json#/propertyNames/examples/app-probeParcelGlobalDefault"},"PolicyobjectlisttypePosttlocParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/tloc/post/request_schema.json#/propertyNames/examples/tlocParcelGlobalDefault"},"PolicyobjectlisttypePostcolorParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/color/post/request_schema.json#/propertyNames/examples/colorParcelGlobalDefault"},"PolicyobjectlisttypePostpreferred-color-groupParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/preferred-color-group/post/request_schema.json#/propertyNames/examples/preferred-color-groupParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-write,Feature Profile > Policy Object > Security FQDN Prefix-write,Feature Profile > Policy Object > Security Port-write,Feature Profile > Policy Object > Security Zone-write,Feature Profile > Policy Object > Security Local App-write,Feature Profile > Policy Object > Security Local Domain-write,Feature Profile > Policy Object > Security IPS Signature-write,Feature Profile > Policy Object > Security URL List-write,Feature Profile > Policy Object > Security Protocol Name-write,Feature Profile > Policy Object > Security Geo Location-write,Feature Profile > Policy Object > Security Identity-write,Feature Profile > Policy Object > Security Scalable Group Tag-write,Feature Profile > Policy Object > As Path-write,Feature Profile > Policy Object > Class-write,Feature Profile > Policy Object > Data Ipv6-write,Feature Profile > Policy Object > Data Prefix-write,Feature Profile > Policy Object > Community-write,Feature Profile > Policy Object > Ext Community-write,Feature Profile > Policy Object > Ipv6 Prefix-write,Feature Profile > Policy Object > Mirror-write,Feature Profile > Policy Object > Policer-write,Feature Profile > Policy Object > Prefix-write,Feature Profile > Policy Object > Standard Community-write,Feature Profile > Policy Object > VPN Group-write,Feature Profile > Policy Object > App List-write,Feature Profile > Policy Object > SLA Class-write,Feature Profile > Policy Object > App Probe-write,Feature Profile > Policy Object > TLOC-write,Feature Profile > Policy Object > Color List-write,Feature Profile > Policy Object > Preferred Color Group-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/{policyObjectListType}/{listObjectId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Data Prefix Profile Parcel by parcelId for Policy Object feature profile","operationId":"GetDataPrefixProfileParcelByParcelIdForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"listObjectId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-read,Feature Profile > Policy Object > Security FQDN Prefix-read,Feature Profile > Policy Object > Security Port-read,Feature Profile > Policy Object > Security Zone-read,Feature Profile > Policy Object > Security Local App-read,Feature Profile > Policy Object > Security Local Domain-read,Feature Profile > Policy Object > Security IPS Signature-read,Feature Profile > Policy Object > Security URL List-read,Feature Profile > Policy Object > Security Protocol Name-read,Feature Profile > Policy Object > Security Geo Location-read,Feature Profile > Policy Object > Security Identity-read,Feature Profile > Policy Object > Security Scalable Group Tag-read,Feature Profile > Policy Object > As Path-read,Feature Profile > Policy Object > Class-read,Feature Profile > Policy Object > Data Ipv6-read,Feature Profile > Policy Object > Data Prefix-read,Feature Profile > Policy Object > Community-read,Feature Profile > Policy Object > Ext Community-read,Feature Profile > Policy Object > Ipv6 Prefix-read,Feature Profile > Policy Object > Mirror-read,Feature Profile > Policy Object > Policer-read,Feature Profile > Policy Object > Prefix-read,Feature Profile > Policy Object > Standard Community-read,Feature Profile > Policy Object > VPN Group-read,Feature Profile > Policy Object > App List-read,Feature Profile > Policy Object > SLA Class-read,Feature Profile > Policy Object > Color List-read,Feature Profile > Policy Object > App Probe-read,Feature Profile > Policy Object > TLOC-read,Feature Profile > Policy Object > Preferred Color Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Data Prefix Profile Parcel for Policy Object feature profile","operationId":"EditDataPrefixProfileParcelForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"listObjectId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Data Prefix Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedPolicyobjectlisttypePut"},"examples":{"PolicyobjectlisttypePutsecurity-data-ip-prefixParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-data-ip-prefix/put/request_schema.json#/propertyNames/examples/security-data-ip-prefixParcelGlobalDefault"},"PolicyobjectlisttypePutsecurity-data-fqdn-prefixParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-fqdn/put/request_schema.json#/propertyNames/examples/security-data-fqdn-prefixParcelGlobalDefault"},"PolicyobjectlisttypePutPortList":{"$ref":"schema/profileparcel/sdwan/policy-object/security-port/put/request_schema.json#/propertyNames/examples/PortList"},"PolicyobjectlisttypePutsecurity-localappParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localapp/put/request_schema.json#/propertyNames/examples/security-localappParcelGlobalDefault"},"PolicyobjectlisttypePutsecurity-localdomainParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localdomain/put/request_schema.json#/propertyNames/examples/security-localdomainParcelGlobalDefault"},"PolicyobjectlisttypePutsecurity-ipssignatureParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-ipssignature/put/request_schema.json#/propertyNames/examples/security-ipssignatureParcelGlobalDefault"},"PolicyobjectlisttypePutUrlList":{"$ref":"schema/profileparcel/sdwan/policy-object/security-urllist/put/request_schema.json#/propertyNames/examples/UrlList"},"PolicyobjectlisttypePutsecurity-protocolnameParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-protocolname/put/request_schema.json#/propertyNames/examples/security-protocolnameParcelGlobalDefault"},"PolicyobjectlisttypePutGeolocationParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-geolocation/put/request_schema.json#/propertyNames/examples/GeolocationParcelGlobalDefault"},"PolicyobjectlisttypePuttestIdentityList":{"$ref":"schema/profileparcel/sdwan/policy-object/security-identity/put/request_schema.json#/propertyNames/examples/testIdentityList"},"PolicyobjectlisttypePutsecurity-scalablegrouptagParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/security-scalablegrouptag/put/request_schema.json#/propertyNames/examples/security-scalablegrouptagParcelGlobalDefault"},"PolicyobjectlisttypePutzoneList1":{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/put/request_schema.json#/propertyNames/examples/zoneList1"},"PolicyobjectlisttypePutzoneList2":{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/put/request_schema.json#/propertyNames/examples/zoneList2"},"PolicyobjectlisttypePutcentralized-applistParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/app-list/put/request_schema.json#/propertyNames/examples/centralized-applistParcelGlobalDefault"},"PolicyobjectlisttypePutcentralized-slaclassParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/sla-class/put/request_schema.json#/propertyNames/examples/centralized-slaclassParcelGlobalDefault"},"PolicyobjectlisttypePutclassMapList1":{"$ref":"schema/profileparcel/sdwan/policy-object/class/put/request_schema.json#/propertyNames/examples/classMapList1"},"PolicyobjectlisttypePutIpv6DataPrefixList":{"$ref":"schema/profileparcel/sdwan/policy-object/data-ipv6-prefix/put/request_schema.json#/propertyNames/examples/Ipv6DataPrefixList"},"PolicyobjectlisttypePutIpv4DataPrefixList":{"$ref":"schema/profileparcel/sdwan/policy-object/data-prefix/put/request_schema.json#/propertyNames/examples/Ipv4DataPrefixList"},"PolicyobjectlisttypePutmirrorList1":{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/put/request_schema.json#/propertyNames/examples/mirrorList1"},"PolicyobjectlisttypePutmirrorList2":{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/put/request_schema.json#/propertyNames/examples/mirrorList2"},"PolicyobjectlisttypePutPolicerList":{"$ref":"schema/profileparcel/sdwan/policy-object/policer/put/request_schema.json#/propertyNames/examples/PolicerList"},"PolicyobjectlisttypePutapp-probeParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/app-probe/put/request_schema.json#/propertyNames/examples/app-probeParcelGlobalDefault"},"PolicyobjectlisttypePuttlocParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/tloc/put/request_schema.json#/propertyNames/examples/tlocParcelGlobalDefault"},"PolicyobjectlisttypePutcolorParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/color/put/request_schema.json#/propertyNames/examples/colorParcelGlobalDefault"},"PolicyobjectlisttypePutpreferred-color-groupParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/policy-object/preferred-color-group/put/request_schema.json#/propertyNames/examples/preferred-color-groupParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-write,Feature Profile > Policy Object > Security FQDN Prefix-write,Feature Profile > Policy Object > Security Port-write,Feature Profile > Policy Object > Security Zone-write,Feature Profile > Policy Object > Security Local App-write,Feature Profile > Policy Object > Security Local Domain-write,Feature Profile > Policy Object > Security IPS Signature-write,Feature Profile > Policy Object > Security URL List-write,Feature Profile > Policy Object > Security Protocol Name-write,Feature Profile > Policy Object > Security Geo Location-write,Feature Profile > Policy Object > Security Identity-write,Feature Profile > Policy Object > Security Scalable Group Tag-write,Feature Profile > Policy Object > As Path-write,Feature Profile > Policy Object > Class-write,Feature Profile > Policy Object > Data Ipv6-write,Feature Profile > Policy Object > Data Prefix-write,Feature Profile > Policy Object > Community-write,Feature Profile > Policy Object > Ext Community-write,Feature Profile > Policy Object > Ipv6 Prefix-write,Feature Profile > Policy Object > Mirror-write,Feature Profile > Policy Object > Policer-write,Feature Profile > Policy Object > Prefix-write,Feature Profile > Policy Object > Standard Community-write,Feature Profile > Policy Object > VPN Group-write,Feature Profile > Policy Object > App List-write,Feature Profile > Policy Object > SLA Class-write,Feature Profile > Policy Object > App Probe-write,Feature Profile > Policy Object > TLOC-write,Feature Profile > Policy Object > Color List-write,Feature Profile > Policy Object > Preferred Color Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Data Prefix Profile Parcel for Policy Object feature profile","operationId":"DeleteDataPrefixProfileParcelForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"listObjectId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-write,Feature Profile > Policy Object > Security FQDN Prefix-write,Feature Profile > Policy Object > Security Port-write,Feature Profile > Policy Object > Security Zone-write,Feature Profile > Policy Object > Security Local App-write,Feature Profile > Policy Object > Security Local Domain-write,Feature Profile > Policy Object > Security IPS Signature-write,Feature Profile > Policy Object > Security URL List-write,Feature Profile > Policy Object > Security Protocol Name-write,Feature Profile > Policy Object > Security Geo Location-write,Feature Profile > Policy Object > Security Identity-write,Feature Profile > Policy Object > Security Scalable Group Tag-write,Feature Profile > Policy Object > As Path-write,Feature Profile > Policy Object > Class-write,Feature Profile > Policy Object > Data Ipv6-write,Feature Profile > Policy Object > Data Prefix-write,Feature Profile > Policy Object > Community-write,Feature Profile > Policy Object > Ext Community-write,Feature Profile > Policy Object > Ipv6 Prefix-write,Feature Profile > Policy Object > Mirror-write,Feature Profile > Policy Object > Policer-write,Feature Profile > Policy Object > Prefix-write,Feature Profile > Policy Object > Standard Community-write,Feature Profile > Policy Object > VPN Group-write,Feature Profile > Policy Object > App List-write,Feature Profile > Policy Object > SLA Class-write,Feature Profile > Policy Object > App Probe-write,Feature Profile > Policy Object > TLOC-write,Feature Profile > Policy Object > Color List-write,Feature Profile > Policy Object > Preferred Color Group-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectListType}/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN PolicyObject DataPrefix Parcel Schema by Schema Type","operationId":"GetSdwanPolicyObjectDataPrefixParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-read,Feature Profile > Policy Object > Security FQDN Prefix-read,Feature Profile > Policy Object > Security Port-read,Feature Profile > Policy Object > Security Zone-read,Feature Profile > Policy Object > Security Local App-read,Feature Profile > Policy Object > Security Local Domain-read,Feature Profile > Policy Object > Security IPS Signature-read,Feature Profile > Policy Object > Security URL List-read,Feature Profile > Policy Object > Security Protocol Name-read,Feature Profile > Policy Object > Security Geo Location-read,Feature Profile > Policy Object > Security Identity-read,Feature Profile > Policy Object > Security Scalable Group Tag-read,Feature Profile > Policy Object > As Path-read,Feature Profile > Policy Object > Class-read,Feature Profile > Policy Object > Data Ipv6-read,Feature Profile > Policy Object > Data Prefix-read,Feature Profile > Policy Object > Community-read,Feature Profile > Policy Object > Ext Community-read,Feature Profile > Policy Object > Ipv6 Prefix-read,Feature Profile > Policy Object > Mirror-read,Feature Profile > Policy Object > Policer-read,Feature Profile > Policy Object > Prefix-read,Feature Profile > Policy Object > Standard Community-read,Feature Profile > Policy Object > VPN Group-read,Feature Profile > Policy Object > App List-read,Feature Profile > Policy Object > SLA Class-read,Feature Profile > Policy Object > Color List-read,Feature Profile > Policy Object > App Probe-read,Feature Profile > Policy Object > TLOC-read,Feature Profile > Policy Object > Preferred Color Group-read"}},"/v1/feature-profile/sdwan/service":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanServiceFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Service Feature Profile","operationId":"CreateSdwanServiceFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-write"}},"/v1/feature-profile/sdwan/service/dhcp-server/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service DhcpServer Parcel Schema by Schema Type","operationId":"GetSdwanServiceDhcpServerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service LanVpn InterfaceEthernet Schema by Schema Type","operationId":"GetSdwanServiceLanVpnInterfaceEthernetParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/gre/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service LanVpn InterfaceGre Schema by Schema Type","operationId":"GetCedgeServiceLanVpnInterfaceGreSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/ipsec/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service LanVpn InterfaceIpsec Schema by Schema Type","operationId":"getSdwanProfileParcelSchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service LanVpn InterfaceSvi Schema by Schema Type","operationId":"GetCedgeServiceLanVpnInterfaceSviParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service LanVpn Parcel Schema by Schema Type","operationId":"GetSdwanServiceLanVpnParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"}},"/v1/feature-profile/sdwan/service/routing/bgp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service RoutingBgp Parcel Schema by Schema Type","operationId":"GetSdwanServiceRoutingBgpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-read"}},"/v1/feature-profile/sdwan/service/routing/multicast/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service RoutingMulticast Parcel Schema by Schema Type","operationId":"GetSdwanServiceRoutingMulticastParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-read"}},"/v1/feature-profile/sdwan/service/switchport/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service Switchport Parcel Schema by Schema Type","operationId":"GetCedgeServiceSwitchportParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-read"}},"/v1/feature-profile/sdwan/service/tracker/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service Tracker Parcel Schema by Schema Type","operationId":"GetSdwanServiceTrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-read"}},"/v1/feature-profile/sdwan/service/trackergroup/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service TrackerGroup Parcel Schema by Schema Type","operationId":"GetCedgeServiceTrackerGroupParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-read"}},"/v1/feature-profile/sdwan/service/wirelesslan/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a sdwan Service Wirelesslan Parcel Schema by Schema Type","operationId":"GetSdwanServiceWirelesslanParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-read"}},"/v1/feature-profile/sdwan/service/{serviceId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service Feature Profile with serviceId","operationId":"GetSdwanServiceFeatureProfileByProfileId","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Service Feature Profile","operationId":"EditSdwanServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/appqoe":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Appqoe Profile Parcels for Service feature profile","operationId":"GetAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Appqoe Profile Parcel for Service feature profile","operationId":"CreateAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Appqoe Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/appqoe/common/request_schema.json"},"examples":{"AppqoeFeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/appqoe/common/request_schema.json#/propertyNames/examples/AppqoeFeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/appqoe/{appqoeId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Appqoe Profile Parcel by parcelId for Service feature profile","operationId":"GetAppqoeProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"appqoeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Appqoe Profile Parcel for Service feature profile","operationId":"EditAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"appqoeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Appqoe Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/appqoe/common/request_schema.json"},"examples":{"AppqoeFeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/appqoe/common/request_schema.json#/propertyNames/examples/AppqoeFeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Appqoe Profile Parcel for Service feature profile","operationId":"DeleteAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"appqoeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Dhcp Server Profile Parcels for Service feature profile","operationId":"GetDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Dhcp Server Profile Parcel for Service feature profile","operationId":"CreateDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dhcp Server Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/dhcp-server/post/request_schema.json"},"examples":{"Default_DHCP_Server_Parcel":{"$ref":"schema/profileparcel/sdwan/service/dhcp-server/post/request_schema.json#/propertyNames/examples/Default_DHCP_Server_Parcel"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Dhcp Server Profile Parcel by parcelId for Service feature profile","operationId":"GetDhcpServerProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Dhcp Server Profile Parcel for Service feature profile","operationId":"EditDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dhcp Server Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/dhcp-server/put/request_schema.json"},"examples":{"Default_DHCP_Server_Parcel":{"$ref":"schema/profileparcel/sdwan/service/dhcp-server/put/request_schema.json#/propertyNames/examples/Default_DHCP_Server_Parcel"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Dhcp Server Profile Parcel for Service feature profile","operationId":"DeleteDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Lan Vpn Profile Parcels for Service feature profile","operationId":"GetLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Lan Vpn Profile Parcel for Service feature profile","operationId":"CreateLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/post/request_schema.json"},"examples":{"Cedge_CG1_Service_Lan_Vpn_Feature":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Lan_Vpn_Feature"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Lan Vpn Profile Parcel by parcelId for Service feature profile","operationId":"GetLanVpnProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Lan Vpn Profile Parcel for Service feature profile","operationId":"EditLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/put/request_schema.json"},"examples":{"Cedge_CG1_Service_Lan_Vpn_Feature":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Lan_Vpn_Feature"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Lan Vpn Profile Parcel for Service feature profile","operationId":"DeleteLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceEthernet Parcels for service LanVpn Parcel","operationId":"GetInterfaceEthernetParcelsForServiceLanVpn","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceEthernet parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/post/request_schema.json"},"examples":{"ServiceLanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/post/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceEthernetParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"LanVpn Interface Ethernet Parcel For Service Feature Profile":{"description":"LanVpn Interface Ethernet Parcel For Service Feature Profile","value":{"data":{"shutdown":{"optionType":"global","value":false},"interfaceName":{"optionType":"variable","variableName":"{{lan_int_0}}"},"description":{"optionType":"global","value":"LAN Interface - LocalInternetAccessforGuestUsersInterface"},"nat":{"optionType":"default","value":false},"dhcpHelper":{"optionType":"global","value":["5.6.7.8"]},"intfIpAddress":{"static":{"staticIpV4AddressPrimary":{"ipAddress":{"optionType":"global","value":"4.4.4.4"},"subnetMask":{"optionType":"global","value":"255.255.255.0"}},"staticIpV4AddressSecondary":[{"ipAddress":{"optionType":"global","value":"5.5.5.5"},"subnetMask":{"optionType":"global","value":"255.255.255.0"}},{"ipAddress":{"optionType":"global","value":"6.6.6.6"},"subnetMask":{"optionType":"global","value":"255.255.255.0"}}]}},"intfIpV6Address":{"static":{"primaryIpV6Address":{"address":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.6/24"}},"secondaryIpV6Address":[{"address":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.7/24"}},{"address":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.8/24"}}],"dhcpHelperV6":[{"ipAddress":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.9"},"vpn":{"optionType":"default"}},{"ipAddress":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.10"},"vpn":{"optionType":"global","value":1}}]}},"natIpv6":{"optionType":"global","value":true},"natAttributesIpv6":{"nat64":{"optionType":"global","value":false},"nat66":{"optionType":"global","value":true},"staticNat66":[{"sourcePrefix":{"optionType":"global","value":"0:0:0:0:0:0:192.168.12.11/24"},"translatedSourcePrefix":{"optionType":"global","value":"0:0:0:0:0:0:192.168.12.12/24"},"sourceVpnId":{"optionType":"global","value":1}}]},"advanced":{"ipMtu":{"optionType":"default","value":1500},"arpTimeout":{"optionType":"default","value":1200},"loadInterval":{"optionType":"default","value":30},"ipDirectedBroadcast":{"optionType":"default","value":false}},"vrrp":[],"vrrpIpv6":[{"optionalRow":{"optionType":"global","value":false},"groupId":{"optionType":"global","value":2},"priority":{"optionType":"global","value":100},"timer":{"optionType":"global","value":100},"trackOmp":{"optionType":"global","value":true},"ipv6":[{"ipv6LinkLocal":{"optionType":"global","value":"fe80::1"},"prefix":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.13/24"}}]}]},"name":"LocalInternetAccessforGuestUsersInterface","description":"LocalInternetAccessforGuestUsersInterface"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceEthernet Parcel by ethernetId for service feature profile","operationId":"GetLanVpnInterfaceEthernetParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn InterfaceEthernet Parcel for service feature profile","operationId":"EditLanVpnInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/put/request_schema.json"},"examples":{"ServiceLanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/put/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceEthernetParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceEthernet Parcel for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated DhcpServer Parcels for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated DhcpServer Parcel by dhcpServerId for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceEthernet parcel and a DhcpServer Parcel association for service feature profile","operationId":"EditLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceEthernet and a DhcpServer Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetAndDhcpServerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated Tracker Parcels for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated Tracker Parcel by trackerId for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceEthernet parcel and a Tracker Parcel association for service feature profile","operationId":"EditLanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceEthernet and a Tracker Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetAndTrackerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated TrackerGroup Parcels for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerGroupParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated TrackerGroup Parcel by trackergroupId for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceEthernet parcel and a TrackerGroup Parcel association for service feature profile","operationId":"EditLanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceEthernet and a TrackerGroup Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetAndTrackerGroupAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/gre":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceGre for service LanVpn","operationId":"GetInterfaceGresForServiceLanVpn","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceGre for service feature profile","operationId":"CreateLanVpnInterfaceGreForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Gre","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/gre/common/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/gre/common/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/gre/{greId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceGre by greId for service feature profile","operationId":"GetLanVpnInterfaceGreByIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Gre ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn InterfaceGre Feature for service feature profile","operationId":"EditLanVpnInterfaceGreForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Gre","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/gre/common/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/gre/common/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceGre for service feature profile","operationId":"DeleteLanVpnInterfaceGreForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Gre ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceIpsec Parcels for Service LanVpn Parcel","operationId":"getListOfProfileParcels","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceIpsec parcel for service feature profile","operationId":"createIpSecProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ipsec Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ipsec/common/request_schema.json"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ipsec/common/request_schema.json#/propertyNames/examples/WANVPNInterfaceIpsecParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"LanVpn Interface Ipsec Parcel For Service Feature Profile":{"description":"LanVpn Interface Ipsec Parcel For Service Feature Profile"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceIpsec Parcel by ethernetId for Service feature profile","operationId":"getProfileParcelByParcelId","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn Interface Ipsec Parcel for Service feature profile","operationId":"editProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Ipsec Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ipsec/common/request_schema.json"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ipsec/common/request_schema.json#/propertyNames/examples/WANVPNInterfaceIpsecParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceIpsec Parcel for Service feature profile","operationId":"deleteProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec/{ipsecId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceIpsec associated DhcpServer Parcels for service feature profile","operationId":"GetLanVpnInterfaceIpsecAssociatedDhcpServerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec/{ipsecId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceIpsec associated DhcpServer Parcel by dhcpServerId for service feature profile","operationId":"GetLanVpnInterfaceIpsecAssociatedDhcpServerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceIpsec parcel and a DhcpServer Parcel association for service feature profile","operationId":"EditLanVpnInterfaceIpsecAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceIpsec and a DhcpServer Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceIpsecAndDhcpServerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceSvi Parcels for service LanVpn Parcel","operationId":"GetInterfaceSviParcelsForServiceLanVpn","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi,Feature Profile > Service > Lan/Vpn/Interface/Svi-write"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceSvi parcel for service feature profile","operationId":"CreateLanVpnInterfaceSviParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Svi Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/svi/post/request_schema.json"},"examples":{"ServiceLanVpnInterfaceSviParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/svi/post/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceSviParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceSvi Parcel by sviId for service feature profile","operationId":"GetLanVpnInterfaceSviParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn InterfaceSvi Parcel for service feature profile","operationId":"EditLanVpnInterfaceSviParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Svi Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/svi/put/request_schema.json"},"examples":{"ServiceLanVpnInterfaceSviParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/svi/put/request_schema.json#/propertyNames/examples/ServiceLanVpnInterfaceSviParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceSvi Parcel for service feature profile","operationId":"DeleteLanVpnInterfaceSviForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceSvi associated DhcpServer Parcels for service feature profile","operationId":"GetLanVpnInterfaceSviAssociatedDhcpServerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceSvi associated DhcpServer Parcel by dhcpServerId for service feature profile","operationId":"GetLanVpnInterfaceSviAssociatedDhcpServerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceSvi parcel and a DhcpServer Parcel association for service feature profile","operationId":"EditLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceSvi and a DhcpServer Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceSviAndDhcpServerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Bgp Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingBgpParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn parcel with a routingbgp Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingBgpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated RoutingBgp Parcel by bgpId for service feature profile","operationId":"GetLanVpnAssociatedRoutingBgpParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn parcel and a RoutingBgp Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingBgpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn parcel and a RoutingBgp Parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingBgpAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/eigrp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Eigrp Features for service feature profile","operationId":"GetLanVpnAssociatedRoutingEigrpParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn feature with a routingeigrp Feature for service feature profile","operationId":"CreateLanVpnAndRoutingEigrpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/eigrp/{eigrpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn feature associated RoutingEigrp Feature by eigrpId for service feature profile","operationId":"GetLanVpnAssociatedRoutingEigrpParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Routing Eigrp Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn feature and a RoutingEigrp Feature association for service feature profile","operationId":"EditLanVpnAndRoutingEigrpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Routing Eigrp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn feature and a RoutingEigrp Feature association for service feature profile","operationId":"DeleteLanVpnAndRoutingEigrpAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Routing Eigrp Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/multicast":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Multicast Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingMulticastParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn parcel with a routingmulticast Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingMulticastParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/multicast/{multicastId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated RoutingMulticast Parcel by multicastId for service feature profile","operationId":"GetLanVpnAssociatedRoutingMulticastParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Routing Multicast Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn parcel and a RoutingMulticast Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingMulticastParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Routing Multicast ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn parcel and a RoutingMulticast Parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingMulticastAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Routing Multicast Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Ospf Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn parcel with a routingospf Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingOspfParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated RoutingOspf Parcel by ospfId for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn parcel and a RoutingOspf Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingOspfParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn parcel and a RoutingOspf Parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingOspfAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated IPv4 address family OSPFv3 Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv4ParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LAN VPN parcel with a IPv4 address family OSPFv3 Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingOspfv3IPv4ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv4 address family OSPFv3 Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated IPv4 address family OSPFv3 IPv4 Parcel by ospfv3Id for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv4ParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 Address Family OSPFv3 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LAN VPN parcel and a routing OSPFv3 IPv4 Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingOspfv3IPv4ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 address family OSPFv3 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv4 address family OSPFv3 Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LAN VPN parcel and a IPv4 OSPFv3 parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingOspfv3AssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 Address Family OSPFv3 IPv4 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated IPv6 address family OSPFv3 Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv6ParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LAN VPN parcel with a IPv6 address family OSPFv3 Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingOspfv3IPv6ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 address family OSPFv3 Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated IPv6 address family OSPFv3 IPv6 Parcel by ospfv3Id for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv6ParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv6 Address Family OSPFv3 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LAN VPN parcel and a routing OSPFv3 IPv6 Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingOspfv3IPv6ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv6 address family OSPFv3 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 address family OSPFv3 Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LAN VPN parcel and a IPv6 OSPFv3 parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingOspfv3AssociationForService_1","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv6 Address Family OSPFv3 IPv6 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceEthernet parcel with a DhcpServer Parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceEthernet parcel with a Tracker Parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceEthernet parcel with a TrackerGroup Parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ipsec/{ipsecId}/dhcp-server":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceIpsec parcel with a DhcpServer Parcel for service feature profile","operationId":"CreateLanVpnInterfaceIpsecAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceSvi parcel with a DhcpServer Parcel for service feature profile","operationId":"CreateLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcels for Service feature profile","operationId":"GetRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Bgp Profile Parcel for Service feature profile","operationId":"CreateRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/routing/bgp/common/request_schema.json"},"examples":{"ServiceBgpParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/routing/bgp/common/request_schema.json#/propertyNames/examples/ServiceBgpParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingBgpProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Bgp Profile Parcel for Service feature profile","operationId":"EditRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/routing/bgp/common/request_schema.json"},"examples":{"ServiceBgpParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/routing/bgp/common/request_schema.json#/propertyNames/examples/ServiceBgpParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Bgp Profile Parcel for Service feature profile","operationId":"DeleteRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/eigrp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Eigrp Profile Features for Service feature profile","operationId":"GetRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Eigrp Profile Feature for Service feature profile","operationId":"CreateRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/routing/eigrp/common/request_schema.json"},"examples":{"eigrpFeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/routing/eigrp/common/request_schema.json#/propertyNames/examples/eigrpFeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/eigrp/{eigrpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Eigrp Profile Feature by parcelId for Service feature profile","operationId":"GetRoutingEigrpProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Eigrp Profile Feature for Service feature profile","operationId":"EditRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/routing/eigrp/common/request_schema.json"},"examples":{"eigrpFeatureGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/routing/eigrp/common/request_schema.json#/propertyNames/examples/eigrpFeatureGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Eigrp Profile Feature for Service feature profile","operationId":"DeleteRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/multicast":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Multicast Profile Parcels for Service feature profile","operationId":"GetRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Multicast Profile Parcel for Service feature profile","operationId":"CreateRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/routing/multicast/common/request_schema.json"},"examples":{"ServiceMulticastParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/routing/multicast/common/request_schema.json#/propertyNames/examples/ServiceMulticastParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/multicast/{multicastId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Multicast Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingMulticastProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Multicast Profile Parcel for Service feature profile","operationId":"EditRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/routing/multicast/common/request_schema.json"},"examples":{"ServiceMulticastParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/routing/multicast/common/request_schema.json#/propertyNames/examples/ServiceMulticastParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Multicast Profile Parcel for Service feature profile","operationId":"DeleteRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcels for Service feature profile","operationId":"GetRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Ospf Profile Parcel for Service feature profile","operationId":"CreateRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json#/propertyNames/examples/ServiceOspfParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingOspfProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Ospf Profile Parcel for Service feature profile","operationId":"EditRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json#/propertyNames/examples/ServiceOspfParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Ospf Profile Parcel for Service feature profile","operationId":"DeleteRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv4 Address Family Profile Parcels for Service feature profile","operationId":"GetRoutingOspfv3Ipv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing OSPFv3 IPv4 Address Family Profile Parcel for Service feature profile","operationId":"CreateRoutingOspfv3Ipv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv4_AF"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv4 Address Family Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingOspfv3IPv4AfProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing OSPFv3 IPv4 Address Family Profile Parcel for Service feature profile","operationId":"EditRoutingOspfv3IPv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv4_AF"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing OSPFv3 IPv4 Address Family Profile Parcel for Service feature profile","operationId":"DeleteRoutingOspfv3IPv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv6 Address Family Profile Parcels for Service feature profile","operationId":"GetRoutingOspfv3Ipv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing OSPFv3 IPv6 Address Family Profile Parcel for Service feature profile","operationId":"CreateRoutingOspfv3Ipv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv6"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv6 Address Family Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingOspfv3IPv6AfProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing OSPFv3 IPv6 Address Family Profile Parcel for Service feature profile","operationId":"EditRoutingOspfv3IPv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv6"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing OSPFv3 IPv6 Address Family Profile Parcel for Service feature profile","operationId":"DeleteRoutingOspfv3IPv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/switchport":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Switchport Parcels for service feature profile","operationId":"GetSwitchportParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a switchport Parcel to a service feature profile","operationId":"CedgeServiceProfileSwitchportParcelRestfulResource","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Feature Profile Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/switchport/post/request_schema.json"},"examples":{"SwitchPortParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/switchport/post/request_schema.json#/propertyNames/examples/SwitchPortParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Switchport Parcel by switchportId for service feature profile","operationId":"GetSwitchportParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchportId","in":"path","description":"Switchport Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Switchport Parcel association for service feature profile","operationId":"EditSwitchportParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchportId","in":"path","description":"Switchport ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Switchport Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/switchport/put/request_schema.json"},"examples":{"SwitchPortParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/switchport/put/request_schema.json#/propertyNames/examples/SwitchPortParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Switchport Parcel for service feature profile","operationId":"DeleteSwitchportProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchportId","in":"path","description":"Switchport Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcels for Service feature profile","operationId":"GetTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Tracker Profile Parcel for Service feature profile","operationId":"CreateTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/tracker/common/request_schema.json"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"schema/profileparcel/sdwan/service/tracker/common/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Tracker_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcel by parcelId for Service feature profile","operationId":"GetTrackerProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Tracker Profile Parcel for Service feature profile","operationId":"EditTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/tracker/common/request_schema.json"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"schema/profileparcel/sdwan/service/tracker/common/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Tracker_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Tracker Profile Parcel for Service feature profile","operationId":"DeleteTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcels for Service feature profile","operationId":"GetTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a TrackerGroup Profile Parcel for Service feature profile","operationId":"CreateTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/propertyNames/examples/common_track_group_cedge_parcel_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcel by parcelId for Service feature profile","operationId":"GetTrackerGroupProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a TrackerGroup Profile Parcel for Service feature profile","operationId":"EditTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/propertyNames/examples/common_track_group_cedge_parcel_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a TrackerGroup Profile Parcel for Service feature profile","operationId":"DeleteTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wirelesslan Profile Parcels for Service feature profile","operationId":"GetWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Wirelesslan Profile Parcel for Service feature profile","operationId":"CreateWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wirelesslan Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/wirelesslan/post/request_schema.json"},"examples":{"wirelessParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/wirelesslan/post/request_schema.json#/propertyNames/examples/wirelessParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wirelesslan Profile Parcel by parcelId for Service feature profile","operationId":"GetWirelesslanProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wirelesslanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Wirelesslan Profile Parcel for Service feature profile","operationId":"EditWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wirelesslanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wirelesslan Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/service/wirelesslan/put/request_schema.json"},"examples":{"wirelessParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/service/wirelesslan/put/request_schema.json#/propertyNames/examples/wirelessParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Wirelesslan Profile Parcel for Service feature profile","operationId":"DeleteWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wirelesslanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-write"}},"/v1/feature-profile/sdwan/sig-security":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanSigSecurityFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Sig Security Feature Profile","operationId":"CreateSdwanSigSecurityFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-write"}},"/v1/feature-profile/sdwan/sig-security/{sigSecurityId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Sig Security Feature Profile with sigSecurityId","operationId":"GetSdwanSigSecurityFeatureProfileByProfileId","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Sig Security Feature Profile","operationId":"EditSdwanSigSecurityFeatureProfile","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanSigSecurityFeatureProfile","parameters":[{"name":"sigSecurityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-write"}},"/v1/feature-profile/sdwan/sig-security/{sigSecurityId}/sig":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Sig Security Profile Parcels for a given ParcelType","operationId":"GetSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Sig Security Policy","operationId":"CreateSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/sig-security/sig/post/request_schema.json"},"examples":{"SIG":{"$ref":"schema/profileparcel/sdwan/sig-security/sig/post/request_schema.json#/propertyNames/examples/SIG"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-write"}},"/v1/feature-profile/sdwan/sig-security/{sigSecurityId}/sig/{sigSecurityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get SigSecurity Profile Parcel by parcelId","operationId":"GetSigSecurityProfileParcelByParcelId_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"sigSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Sig Security Profile Parcel","operationId":"EditSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"sigSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/sig-security/sig/put/request_schema.json"},"examples":{"SIG":{"$ref":"schema/profileparcel/sdwan/sig-security/sig/put/request_schema.json#/propertyNames/examples/SIG"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a SigSecurity Profile Parcel ","operationId":"DeleteSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"sigSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-write"}},"/v1/feature-profile/sdwan/system":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanSystemFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN System Feature Profile","operationId":"CreateSdwanSystemFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-write"}},"/v1/feature-profile/sdwan/system/aaa/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Aaa Parcel Schema by Schema Type","operationId":"GetSdwanSystemAaaParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-read"}},"/v1/feature-profile/sdwan/system/banner/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Banner Parcel Schema by Schema Type","operationId":"GetSdwanSystemBannerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-read"}},"/v1/feature-profile/sdwan/system/basic/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Basic Feature Schema by Schema Type","operationId":"GetSdwanSystemBasicFeatureSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-read"}},"/v1/feature-profile/sdwan/system/bfd/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Bfd Parcel Schema by Schema Type","operationId":"GetSdwanSystemBfdParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-read"}},"/v1/feature-profile/sdwan/system/global/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge System Global Parcel Schema by Schema Type","operationId":"GetCedgeSystemGlobalParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-read"}},"/v1/feature-profile/sdwan/system/logging/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Logging Parcel Schema by Schema Type","operationId":"GetSdwanSystemLoggingParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-read"}},"/v1/feature-profile/sdwan/system/mrf/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge System Mrf Parcel Schema by Schema Type","operationId":"GetCedgeSystemMrfParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-read"}},"/v1/feature-profile/sdwan/system/ntp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Ntp Parcel Schema by Schema Type","operationId":"GetSdwanSystemNtpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-read"}},"/v1/feature-profile/sdwan/system/omp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Omp Parcel Schema by Schema Type","operationId":"GetSdwanSystemOmpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-read"}},"/v1/feature-profile/sdwan/system/snmp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Snmp Parcel Schema by Schema Type","operationId":"GetSdwanSystemSnmpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-read"}},"/v1/feature-profile/sdwan/system/{systemId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Feature Profile with systemId","operationId":"GetSdwanSystemFeatureProfileByProfileId","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN System Feature Profile","operationId":"EditSdwanSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-write"}},"/v1/feature-profile/sdwan/system/{systemId}/aaa":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Aaa Profile Parcels for System feature profile","operationId":"GetAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Aaa Profile Parcel for System feature profile","operationId":"CreateAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Aaa Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/aaa/post/request_schema.json"},"examples":{"CedgeSystemAAAParcelConfig":{"$ref":"schema/profileparcel/sdwan/system/aaa/post/request_schema.json#/propertyNames/examples/CedgeSystemAAAParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-write"}},"/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Aaa Profile Parcel by parcelId for System feature profile","operationId":"GetAaaProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Aaa Profile Parcel for System feature profile","operationId":"EditAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Aaa Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/aaa/put/request_schema.json"},"examples":{"CedgeSystemAAAParcelConfig":{"$ref":"schema/profileparcel/sdwan/system/aaa/put/request_schema.json#/propertyNames/examples/CedgeSystemAAAParcelConfig"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Aaa Profile Parcel for System feature profile","operationId":"DeleteAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-write"}},"/v1/feature-profile/sdwan/system/{systemId}/banner":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Banner Profile Parcels for System feature profile","operationId":"GetBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Banner Profile Parcel for System feature profile","operationId":"CreateBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/banner/post/request_schema.json"},"examples":{"SystemBannerParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/banner/post/request_schema.json#/propertyNames/examples/SystemBannerParcelGlobalDefault"},"SystemBannerParcelVariable":{"$ref":"schema/profileparcel/sdwan/system/banner/post/request_schema.json#/propertyNames/examples/SystemBannerParcelVariable"},"SystemBannerParcelDefaultGlobal":{"$ref":"schema/profileparcel/sdwan/system/banner/post/request_schema.json#/propertyNames/examples/SystemBannerParcelDefaultGlobal"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-write"}},"/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Banner Profile Parcel by parcelId for System feature profile","operationId":"GetBannerProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Banner Profile Parcel for System feature profile","operationId":"EditBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/banner/put/request_schema.json"},"examples":{"SystemBannerParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/banner/put/request_schema.json#/propertyNames/examples/SystemBannerParcelGlobalDefault"},"SystemBannerParcelVariable":{"$ref":"schema/profileparcel/sdwan/system/banner/put/request_schema.json#/propertyNames/examples/SystemBannerParcelVariable"},"SystemBannerParcelDefaultGlobal":{"$ref":"schema/profileparcel/sdwan/system/banner/put/request_schema.json#/propertyNames/examples/SystemBannerParcelDefaultGlobal"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Banner Profile Parcel for System feature profile","operationId":"DeleteBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-write"}},"/v1/feature-profile/sdwan/system/{systemId}/basic":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Basic Profile Feature for System feature profile","operationId":"GetBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Basic Profile Feature for System feature profile","operationId":"CreateBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/basic/post/request_schema.json"},"examples":{"Cedge_CG1_System_basic_parcel1":{"$ref":"schema/profileparcel/sdwan/system/basic/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_basic_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-write"}},"/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Basic Profile Feature by FeatureId for System feature profile","operationId":"GetBasicProfileFeatureByFeatureIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"basicId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Basic Profile Feature for System feature profile","operationId":"EditBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"basicId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/basic/put/request_schema.json"},"examples":{"Cedge_CG1_System_basic_parcel1":{"$ref":"schema/profileparcel/sdwan/system/basic/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_basic_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Basic Profile Feature for System feature profile","operationId":"DeleteBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"basicId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-write"}},"/v1/feature-profile/sdwan/system/{systemId}/bfd":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Bfd Profile Parcels for System feature profile","operationId":"GetBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Bfd Profile Parcel for System feature profile","operationId":"CreateBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Bfd Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/bfd/post/request_schema.json"},"examples":{"SystemBfdParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/bfd/post/request_schema.json#/propertyNames/examples/SystemBfdParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-write"}},"/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Bfd Profile Parcel by parcelId for System feature profile","operationId":"GetBfdProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bfdId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Bfd Profile Parcel for System feature profile","operationId":"EditBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bfdId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Bfd Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/bfd/put/request_schema.json"},"examples":{"SystemBfdParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/bfd/put/request_schema.json#/propertyNames/examples/SystemBfdParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Bfd Profile Parcel for System feature profile","operationId":"DeleteBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bfdId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-write"}},"/v1/feature-profile/sdwan/system/{systemId}/global":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Global Profile Parcels for System feature profile","operationId":"GetGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Global Profile Parcel for System feature profile","operationId":"CreateGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/global/post/request_schema.json"},"examples":{"Cedge_CG1_System_Globalsettings_parcel1":{"$ref":"schema/profileparcel/sdwan/system/global/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Globalsettings_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post request example":{"description":"post request example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-write"}},"/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Global Profile Parcel by parcelId for System feature profile","operationId":"GetGlobalProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Global Profile Parcel for System feature profile","operationId":"EditGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/global/put/request_schema.json"},"examples":{"Cedge_CG1_System_Globalsettings_parcel1":{"$ref":"schema/profileparcel/sdwan/system/global/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Globalsettings_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Global Profile Parcel for System feature profile","operationId":"DeleteGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-write"}},"/v1/feature-profile/sdwan/system/{systemId}/logging":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Logging Profile Parcels for System feature profile","operationId":"GetLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Logging Profile Parcel for System feature profile","operationId":"CreateLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/logging/post/request_schema.json"},"examples":{"Cedge_CG1_System_Logging_parcel1":{"$ref":"schema/profileparcel/sdwan/system/logging/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Logging_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-write"}},"/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Logging Profile Parcel by parcelId for System feature profile","operationId":"GetLoggingProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Logging Profile Parcel for System feature profile","operationId":"EditLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/logging/put/request_schema.json"},"examples":{"Cedge_CG1_System_Logging_parcel1":{"$ref":"schema/profileparcel/sdwan/system/logging/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_Logging_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Logging Profile Parcel for System feature profile","operationId":"DeleteLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-write"}},"/v1/feature-profile/sdwan/system/{systemId}/mrf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Mrf Profile Parcels for System feature profile","operationId":"GetMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Mrf Profile Parcel for System feature profile","operationId":"CreateMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Mrf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/mrf/common/request_schema.json"},"examples":{"SystemMrfParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/mrf/common/request_schema.json#/propertyNames/examples/SystemMrfParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-write"}},"/v1/feature-profile/sdwan/system/{systemId}/mrf/{mrfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Mrf Profile Parcel by parcelId for System feature profile","operationId":"GetMrfProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"mrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Mrf Profile Parcel for System feature profile","operationId":"EditMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"mrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Mrf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/mrf/common/request_schema.json"},"examples":{"SystemMrfParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/mrf/common/request_schema.json#/propertyNames/examples/SystemMrfParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Mrf Profile Parcel for System feature profile","operationId":"DeleteMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"mrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-write"}},"/v1/feature-profile/sdwan/system/{systemId}/ntp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ntp Profile Parcels for System feature profile","operationId":"GetNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Ntp Profile Parcel for System feature profile","operationId":"CreateNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ntp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/ntp/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/sdwan/system/ntp/post/request_schema.json#/propertyNames/examples/example_1"},"ntp_parcel_post1":{"$ref":"schema/profileparcel/sdwan/system/ntp/post/request_schema.json#/propertyNames/examples/ntp_parcel_post1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ntp Profile Parcel by parcelId for System feature profile","operationId":"GetNtpProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Ntp Profile Parcel for System feature profile","operationId":"EditNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ntp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/ntp/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/sdwan/system/ntp/put/request_schema.json#/propertyNames/examples/example_1"},"ntp_parcel_put1":{"$ref":"schema/profileparcel/sdwan/system/ntp/put/request_schema.json#/propertyNames/examples/ntp_parcel_put1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Ntp Profile Parcel for System feature profile","operationId":"DeleteNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/omp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Omp Profile Parcels for System feature profile","operationId":"GetOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Omp Profile Parcel for System feature profile","operationId":"CreateOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Omp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/omp/post/request_schema.json"},"examples":{"Cedge_CG1_System_omp_parcel1":{"$ref":"schema/profileparcel/sdwan/system/omp/post/request_schema.json#/propertyNames/examples/Cedge_CG1_System_omp_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Omp Profile Parcel by parcelId for System feature profile","operationId":"GetOmpProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ompId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Omp Profile Parcel for System feature profile","operationId":"EditOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ompId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Omp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/omp/put/request_schema.json"},"examples":{"Cedge_CG1_System_omp_parcel1":{"$ref":"schema/profileparcel/sdwan/system/omp/put/request_schema.json#/propertyNames/examples/Cedge_CG1_System_omp_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Omp Profile Parcel for System feature profile","operationId":"DeleteOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ompId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/security":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security for System feature profile","operationId":"GetSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Security for System feature profile","operationId":"CreateSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/security/common/request_schema.json"},"examples":{"Security":{"$ref":"schema/profileparcel/sdwan/system/security/common/request_schema.json#/propertyNames/examples/Security"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post request example":{"description":"post request example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-write"}},"/v1/feature-profile/sdwan/system/{systemId}/security/{securityId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security by securityId for System feature profile","operationId":"GetSecurityBySecurityIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityId","in":"path","description":"Security ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update Security for System feature profile","operationId":"EditSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityId","in":"path","description":"Security ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/security/common/request_schema.json"},"examples":{"Security":{"$ref":"schema/profileparcel/sdwan/system/security/common/request_schema.json#/propertyNames/examples/Security"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Security for System feature profile","operationId":"DeleteSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityId","in":"path","description":"Security ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-write"}},"/v1/feature-profile/sdwan/system/{systemId}/snmp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Snmp Profile Parcels for System feature profile","operationId":"GetSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Snmp Profile Parcel for System feature profile","operationId":"CreateSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Snmp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/snmp/post/request_schema.json"},"examples":{"SNMPParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/snmp/post/request_schema.json#/propertyNames/examples/SNMPParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Snmp Profile Parcel by parcelId for System feature profile","operationId":"GetSnmpProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Snmp Profile Parcel for System feature profile","operationId":"EditSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Snmp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/system/snmp/put/request_schema.json"},"examples":{"SNMPParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/system/snmp/put/request_schema.json#/propertyNames/examples/SNMPParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Snmp Profile Parcel for System feature profile","operationId":"DeleteSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-write"}},"/v1/feature-profile/sdwan/transport":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanTransportFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Transport Feature Profile","operationId":"CreateSdwanTransportFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"},"FeatureProfile-System-ConfigGroup1-COPY":{"$ref":"schema/featureprofile/common/post/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-write"}},"/v1/feature-profile/sdwan/transport/cellular-controller/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport CellularController Parcel Schema by Schema Type","operationId":"GetSdwanTransportCellularControllerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"}},"/v1/feature-profile/sdwan/transport/cellular-profile/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport CellularProfile Parcel Schema by Schema Type","operationId":"GetSdwanTransportCellularProfileParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-read"}},"/v1/feature-profile/sdwan/transport/ipv6-tracker/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport IPv6 Tracker Parcel Schema by Schema Type","operationId":"GetSdwanTransportIpv6TrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-read"}},"/v1/feature-profile/sdwan/transport/ipv6-trackergroup/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport IPv6 TrackerGroup Parcel Schema by Schema Type","operationId":"GetCedgeTransportIpv6TrackerGroupParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-read"}},"/v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport ManagementVpn InterfaceEthernet Schema by Schema Type","operationId":"GetSdwanTransportManagementVpnInterfaceEthernetParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/management/vpn/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport ManagementVpn Parcel Schema by Schema Type","operationId":"GetSdwanTransportManagementVpnParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-read"}},"/v1/feature-profile/sdwan/transport/routing/bgp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport RoutingBgp Parcel Schema by Schema Type","operationId":"GetSdwanTransportRoutingBgpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-read"}},"/v1/feature-profile/sdwan/transport/t1-e1-controller/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport T1e1controller Parcel Schema by Schema Type","operationId":"GetCedgeTransportT1e1controllerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-read"}},"/v1/feature-profile/sdwan/transport/tracker/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport Tracker Parcel Schema by Schema Type","operationId":"GetSdwanTransportTrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-read"}},"/v1/feature-profile/sdwan/transport/trackergroup/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport TrackerGroup Parcel Schema by Schema Type","operationId":"GetCedgeTransportTrackerGroupParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn CellularInterface Schema by Schema Type","operationId":"GetSdwanTransportWanVpnCellularInterfaceParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn InterfaceEthernet Schema by Schema Type","operationId":"GetSdwanTransportWanVpnInterfaceEthernetParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/gre/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport WanVpn InterfaceGre Schema by Schema Type","operationId":"GetCedgeTransportWanVpnInterfaceGreParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/ipsec/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn InterfaceIpsec Schema by Schema Type","operationId":"getSdwanProfileParcelSchema_1","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/serial/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport WanVpn InterfaceSerial Schema by Schema Type","operationId":"GetCedgeTransportWanVpnInterfaceSerialParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn Parcel Schema by Schema Type","operationId":"GetSdwanTransportWanVpnParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"}},"/v1/feature-profile/sdwan/transport/{transportId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport Feature Profile with transportId","operationId":"GetSdwanTransportFeatureProfileByProfileId","parameters":[{"name":"transportId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Transport Feature Profile","operationId":"EditSdwanTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/request_schema.json"},"examples":{"FeatureProfile-System-ConfigGroup1-NY":{"$ref":"schema/featureprofile/common/put/request_schema.json#/propertyNames/examples/FeatureProfile-System-ConfigGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/featureprofile/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/featureprofile/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Controller Profile Parcels for Transport feature profile","operationId":"GetCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Cellular Controller Profile Parcel for Transport feature profile","operationId":"CreateCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/cellular-controller/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_CellularController_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/cellular-controller/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularController_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Controller Profile Parcel by parcelId for Transport feature profile","operationId":"GetCellularControllerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Cellular Controller Profile Parcel for Transport feature profile","operationId":"EditCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/cellular-controller/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_CellularController_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/cellular-controller/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularController_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Cellular Controller Profile Parcel for Transport feature profile","operationId":"DeleteCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController associated Cellular Profile Parcels for transport feature profile","operationId":"GetCellularControllerAssociatedCellularProfileParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a cellularcontroller parcel with a cellularprofile Parcel for transport feature profile","operationId":"CreateCellularControllerAndCellularProfileParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Cellular Controller Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController parcel associated CellularProfile Parcel by cellularProfileId for transport feature profile","operationId":"GetCellularControllerAssociatedCellularProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Cellular Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a CellularController parcel and a CellularProfile Parcel association for transport feature profile","operationId":"EditCellularControllerAndCellularProfileParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Cellular Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a CellularController parcel and a CellularProfile Parcel association for transport feature profile","operationId":"DeleteCellularControllerAndCellularProfileAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Cellular Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/gps":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController associated Gps Parcels for transport feature profile","operationId":"GetCellularControllerAssociatedGpsParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a cellularcontroller parcel with a gps Parcel for transport feature profile","operationId":"CreateCellularControllerAndGpsParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Cellular Controller Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/gps/{gpsId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController parcel associated Gps Parcel by gpsId for transport feature profile","operationId":"GetCellularControllerAssociatedGpsParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Gps Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a CellularController parcel and a Gps Parcel association for transport feature profile","operationId":"EditCellularControllerAndGpsParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Gps ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a CellularController parcel and a Gps Parcel association for transport feature profile","operationId":"DeleteCellularControllerAndGpsAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Gps Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Profile Profile Parcels for Transport feature profile","operationId":"GetCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Cellular Profile Profile Parcel for Transport feature profile","operationId":"CreateCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/cellular-profile/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_CellularProfile_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/cellular-profile/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularProfile_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Profile Profile Parcel by parcelId for Transport feature profile","operationId":"GetCellularProfileProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Cellular Profile Profile Parcel for Transport feature profile","operationId":"EditCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/cellular-profile/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_CellularProfile_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/cellular-profile/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularProfile_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Cellular Profile Profile Parcel for Transport feature profile","operationId":"DeleteCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-controller":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get eSim Cellular Controller Features for Transport feature profile","operationId":"GetEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a eSim Cellular Controller Feature for Transport feature profile","operationId":"CreateEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"eSim Cellular Controller Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-controller/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_eSimCellularController_feature1Esim":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-controller/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_eSimCellularController_feature1Esim"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-controller/{esimCellularControllerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get eSim Cellular Controller Feature by Feature Id for Transport feature profile","operationId":"GetEsimCellularControllerProfileFeatureByFeatureIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularControllerId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a eSim Cellular Controller Feature for Transport feature profile","operationId":"EditEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularControllerId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Controller Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-controller/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_eSimCellularController_feature1Esim":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-controller/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_eSimCellularController_feature1Esim"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a eSim Cellular Controller Feature for Transport feature profile","operationId":"DeleteEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularControllerId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-profile":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get EsimCellular Profile Features for Transport feature profile","operationId":"GetEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a EsimCellular Profile Feature for Transport feature profile","operationId":"CreateEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-profile/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_CellularProfile_feature1_eSim":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-profile/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularProfile_feature1_eSim"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-profile/{esimCellularProfileId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get EsimCellular Profile Feature by Feature Id for Transport feature profile","operationId":"GetEsimCellularProfileByFeatureIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularProfileId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a EsimCellular Profile Feature for Transport feature profile","operationId":"EditEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularProfileId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-profile/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_CellularProfile_feature1_eSim":{"$ref":"schema/profileparcel/sdwan/transport/esimcellular-profile/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_CellularProfile_feature1_eSim"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a EsimCellular Profile Feature for Transport feature profile","operationId":"DeleteEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularProfileId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/gps":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Gps Profile Parcels for Transport feature profile","operationId":"GetGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Gps Profile Parcel for Transport feature profile","operationId":"CreateGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/gps/post/request_schema.json"},"examples":{"gpsParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/gps/post/request_schema.json#/propertyNames/examples/gpsParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/gps/{gpsId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Gps Profile Parcel by parcelId for Transport feature profile","operationId":"GetGpsProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Gps Profile Parcel for Transport feature profile","operationId":"EditGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/gps/put/request_schema.json"},"examples":{"gpsParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/gps/put/request_schema.json#/propertyNames/examples/gpsParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Gps Profile Parcel for Transport feature profile","operationId":"DeleteGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 Tracker Profile Parcels for Transport feature profile","operationId":"GetIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a IPv6 Tracker Profile Parcel for Transport feature profile","operationId":"CreateIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-tracker/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_Tracker_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-tracker/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Tracker_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-tracker/{ipv6-trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 Tracker Profile Parcel by parcelId for Transport feature profile","operationId":"GetIpv6TrackerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a IPv6 Tracker Profile Parcel for Transport feature profile","operationId":"EditIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-tracker/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_Tracker_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-tracker/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Tracker_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a IPv6 Tracker Profile Parcel for Transport feature profile","operationId":"DeleteIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 TrackerGroup Profile Parcels for Transport feature profile","operationId":"GetIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a IPv6 TrackerGroup Profile Parcel for Transport feature profile","operationId":"CreateIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-trackergroup/common/request_schema.json"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-trackergroup/common/request_schema.json#/propertyNames/examples/common_track_group_cedge_parcel_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-trackergroup/{ipv6-trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 TrackerGroup Profile Parcel by parcelId for Transport feature profile","operationId":"GetIpv6TrackerGroupProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"IPv6 Tracker Group Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a IPv6 TrackerGroup Profile Parcel for Transport feature profile","operationId":"EditIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-trackergroup/common/request_schema.json"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-trackergroup/common/request_schema.json#/propertyNames/examples/common_track_group_cedge_parcel_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a IPv6 TrackerGroup Profile Parcel for Transport feature profile","operationId":"DeleteIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"IPv6 Tracker Group Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Management Vpn Profile Parcels for Transport feature profile","operationId":"GetManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Management Vpn Profile Parcel for Transport feature profile","operationId":"CreateManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_Management_Vpn_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Management_Vpn_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Management Vpn Profile Parcel by parcelId for Transport feature profile","operationId":"GetManagementVpnProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Management Vpn Profile Parcel for Transport feature profile","operationId":"EditManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_Management_Vpn_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Management_Vpn_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Management Vpn Profile Parcel for Transport feature profile","operationId":"DeleteManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceEthernet Parcels for transport ManagementVpn Parcel","operationId":"GetInterfaceEthernetParcelsForTransportManagementVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a ManagementVpn InterfaceEthernet parcel for transport feature profile","operationId":"CreateManagementVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/post/request_schema.json"},"examples":{"TransportManagementVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/post/request_schema.json#/propertyNames/examples/TransportManagementVpnInterfaceEthernetParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get ManagementVpn InterfaceEthernet Parcel by ethernetId for transport feature profile","operationId":"GetManagementVpnInterfaceEthernetParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a ManagementVpn InterfaceEthernet Parcel for transport feature profile","operationId":"EditManagementVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/put/request_schema.json"},"examples":{"TransportManagementVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/put/request_schema.json#/propertyNames/examples/TransportManagementVpnInterfaceEthernetParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a ManagementVpn InterfaceEthernet Parcel for transport feature profile","operationId":"DeleteManagementVpnInterfaceEthernetForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcels for Transport feature profile","operationId":"GetRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Bgp Profile Parcel for Transport feature profile","operationId":"CreateRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/routing/bgp/common/request_schema.json"},"examples":{"wan-bgp":{"$ref":"schema/profileparcel/sdwan/transport/routing/bgp/common/request_schema.json#/propertyNames/examples/wan-bgp"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcel by parcelId for Transport feature profile","operationId":"GetRoutingBgpProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Bgp Profile Parcel for Transport feature profile","operationId":"EditRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/routing/bgp/common/request_schema.json"},"examples":{"wan-bgp":{"$ref":"schema/profileparcel/sdwan/transport/routing/bgp/common/request_schema.json#/propertyNames/examples/wan-bgp"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Bgp Profile Parcel for Transport feature profile","operationId":"DeleteRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcels for Transport feature profile","operationId":"GetRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Ospf Profile Parcel for Transport feature profile","operationId":"CreateRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json#/propertyNames/examples/ServiceOspfParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcel by parcelId for Transport feature profile","operationId":"GetRoutingOspfProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Ospf Profile Parcel for Transport feature profile","operationId":"EditRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/common/routing/ospf/common/request_schema.json#/propertyNames/examples/ServiceOspfParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Ospf Profile Parcel for Transport feature profile","operationId":"DeleteRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all routing OSPFv3 IPv4 address family profile parcels for transport feature profile","operationId":"GetRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a routing OSPFv3 IPv4 address family profile parcel for transport feature profile","operationId":"CreateRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv4_AF"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get the routing OSPFv3 IPv4 address family profile parcel by ID for transport feature profile","operationId":"GetRoutingOspfv3Ipv4AfProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a routing OSPFv3 IPv4 address family profile parcel for transport feature profile","operationId":"EditRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv4/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv4_AF"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete the routing OSPFv3 IPv4 address family profile parcel by ID for transport feature profile","operationId":"DeleteRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all routing OSPFv3 IPv6 address family profile parcels for transport feature profile","operationId":"GetRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a routing OSPFv3 IPv6 address family profile parcel for transport feature profile","operationId":"CreateRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv6"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get the routing OSPFv3 IPv6 address family profile parcel by ID for transport feature profile","operationId":"GetRoutingOspfv3Ipv6AfProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a routing OSPFv3 IPv6 address family profile parcel for transport feature profile","operationId":"EditRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"schema/profileparcel/sdwan/common/routing/ospfv3/ipv6/common/request_schema.json#/propertyNames/examples/WAN_OSPFv3_IPv6"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete the routing OSPFv3 IPv6 address family profile parcel by ID for transport feature profile","operationId":"DeleteRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/t1-e1-controller":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get T1e1controller Profile Parcels for Transport feature profile","operationId":"GetT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a T1e1controller Profile Parcel for Transport feature profile","operationId":"CreateT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"T1e1controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/t1-e1-controller/common/request_schema.json"},"examples":{"t_controllerParcel1":{"$ref":"schema/profileparcel/sdwan/transport/t1-e1-controller/common/request_schema.json#/propertyNames/examples/t_controllerParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/t1-e1-controller/{t1e1controllerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get T1e1controller Profile Parcel by parcelId for Transport feature profile","operationId":"GetT1e1controllerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"t1e1controllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a T1e1controller Profile Parcel for Transport feature profile","operationId":"EditT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"t1e1controllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"T1e1controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/t1-e1-controller/common/request_schema.json"},"examples":{"t_controllerParcel1":{"$ref":"schema/profileparcel/sdwan/transport/t1-e1-controller/common/request_schema.json#/propertyNames/examples/t_controllerParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a T1e1controller Profile Parcel for Transport feature profile","operationId":"DeleteT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"t1e1controllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcels for Transport feature profile","operationId":"GetTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Tracker Profile Parcel for Transport feature profile","operationId":"CreateTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/tracker/common/request_schema.json"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/tracker/common/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Tracker_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcel by parcelId for Transport feature profile","operationId":"GetTrackerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Tracker Profile Parcel for Transport feature profile","operationId":"EditTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/tracker/common/request_schema.json"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/tracker/common/request_schema.json#/propertyNames/examples/Cedge_CG1_Service_Tracker_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Tracker Profile Parcel for Transport feature profile","operationId":"DeleteTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcels for Transport feature profile","operationId":"GetTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a TrackerGroup Profile Parcel for Transport feature profile","operationId":"CreateTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/propertyNames/examples/common_track_group_cedge_parcel_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcel by parcelId for Transport feature profile","operationId":"GetTrackerGroupProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a TrackerGroup Profile Parcel for Transport feature profile","operationId":"EditTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/propertyNames/examples/common_track_group_cedge_parcel_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a TrackerGroup Profile Parcel for Transport feature profile","operationId":"DeleteTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wan Vpn Profile Parcels for Transport feature profile","operationId":"GetWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Wan Vpn Profile Parcel for Transport feature profile","operationId":"CreateWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/post/request_schema.json"},"examples":{"Cedge_CG1_Transport_Wan_Vpn_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/post/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Wan_Vpn_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wan Vpn Profile Parcel by parcelId for Transport feature profile","operationId":"GetWanVpnProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Wan Vpn Profile Parcel for Transport feature profile","operationId":"EditWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/put/request_schema.json"},"examples":{"Cedge_CG1_Transport_Wan_Vpn_parcel1":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/put/request_schema.json#/propertyNames/examples/Cedge_CG1_Transport_Wan_Vpn_parcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Wan Vpn Profile Parcel for Transport feature profile","operationId":"DeleteWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Interface Cellular Parcels for transport Wan Vpn Parcel","operationId":"GetInterfaceCellularParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a wanvpn Cellular interface Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WanVpn Interface Cellular Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/post/request_schema.json"},"examples":{"TransportWanVpnInterfaceCellularParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/post/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceCellularParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"parcelId":{"description":"parcelId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-tracker/{ipv6-trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 Tracker Parcel by ipv6-trackerId for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceCellular parcel and a IPv6 Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceCellularAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceCellular and a IPv6 Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularAndIpv6TrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 TrackerGroup Parcels for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerGroupParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-trackergroup/{ipv6-trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 TrackerGroup Parcel by ipv6-trackergroupId for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceCellular parcel and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceCellularAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"IPv6 TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceCellular and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularAndIpv6TrackerGroupAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceCellular parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceCellular and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get wanvpn Cellular interface Parcel by intfId for transport feature profile","operationId":"GetWanVpnInterfaceCellularParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"intfId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a wanvpn Cellular Interface Parcel for transport feature profile","operationId":"EditWanVpnInterfaceCellularParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"intfId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WanVpn Cellular Interface Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/put/request_schema.json"},"examples":{"TransportWanVpnInterfaceCellularParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/put/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceCellularParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"parcelId":{"description":"parcelId","value":"some uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a wanvpn Cellular interface Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"intfId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceEthernet Parcels for transport WanVpn Parcel","operationId":"GetInterfaceEthernetParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceEthernet parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/post/request_schema.json"},"examples":{"TransportWanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/post/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceEthernetParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"WanVpn Interface Ethernet Parcel For Transport Feature Profile":{"description":"WanVpn Interface Ethernet Parcel For Transport Feature Profile","value":{"data":{"shutdown":{"optionType":"global","value":false},"interfaceName":{"optionType":"variable","variableName":"{{wan_int_0}}"},"description":{"optionType":"global","value":"WAN Interface - Internet"},"blockNonSourceIp":{"optionType":"default","value":false},"autoDetectBandwidth":{"optionType":"default","value":false},"tunnelInterface":{"optionType":"global","value":true},"tunnel":{"perTunnelQos":{"optionType":"default","value":false},"color":{"optionType":"default","value":"mpls"},"restrict":{"optionType":"default","value":false},"group":{"optionType":"default"},"border":{"optionType":"default","value":false},"maxControlConnections":{"optionType":"default"},"vBondAsStunServer":{"optionType":"default","value":false},"excludeControllerGroupList":{"optionType":"default"},"vManageConnectionPreference":{"optionType":"default","value":5},"portHop":{"optionType":"default","value":true},"lowBandwidthLink":{"optionType":"default","value":false},"tunnelTcpMss":{"optionType":"default"},"clearDontFragment":{"optionType":"default","value":false},"ctsSgtPropagation":{"optionType":"default","value":false},"networkBroadcast":{"optionType":"default","value":false}},"allowService":{"all":{"optionType":"default","value":false},"bgp":{"optionType":"default","value":false},"dhcp":{"optionType":"default","value":true},"ntp":{"optionType":"default","value":true},"ssh":{"optionType":"default","value":true},"dns":{"optionType":"default","value":true},"icmp":{"optionType":"default","value":true},"https":{"optionType":"default","value":true},"ospf":{"optionType":"default","value":false},"stun":{"optionType":"default","value":false},"snmp":{"optionType":"default","value":false},"netconf":{"optionType":"default","value":false},"bfd":{"optionType":"default","value":false}},"nat":{"optionType":"default","value":false},"intfIpAddress":{"static":{"staticIpV4AddressPrimary":{"ipAddress":{"optionType":"global","value":"3.3.3.3"},"subnetMask":{"optionType":"global","value":"255.255.255.0"}},"staticIpV4AddressSecondary":[{"ipAddress":{"optionType":"global","value":"1.1.1.1"},"subnetMask":{"optionType":"global","value":"255.255.255.0"}},{"ipAddress":{"optionType":"global","value":"2.2.2.2"},"subnetMask":{"optionType":"global","value":"255.255.255.0"}}]}},"dhcpHelper":{"optionType":"global","value":["1.2.3.4"]},"intfIpV6Address":{"static":{"primaryIpV6Address":{"address":{"optionType":"global","value":"1:1:1:1:1:1:192.168.12.1/24"}}}},"natIpv6":{"optionType":"global","value":true},"natAttributesIpv6":{"nat64":{"optionType":"global","value":false},"nat66":{"optionType":"global","value":true},"staticNat66":[{"sourcePrefix":{"optionType":"global","value":"0:0:0:0:0:0:192.168.12.5/24"},"translatedSourcePrefix":{"optionType":"global","value":"0:0:0:0:0:0:192.168.12.6/24"},"sourceVpnId":{"optionType":"global","value":0}}]},"encapsulation":[{"encap":{"optionType":"global","value":"ipsec"},"weight":{"optionType":"default","value":1},"preference":{"optionType":"default"}}]},"name":"Internet","description":"Internet"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceEthernet Parcel by ethernetId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceEthernet Parcel for transport feature profile","operationId":"EditWanVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/put/request_schema.json"},"examples":{"TransportWanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/put/request_schema.json#/propertyNames/examples/TransportWanVpnInterfaceEthernetParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceEthernet Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-tracker/{ipv6-trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 Tracker Parcel by ipv6-trackerId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a IPv6 Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a IPv6 Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndIpv6TrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 TrackerGroup Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerGroupParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-trackergroup/{ipv6-trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 TrackerGroup Parcel by ipv6-trackergroupId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndIpv6TrackerGroupAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated TrackerGroup Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerGroupParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated TrackerGroup Parcel by trackergroupId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a TrackerGroup Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a TrackerGroup Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndTrackerGroupAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceGre Parcels for transport WanVpn Parcel","operationId":"GetInterfaceGreParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceGre parcel for transport feature profile","operationId":"CreateWanVpnInterfaceGreParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Gre Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/gre/common/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/gre/common/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre/{greId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceGre Parcel by greId for transport feature profile","operationId":"GetWanVpnInterfaceGreParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceGre Parcel for transport feature profile","operationId":"EditWanVpnInterfaceGreParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Gre Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/gre/common/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/gre/common/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceGre Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceGreForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre/{greId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceGre associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceGreAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceGre parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceGreAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre/{greId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceGre associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceGreAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceGre parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceGreAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceGre and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceGreAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceIpsec Parcels for transport WanVpn Parcel","operationId":"getListOfProfileParcels_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceIpsec parcel for transport feature profile","operationId":"createIpSecProfileParcel_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ipsec/common/request_schema.json"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ipsec/common/request_schema.json#/propertyNames/examples/WANVPNInterfaceIpsecParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"WanVpn Interface Ipsec Parcel For Transport Feature Profile":{"description":"WanVpn Interface Ipsec Parcel For Transport Feature Profile"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceIpsec Parcel by ethernetId for transport feature profile","operationId":"getProfileParcelByParcelId_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceIpsec Parcel for transport feature profile","operationId":"editProfileParcel_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ipsec Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ipsec/common/request_schema.json"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ipsec/common/request_schema.json#/propertyNames/examples/WANVPNInterfaceIpsecParcelGlobalDefault"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceIpsec Parcel for transport feature profile","operationId":"deleteProfileParcel_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec/{ipsecId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceIpsec associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceIpsecAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec/{ipsecId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceIpsec associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceIpsecAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceIpsec parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceIpsecAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceIpsec and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceIpsecAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/serial":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceSerial Parcels for transport WanVpn Parcel","operationId":"GetInterfaceSerialParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceSerial parcel for transport feature profile","operationId":"CreateWanVpnInterfaceSerialParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Serial Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/serial/common/request_schema.json"},"examples":{"SerialParcel1":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/serial/common/request_schema.json#/propertyNames/examples/SerialParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/serial/{serialId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceSerial Parcel by serialId for transport feature profile","operationId":"GetWanVpnInterfaceSerialParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"serialId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceSerial Parcel for transport feature profile","operationId":"EditWanVpnInterfaceSerialParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"serialId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Serial Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/serial/common/request_schema.json"},"examples":{"SerialParcel1":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/serial/common/request_schema.json#/propertyNames/examples/SerialParcel1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"put response example":{"description":"put response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceSerial Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceSerialForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"serialId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn associated Routing Bgp Parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingBgpParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a wanvpn parcel with a routingbgp Parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingBgpParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Wan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn parcel associated RoutingBgp Parcel by bgpId for transport feature profile","operationId":"GetWanVpnAssociatedRoutingBgpParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingBgpParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingBgpAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn associated Routing Ospf Parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a wan/vpn parcel with a routing/ospf Parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingOspfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn parcel associated RoutingOspf Parcel by ospfId for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn parcel and a RoutingOspf Parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingOspfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn parcel and a RoutingOspf Parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingOspfAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN associated routing OSPFv3 IPv4 address family parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv4AfParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WAN VPN parcel with a routing OSPFv3 parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingOspfv3Ipv4AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"WAN Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4Address Family Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN parcel associated OSPFv3 IPv4 parcel by ID for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv4AfParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv4 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingOspfv3IPv4AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv4 Address Family parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingOspfv3IPv4AssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv4 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN associated routing OSPFv3 IPv6 address family parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv6AfParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WAN VPN parcel with a routing OSPFv3 parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingOspfv3Ipv6AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"WAN Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6Address Family Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN parcel associated OSPFv3 IPv6 parcel by ID for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv6AfParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv6 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingOspfv3IPv6AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv6 Address Family parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/put/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingOspfv3IPv6AssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv6 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/ipv6-tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceCellular parcel with a IPv6 Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/ipv6-trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceCellular parcel with a IPv6 TrackerGroup Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceCellular parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/ipv6-tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a IPv6 Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/ipv6-trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a IPv6 TrackerGroup Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a TrackerGroup Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ipsec/{ipsecId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceIpsec parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceIpsecAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/profileparcel/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/profileparcel/common/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/policy-group":{"get":{"tags":["Policy - Policy Group"],"description":"Get a Policy Group by Solution","operationId":"GetPolicyGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyGroup"}},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"},"post":{"tags":["Policy - Policy Group"],"description":"Create a new Policy Group","operationId":"CreatePolicyGroup","requestBody":{"description":"Policy Group","content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/post/request_schema.json"},"examples":{"CEDGE-PolicyGroup1-NY":{"$ref":"schema/policygroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-PolicyGroup1-NY"},"CEDGE-PolicyGroup1-COPY":{"$ref":"schema/policygroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-PolicyGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/post/response_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/policygroup/common/post/response_schema.json#/propertyNames/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Workflows-write,Policy Group-write"}},"/v1/policy-group/{policyGroupId}":{"get":{"tags":["Policy - Policy Group"],"description":"Get a Policy Group by ID","operationId":"GetPolicyGroup","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyGroup"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"},"put":{"tags":["Policy - Policy Group"],"description":"Edit a Policy Group","operationId":"EditPolicyGroup","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy Group","content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/put/request_schema.json"},"examples":{"CEDGE-PolicyGroup1-NY":{"$ref":"schema/policygroup/common/put/request_schema.json#/propertyNames/examples/CEDGE-PolicyGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/put/response_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/put/response_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/policygroup/common/put/response_schema.json#/propertyNames/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"},"delete":{"tags":["Policy - Policy Group"],"description":"Delete Policy Group","operationId":"DeletePolicyGroup","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"}},"/v1/policy-group/{policyGroupId}/device/associate":{"get":{"tags":["Policy - Policy Group"],"description":"Get devices association with a policy group","operationId":"GetPolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-read"},"put":{"tags":["Policy - Policy Group"],"description":"Move the devices from one policy group to another","operationId":"UpdatePolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/associate/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/associate/put/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/policygroup/common/associate/put/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-write"},"post":{"tags":["Policy - Policy Group"],"description":"Create associations with device and a policy group","operationId":"CreatePolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/associate/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/associate/post/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/policygroup/common/associate/post/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-write"},"delete":{"tags":["Policy - Policy Group"],"description":"Delete Policy Group Association from devices","operationId":"DeletePolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/associate/delete/request_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/associate/delete/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/policygroup/common/associate/delete/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-write"}},"/v1/policy-group/{policyGroupId}/device/deploy":{"post":{"tags":["Policy - Policy Group"],"description":"deploy policy group to devices","operationId":"deployPolicyGroup","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/deploy/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/deploy/post/request_schema.json#/propertyNames/examples/example_1"},"example_2":{"$ref":"schema/policygroup/common/deploy/post/request_schema.json#/propertyNames/examples/example_2"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/deploy/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/deploy/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device > Deploy-write"}},"/v1/policy-group/{policyGroupId}/device/variables":{"get":{"tags":["Policy - Policy Group"],"description":"Get device variables","operationId":"getPolicyGroupDeviceVariables","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}},{"name":"device-id","in":"query","description":"Comma separated device id's like d1,d2","schema":{"type":"string"}},{"name":"suggestions","in":"query","description":"Suggestions for possible values","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"},"put":{"tags":["Policy - Policy Group"],"description":"assign values to device variables","operationId":"createPolicyGroupDeviceVariables","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/variables/put/request_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/variables/put/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"},"post":{"tags":["Policy - Policy Group"],"description":"Fetch device variables","operationId":"fetchPolicyGroupDeviceVariables","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/variables/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/variables/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"}},"/v1/policy-group/{policyGroupId}/device/variables/schema":{"get":{"tags":["Policy - Policy Group"],"description":"get device variables schema","operationId":"getPolicyGroupDeviceVariablesSchema","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"}},"/v1/policy-group/{policyGroupId}/device/{deviceId}/preview":{"post":{"tags":["Policy - Policy Group"],"description":"Get a preview of the configuration for a device","operationId":"getPolicyGroupDeviceConfigurationPreview","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/policygroup/common/preview/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/policygroup/common/preview/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device > Deploy-read"}},"/v1/reports":{"get":{"tags":["Scheduled Report Management"],"summary":"Get all report templates information","description":"Get all reports information","operationId":"getAllReportTemplates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSummaryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Scheduled Report Management"],"summary":"Create a new report template","description":"create a new report template","operationId":"createReportTemplate","requestBody":{"description":"Report Template Config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutiveSummaryReport"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/preview/download":{"get":{"tags":["Scheduled Report Management"],"summary":"Download a report preview file","description":"Download a report preview file","operationId":"downloadReportPreviewFile","responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}":{"get":{"tags":["Scheduled Report Management"],"summary":"Get the report template information by report ID","description":"Get the report template information by report ID","operationId":"getReportTemplateById","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSummaryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Scheduled Report Management"],"summary":"Modify the report template configuration","description":"Update the report template by report ID","operationId":"updateReportTemplate","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"updated report config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutiveSummaryReport"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Scheduled Report Management"],"summary":"Delete the report template by report ID","description":"Delete the report template and all report files associated with it","operationId":"deleteReportTemplate","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/action/{action}":{"put":{"tags":["Scheduled Report Management"],"summary":"User operations for report template","description":"User operations for specific report template, which includes activate,deactivate and run immediately","operationId":"ReportAction","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"action","in":"path","required":true,"schema":{"type":"string","enum":["start","stop","runnow"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/tasks":{"get":{"tags":["Scheduled Report Management"],"summary":"Get all report tasks detail information by report ID","description":"Get all report task detail information by report ID","operationId":"getAllReportTasksByReportId","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTaskQueryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/tasks/{taskId}":{"delete":{"tags":["Scheduled Report Management"],"summary":"Delete generated report task file by task ID","description":"Delete the report task file by task ID","operationId":"deleteReportTaskByTaskId","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskIdResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/tasks/{taskId}/download":{"get":{"tags":["Scheduled Report Management"],"summary":"Download a report file","description":"Download a report file","operationId":"downloadReportDataFile","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/securedeviceonboarding/fetchSdoToken":{"post":{"tags":["Secure Device OnBoarding - SDO Token"],"description":"POST for fetching Secure Device Onboarding Token needed for Secure Device Onboarding APIs for eSim","operationId":"fetchSdoToken","requestBody":{"description":"Fetch SDO Token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailsForIdentityVerificationForSdoToken"},"examples":{"Request Payload Example for Fetching Secure Device Onboarding Token":{"description":"Request Payload Example for Fetching Secure Device Onboarding Token","value":{"sdoSessionId":"e01c5b71-b056-4602-b140-42221ccc3fec"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/getUrlForSdoIdentityService":{"get":{"tags":["Secure Device OnBoarding - SDO Token"],"description":"Get URL for Secure Device Onboarding Identity Service that generates Session ID required for authentication to get Secure Device Onboarding token","operationId":"getUrlForSdoIdentityService","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Get Secure Device Onboarding Identity Service Url Response Example":{"description":"Get Secure Device Onboarding Identity Service Url Response Example","value":{"sdoIdentityServiceUrl":"http://sdo.jasper.com"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/providercredentials":{"post":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Create service provider credentials","operationId":"createProviderCredentials","requestBody":{"description":"Create Provider Credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountDetails"},"examples":{"Service Provider Credentials":{"description":"Service Provider Credentials","value":{"carrierName":"Singtel","accountId":"100023372","accountUserName":"testaa","apiKey":"d6fa2f9-5a7d-4af8-8ab5-4056f631","isDefault":false,"acceptTermsAndConditions":true}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/providerscredentials":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get all providers credentials","operationId":"getAllAccounts","responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Service Providers Credentials Response Example":{"description":"Service Providers Credentials Response Example","value":[{"carrierName":"Singtel","accountId":"100023372","accountUserName":"testaa","apiKey":"d6fa2f9-5a7d-4af8-8ab5-4056f631","isDefault":false,"acceptTermsAndConditions":true}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/rateplans":{"get":{"tags":["Secure Device Onboarding - Rate Plans"],"description":"Get rate plans by account Id","operationId":"getRatePlansByAcctId","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Rate plans response example":{"description":"Rate plans response example","value":["QaAwtRP-180421030819","Monthly-Flexible-Pool","hphlr rp1"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/registeredproviders":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get Registered Providers Info","operationId":"getProvidersInfo","responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Registered Providers Response Example":{"description":"Registered Providers Response Example","value":"[{\"operatorName\":\"SingTel Test\",\"countryCode\":\"+1\",\"cmpUrl\":\"https://rws-jpotest.i.jasperwireless.com\",\"cmpType\":\"CC\",\" + \"\"contactInfoLine1\":\"3003 Bunker Hill lane \",\"contactInfoLine2\":\"$$$$$$$$$\",\"contactInfoLine3\":\"asdfv!!!!6578\",\"operatorLogoUrl\":\"https://jpotest.jasper.com/provision/logout\",\"termsAndConditions\":\"Do you accept our terms 1, If yes press Ok or Sorry you cannot use our service ,See you next time!!\"}]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/{accountId}/commplans":{"get":{"tags":["Secure Device Onboarding - Communication Plans"],"description":"Get communication plans by account Id","operationId":"getCommPlansByAcctId","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Communication plans response example":{"description":"Communication plans response example","value":"[ \n\t {\n\t \"commPlanName\": \"vm cp sms data shared\",\n\t \"apns\":[{\"name\":\"M2MTEST\"}]\n\t \"lteApns\":[]\n\t \"lteEnabled\":false\n\t }\n\t ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/{accountId}/providerCredentials":{"delete":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Delete provider credentials","operationId":"deleteProviderCredentials","parameters":[{"name":"accountId","in":"path","description":"Service User Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/{accountId}/providercredentials":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get provider credentials by account id","operationId":"getProviderCredentialsByAccountId","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Service Provider Credentials Response Example":{"description":"Service Provider Credentials Response Example","value":"{\n\t \"carrierName\": \"Singtel\",\n\t \"accountId\": \"100023372\",\n\t \"accountUserName\":\"testaa\" ,\n\t \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n\t \"isDefault\":true,\n\t \"acceptTermsAndConditions\":true,\n\t \"accountData\":{\n\t \"ratePlan\": \"vm fixed pool rp\",\n\t \"commPlan\": \"vm cp sms data shared\",\n\t \"apn\": \"123456789\",\n\t \"pdnType\": \"IPv4\",\n\t \"authType\": \"pap\",\n\t \"user\": \"admin\",\n\t \"password\": \"admin123\"\n\t }"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"},"put":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Edit service provider credentials","operationId":"editProviderCredentials","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Provider Credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountDetails"},"examples":{"Update Provider Credentials":{"description":"Update Provider Credentials","value":"{\n\t \"carrierName\": \"Singtel\",\n\t \"accountId\": \"100023372\",\n\t \"accountUserName\":\"testaa\" ,\n\t \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n\t \"isDefault\":true,\n\t \"acceptTermsAndConditions\":true,\n\t \"accountData\":{\n\t \"ratePlan\": \"vm fixed pool rp\",\n\t \"commPlan\": \"vm cp sms data shared\",\n\t \"apn\": \"123456789\",\n\t \"pdnType\": \"IPv4\",\n\t \"authType\": \"pap\",\n\t \"user\": \"admin\",\n\t \"password\": \"admin123\"\n\t }"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/{deviceUUID}/deviceusage":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get device data usage using device uuid","operationId":"getDeviceDataUsage","parameters":[{"name":"deviceUUID","in":"path","description":"DeviceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Device Usage Response Example":{"description":"Device Usage Response Example","value":"[{\n\t \"iccid\": \"8988216716970004975\",\n\t \"carrierName\": \"Singtel\",\n\t \"ratePlan\":\"hphlr rp1\" ,\n\t \"communicationPlan\": \"vm cp sms data shared\",\n\t \"ratePlanType\":\"Monthly - Pooled Subscriber\",\n\t \"currentDataUsage\":\"10MB\",\n\t \"ratePlanUsageLimit\": \"50MB\",\n\t \"otherEsimsDataUsage\": \"20MB\",\n\t }]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/topology-group":{"get":{"tags":["Topology - Topology Group"],"description":"Get a Topology Group by Solution","operationId":"GetTopologyGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopologyGroup"}},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-read"},"post":{"tags":["Topology - Topology Group"],"description":"Create a new Topology Group","operationId":"CreateTopologyGroup","requestBody":{"description":"Topology Group","content":{"application/json":{"schema":{"$ref":"schema/topologygroup/common/post/request_schema.json"},"examples":{"CEDGE-TopologyGroup1-NY":{"$ref":"schema/topologygroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-TopologyGroup1-NY"},"CEDGE-TopologyGroup1-COPY":{"$ref":"schema/topologygroup/common/post/request_schema.json#/propertyNames/examples/CEDGE-TopologyGroup1-COPY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"example":"TODO"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Workflows-write,Topology Group-write"}},"/v1/topology-group/{topologyGroupId}":{"get":{"tags":["Topology - Topology Group"],"description":"Get a Topology Group by ID","operationId":"GetTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopologyGroup"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-read"},"put":{"tags":["Topology - Topology Group"],"description":"Edit a Topology Group","operationId":"EditTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Topology Group","content":{"application/json":{"schema":{"$ref":"schema/topologygroup/common/put/request_schema.json"},"examples":{"CEDGE-TopologyGroup1-NY":{"$ref":"schema/topologygroup/common/put/request_schema.json#/propertyNames/examples/CEDGE-TopologyGroup1-NY"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"example":{"Solution":"Mobility","name":"Awesome Topology group"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-write"},"delete":{"tags":["Topology - Topology Group"],"description":"Delete Topology Group","operationId":"DeleteTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-write"}},"/v1/topology-group/{topologyGroupId}/device/deploy":{"post":{"tags":["Topology - Topology Group"],"description":"deploy Topology group to devices","operationId":"deployTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","description":"Topology Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/topologygroup/common/deploy/post/request_schema.json"},"examples":{}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/topologygroup/common/deploy/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/topologygroup/common/deploy/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group > Device > Activate-write"}},"/v1/topology-group/{topologyGroupId}/device/{deviceId}/preview":{"post":{"tags":["Topology - Topology Group"],"description":"Get a preview of the configuration for a device","operationId":"getTopologyGroupDeviceConfigurationPreview","parameters":[{"name":"topologyGroupId","in":"path","description":"Topology Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"schema/topologygroup/common/preview/post/request_schema.json"},"examples":{"example_1":{"$ref":"schema/topologygroup/common/preview/post/request_schema.json#/propertyNames/examples/example_1"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"schema/topologygroup/common/preview/post/response_schema.json"},"examples":{"example_1":{"$ref":"schema/topologygroup/common/preview/post/response_schema.json#/propertyNames/examples/example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group > Device > Activate-read"}},"/wani/recommendations":{"get":{"tags":["Wani Recommendations"],"summary":"Get multiple recommendations from vAnalytics","description":"Per tenant API to check the number of recommendations obtained from WANI for a given overlay/tenant. This should only return valid recommendations based on expiry. Filters out reccomendations that are state NON_APPLIED and not active and rec's that are state APPLY_REQUEST and are not active.","operationId":"getWaniRecommendations","parameters":[{"name":"siteId","in":"query","description":"The specific site id to get recommendations for, if empty get recommendations for all sites","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationsResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/wani/recommendations/applied":{"get":{"tags":["Wani Recommendations"],"summary":"Get recommendations that have been applied on vManage","description":"Per tenant api to check which Wani recommendations have been applied for a given tenant ","operationId":"getAppliedWaniRecommendations","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppliedRecommendationsRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/wani/{listType}/{listId}/listActivationStatus":{"get":{"tags":["Wani Recommendations"],"summary":"get if list is in activated wani policy","description":"Get if specified list is apart of a activated centralized policy, if it is the response also gives the centralized policy id, the users original defined centralized policy id, and if current list is apart of a active wani policy. ","operationId":"getListActivationStatus","parameters":[{"name":"listType","in":"path","required":true,"schema":{"type":"string"}},{"name":"listId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationStatusRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/wani/{policyType}/{policyId}/policyActivationStatus":{"get":{"tags":["Wani Recommendations"],"summary":"get if policy is in activated wani policy","description":"Get if specified policy is apart of a activated centralized policy, if it is the response also gives the centralized policy id, the users original defined centralized policy id, and if current policy is apart of a active wani policy. ","operationId":"getPolicyActivationStatus","parameters":[{"name":"policyType","in":"path","required":true,"schema":{"type":"string"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationStatusRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/accesscode":{"get":{"tags":["System - Cloud Service Webex"],"description":"Webex Access Code Details","operationId":"webexAccessCode","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessCodeResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/datacenter":{"post":{"tags":["System - Cloud Service Webex"],"description":"TEMP-Insert webex data center details manually for test setup","operationId":"getWebexDataCenters","requestBody":{"description":"Webex Data Center","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebexDataCenter"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["System - Cloud Service Webex"],"description":"Delete webex data center data in DB","operationId":"deleteWebexDataCenters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/datacenter/sync":{"post":{"tags":["System - Cloud Service Webex"],"description":"TEMP-Update webex data center data in DB with data from Webex API","operationId":"updateWebexDataCenters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/datacenter/syncstatus":{"get":{"tags":["System - Cloud Service Webex"],"description":"Get webex data center sync status from DB","operationId":"getWebexDataCentersSyncStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncStatusResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["System - Cloud Service Webex"],"description":"Set webex data center sync needed to false","operationId":"setWebexDataCentersSyncStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/redirect":{"get":{"tags":["System - Cloud Service Webex"],"description":"Redirect Info","operationId":"redirectWebexDataCenters","parameters":[{"name":"code","in":"query","description":"code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectCodeResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/workflow":{"get":{"tags":["Workflow - Management"],"description":"List all workflows for the given tenant","operationId":"getWorkflows","parameters":[{"name":"type","in":"query","schema":{"type":"string"}},{"name":"id","in":"query","schema":{"type":"string"}},{"name":"group-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Workflows":{"description":"Workflows","value":{"workflows":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Workflow - Management"],"description":"Saves the workflow","operationId":"saveWorkflow","requestBody":{"description":"Request to save already created workflow with given user context","content":{"application/json":{"schema":{"type":"object"},"examples":{"Workflow":{"description":"Workflow","value":{"id":"3f4aa8c0-1342-4a7d-846d-a9b209925d29","type":"ux_user_workflow","userContext":{"key1":"value1"},"activities":{"activity-1":{"type":"ux_user_workflow","userContext":{"key1":"value1"}}}}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Workflow - Management"],"description":"Creates a workflow in the system","operationId":"createWorkflow","requestBody":{"description":"Request to create workflow with given user context","content":{"application/json":{"schema":{"type":"object"},"examples":{"Workflow":{"description":"Workflow","value":{"type":"ux_user_workflow","userContext":{"key1":"value1"}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Workflow - Management"],"description":"Deletes the workflow","operationId":"deleteWorkflow","parameters":[{"name":"id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"APIKey":{"type":"object","properties":{"vipObjectType":{"type":"string","example":"object"},"vipType":{"type":"string","example":"constant"},"vipValue":{"type":"string","example":"sdfsd"},"vipVariableName":{"type":"string","example":"system_api_key"}},"description":"API secret information"},"APISecret":{"type":"object","properties":{"vipNeedsEncryption":{"type":"boolean","example":true},"vipObjectType":{"type":"string","example":"object"},"vipType":{"type":"string","example":"constant"},"vipValue":{"type":"string","example":"$CRYPT_CLUSTER$0y3Eq1EFF5Hurtda/Z9eHQ==$gtnBC/bVtpuhWX5r905iYw=="},"vipVariableName":{"type":"string","example":"system_api_secret"}},"description":"API key information"},"Aaa":{"type":"object","properties":{"accounting":{"type":"boolean"},"adminAuthOrder":{"type":"boolean"},"auditDisable":{"type":"boolean"},"authFallback":{"type":"boolean"},"authOrder":{"maxItems":3,"minItems":1,"type":"array","items":{"type":"string","enum":["local","radius","tacacs"]}}}},"AaaServerInfo":{"required":["aaaServersParcelId","radiusServerName"],"type":"object","properties":{"aaaServersParcelId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string"},"radiusServerName":{"type":"string"}}},"AccessCodeResponse":{"type":"object","properties":{"code":{"type":"string","example":"ZDI3MGEyYzQtNmFlNS00NDNhLWFlNzAtZGVjNjE0MGU1OGZmZWNmZDEwN2ItYTU"}}},"AccountData":{"required":["apn","authMethod","commPlan","pdnType","ratePlan"],"type":"object","properties":{"apn":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Access Point Name","example":"103334b644"},"authMethod":{"maxLength":2147483647,"minLength":1,"pattern":"(^none$|^pap$|^chap$|^pap_or_chap$)","type":"string","description":"Authentication method.","example":"pap"},"commPlan":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the communication plan associated with default provider.","example":"vm cp sms data shared"},"password":{"type":"string","description":"Password of the user.","example":"admin123"},"pdnType":{"maxLength":2147483647,"minLength":1,"pattern":"(^IPv4$|^IPv6$|^IPv4v6$)","type":"string","description":"Data packet protocol version","example":"IPv4"},"ratePlan":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the rate plan associated with default provider.","example":"vm fixed pool rp"},"user":{"type":"string","description":"User name.","example":"admin"}}},"AckUplodFile":{"type":"object","properties":{"data":{"type":"string","format":"binary"}}},"ActivateBody":{"type":"object","properties":{"description":{"type":"string","example":"This is a description"},"pxGridPassword":{"type":"string","example":"vjvR4vnzoLSAFPn9"},"pxGridUserName":{"type":"string","example":"vIPtela_Inc_Regression_testUser123"}},"description":"Body for PxGrid node activate on ISE"},"ActivateResponse":{"type":"object","properties":{"accountState":{"type":"string","example":"PENDING"},"version":{"type":"string","example":"2.0.3.24"}},"description":"Response from PxGrid node activation on ISE, account PENDING on activated ENABLED after approve"},"ActivationStatusRes":{"required":["centralizedPolicyActive","isActivatedByVSmarts"],"type":"object","properties":{"activatedCentralizedPolicyId":{"type":"string","format":"uuid","example":"efec8edf-04ce-4a99-86d5-441099f52b79"},"centralizedPolicyActive":{"type":"boolean","example":true},"isActivatedByVSmarts":{"type":"boolean","example":true},"referredInActiveWaniPolicy":{"type":"boolean","example":true},"userDefinedPolicyId":{"type":"string","format":"uuid","example":"5b55dbd3-35db-4358-a1a6-ee59da9b9d2d"}}},"ActiveFlowResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseData"}}},"description":"Active flows data response payload"},"AdminTechCreateReq":{"type":"object","properties":{"device-type":{"type":"string","example":"vmanage"},"deviceIP":{"type":"string","example":"10.3.0.1"},"exclude-cores":{"type":"boolean","example":true},"exclude-logs":{"type":"boolean","example":true},"exclude-tech":{"type":"boolean","example":false}}},"AdminTechListReq":{"type":"object","properties":{"deviceIP":{"type":"string","example":"10.3.0.1"}}},"AdminTechListRes":{"type":"object","properties":{"creationTime":{"type":"integer","format":"int64","example":1590186370340},"fileName":{"type":"string","example":"10.3.0.1-20200522-102611-admin-tech.tar.gz"},"requestTokenId":{"type":"string","example":"10540562-6759-40ad-917f-71d4b81ff37d"},"size":{"type":"integer","format":"int32","example":1081406},"state":{"type":"string","example":"done"}}},"AdminTechReq":{"type":"object","properties":{"deviceIP":{"type":"string","example":"10.3.0.1"},"fileName":{"type":"string","example":"10.3.0.1-20200522-102611-admin-tech.tar.gz"}}},"AdminTechsRes":{"type":"object","properties":{"creationTime":{"type":"integer","format":"int64","example":1590186370340},"deviceIP":{"type":"string","example":"10.3.0.1"},"fileName":{"type":"string","example":"10.3.0.1-20200522-102611-admin-tech.tar.gz"},"local-system-ip":{"type":"string","example":"10.3.0.1"},"requestTokenId":{"type":"string","example":"10540562-6759-40ad-917f-71d4b81ff37d"},"size":{"type":"integer","format":"int32","example":1081406},"state":{"type":"string","example":"done"},"tac_state":{"type":"string","example":"notStarted"}}},"AdminTechsUploadReq":{"type":"object","properties":{"requestTokenId":{"type":"string","example":"ea8cb172-61c4-47e0-8957-ac83b384f53e"},"sr_number":{"type":"string","example":"69131837254"},"token":{"type":"string","example":"9b42986QTUc"},"vpn":{"type":"string","example":"VPN 0"}}},"AdvancedRadioSetting":{"type":"object","properties":{"channelPowerSettings":{"$ref":"#/components/schemas/ChannelPowerSettings"},"countryRegionSettings":{"$ref":"#/components/schemas/CountryRegionSettings"}}},"Alarm":{"type":"object","properties":{"acknowledged":{"type":"boolean"},"active":{"type":"boolean"},"cleared_by":{"type":"string","format":"uuid","example":"0a0dca23-11d5-4014-bfbb-976d3c6de492"},"cleared_events":{"type":"array","items":{"type":"string","format":"uuid"}},"cleared_time":{"type":"integer","format":"int64","example":1652894923722},"component":{"type":"string","example":"Schedule Telemetry collection"},"consumed_events":{"type":"array","items":{"$ref":"#/components/schemas/OneOfAlarmConsumedEventsItems"}},"devices":{"type":"array","items":{"$ref":"#/components/schemas/AlarmDevices"}},"entry_time":{"type":"integer","format":"int64","example":1652906591837},"eventname":{"type":"string","example":"telemetry-data-collection-failure"},"id":{"type":"string","example":"HHbp2IABUbH5BDy9BhJe"},"message":{"type":"string","example":"Scheduled telemetry data collection failed on 19.19.19.1"},"possible_causes":{"type":"array","items":{"type":"string"}},"receive_time":{"type":"integer","format":"int64"},"rule_name_display":{"type":"string","example":"Telemetry data save failed"},"rulename":{"type":"string","example":"cpu-usage"},"severity":{"type":"string","enum":["Minor","Major","Critical","Medium"]},"severity_number":{"type":"integer","format":"int64","example":4},"site_id":{"type":"integer","format":"int64","example":100},"statcycletime":{"type":"integer","format":"int64"},"suppressed":{"type":"boolean","example":false},"suppressed_by":{"type":"object","example":{"system-ip":{"type":"string","example":"172.16.255.11"},"component":{"type":"string","example":"BFD"}}},"system_ip":{"type":"string","example":"172.16.255.26"},"tenant":{"type":"string","example":"default"},"type":{"type":"string","example":"Telemetry data save failed"},"uuid":{"type":"string","format":"uuid","example":"f6f83721-3a69-42d1-841f-94e015957fb7"},"values":{"type":"array","items":{"$ref":"#/components/schemas/GeneralSchema"}},"values_short_display":{"type":"array","items":{"$ref":"#/components/schemas/GeneralSchema"}}},"description":"Represents any kind of alarm"},"AlarmAggregation":{"type":"object","properties":{"count":{"type":"integer","format":"int64","example":6},"entry_time":{"type":"integer","format":"int64","example":1653575400000},"severity":{"type":"string","enum":["MINOR","MAJOR","MEDIUM","CRITICAL"]}}},"AlarmAggregationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AlarmAggregation"},"entryTimeList":{"type":"array","items":{"type":"integer","format":"int64"}}}},"AlarmClear":{"type":"object","properties":{"alarm_uuid":{"type":"string","format":"uuid","example":"29f9bf31-0fbe-4114-b8f0-e6234699485c"},"cleared":{"type":"boolean","example":true}},"description":"Alarms clear object containing uuid of the alarm and clear status"},"AlarmClearResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Response object of /alarms/clear API","items":{"$ref":"#/components/schemas/AlarmClear"}},"AlarmCount":{"type":"object","properties":{"cleared_count":{"type":"number","example":718},"count":{"type":"number","example":13}}},"AlarmCountPost":{"type":"object","properties":{"count":{"type":"number","example":12}}},"AlarmCountPostResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AlarmCountPost"}},"AlarmCountResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AlarmCount"}},"AlarmDevices":{"type":"object","properties":{"system-ip":{"type":"string","example":"19.19.19.1"}}},"AlarmDisableRequestBody":{"type":"object","properties":{"disable":{"type":"boolean"},"eventName":{"type":"string","example":"bfd"},"time":{"type":"integer","description":"time in hours [1, 72], -1 means infinite","format":"int64","example":2}}},"AlarmQueryInputResponse":{"type":"object","properties":{"component":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"severityOptions":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"timeOptions":{"type":"array","items":{"$ref":"#/components/schemas/TimeOptions"}}}},"AlarmResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Alarm"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"AlarmResponse is used for GET/POST /alarms call."},"AlarmSeverityMapping":{"type":"object","properties":{"associatedAlarms":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"key":{"type":"string","example":"Critical"},"value":{"type":"string","example":"Critical"}}},"AlarmSeverityMappingResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AlarmSeverityMapping"}},"AlarmStatsResponse":{"type":"object","properties":{"Correlation DB Manipulator":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EventStats"}},"Correlation Engine":{"$ref":"#/components/schemas/AlarmStatsResponseCorrelationEngine"},"Link Update Correlator":{"type":"object","additionalProperties":{"type":"string"}}}},"AlarmStatsResponseCorrelationEngine":{"type":"object","properties":{"Added Events":{"type":"integer","format":"int32","example":89}}},"AlarmTopic":{"type":"object","properties":{"device-ip":{"type":"string","example":"172.16.255.11"},"server-ip":{"type":"string","example":"10.0.105.39"},"topic":{"type":"string","example":"AlarmEvent3"}}},"AlarmsClearBody":{"type":"object","properties":{"alarm_uuid":{"type":"string","format":"uuid","example":"29f9bf31-0fbe-4114-b8f0-e6234699485c"}}},"AlarmsMarkviewedBody":{"type":"object","properties":{"uuid":{"type":"array","items":{"type":"string"}}}},"AllOfcloudGatewayPostSettings":{"type":"object","properties":{"cloudGatewaySolution":{"type":"string"},"cloudType":{"type":"string"},"instanceSize":{"type":"string"},"ipSubnetPool":{"type":"string"},"name":{"type":"string"},"networkTier":{"type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"type":"integer","description":"Used for Azure/Azure GovCloud Custom settings","format":"int32"},"softwareImageId":{"type":"string"},"tunnelCount":{"type":"integer","description":"Tunnel Count for AWS Connect based and branch connect","format":"int32"}}},"AllOfcloudWidgetCgwDeviceStatus":{"type":"object","properties":{"count":{"type":"number"},"name":{"type":"string"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/WidgetStatusStatusList"}},"unreachableCount":{"type":"number"}}},"AllOfhostVpcTagPostHostVpcsItems":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"hostVpcId":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"type":"string"},"label":{"type":"string"},"region":{"type":"string"},"resourceGroups":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetId":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for AWS, AWS GovCloud and GCP cloud types"},"AllOfhostVpcTagPostVnetsItems":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cgwAttachment":{"type":"string"},"cgwAutoAttachmentFlag":{"type":"boolean"},"cloudType":{"type":"string"},"hostVpcId":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"type":"string"},"label":{"type":"string"},"region":{"type":"string"},"resourceGroups":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetId":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for Azure and Azure GovCloud cloud types"},"AllOfhostVpcTagPutHostVpcsItems":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cgwAttachment":{"type":"string"},"cgwAutoAttachmentFlag":{"type":"boolean"},"cloudType":{"type":"string"},"hostVpcId":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"type":"string"},"interconnectTag":{"type":"string"},"label":{"type":"string"},"region":{"type":"string"},"resourceGroups":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"tag":{"type":"string"},"vnetId":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for AWS, AWS GovCloud and GCP cloud types"},"AllOfhostVpcTagPutVnetsItems":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cgwAttachment":{"type":"string"},"cgwAutoAttachmentFlag":{"type":"boolean"},"cloudType":{"type":"string"},"hostVpcId":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"type":"string"},"interconnectTag":{"type":"string"},"label":{"type":"string"},"region":{"type":"string"},"resourceGroups":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"tag":{"type":"string"},"vnetId":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for Azure and Azure GovCloud cloud types"},"AllOfupdateCgwSettings":{"type":"object","properties":{"cloudGatewaySolution":{"type":"string"},"cloudType":{"type":"string"},"instanceSize":{"type":"string"},"ipSubnetPool":{"type":"string"},"name":{"type":"string"},"networkTier":{"type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"type":"integer","description":"Used for Azure/Azure GovCloud Custom settings","format":"int32"},"softwareImageId":{"type":"string"},"tunnelCount":{"type":"integer","description":"Tunnel Count for AWS Connect based and branch connect","format":"int32"}}},"AllTagsResponse":{"type":"object","properties":{"create":{"type":"integer","format":"int32"},"tagList":{"type":"array","items":{"$ref":"#/components/schemas/AllTagsResponseTagList"}}}},"AllTagsResponseTagList":{"type":"object","properties":{"deviceCount":{"type":"string"},"name":{"type":"string"},"rid":{"type":"string"},"tagType":{"type":"string"}}},"ApiReKeyDevice":{"type":"object","properties":{"deviceId":{"type":"string"}}},"ApiReKeyDeviceList":{"type":"object","properties":{"deviceList":{"type":"array","items":{"$ref":"#/components/schemas/ApiReKeyDevice"}}}},"Apn":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"description":"List of APNs associated with the Comm Plan","example":"[{name:M2MTEST}]"},"AppRouteAggResp":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":5},"entry_time":{"type":"string","example":"1674813600000"},"local_color":{"type":"string","example":"3g"},"loss_percentage":{"type":"integer","format":"int32","example":0}}},"AppRouteAggRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAggResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"interface aggregation response with page info"},"AppRouteAppAggResp":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppRouteAppAggRespInner"}},"AppRouteAppAggRespInner":{"type":"object","properties":{"latency":{"type":"string"}}},"AppRouteDocCountResponse":{"type":"object","properties":{"dataType":{"type":"string"},"property":{"type":"string"}}},"AppRouteFECAggResp":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppRouteFECAggRespInner"}},"AppRouteFECAggRespInner":{"type":"object","properties":{"count":{"type":"number"},"entry_time":{"type":"string"},"fecLossRecovery":{"type":"string"},"loss_percentage":{"type":"number"},"name":{"type":"string"},"proto":{"type":"string"},"state":{"type":"string"}}},"AppRouteResp":{"type":"object","properties":{"device_model":{"type":"string"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"fec_re":{"type":"integer","format":"int32"},"fec_rx":{"type":"integer","format":"int64"},"fec_tx":{"type":"integer","format":"int64"},"host_name":{"type":"string"},"id":{"type":"string"},"jitter":{"type":"integer","format":"int32"},"latency":{"type":"number"},"local_color":{"type":"string"},"local_system_ip":{"type":"string"},"loss":{"type":"integer","format":"int32"},"loss_percentage":{"type":"integer","format":"int32"},"name":{"type":"string"},"proto":{"type":"string"},"remote_color":{"type":"string"},"remote_system_ip":{"type":"string"},"rx_octets":{"type":"integer","format":"int64"},"rx_pkts":{"type":"integer","format":"int64"},"sla_class_list":{"type":"string"},"sla_class_names":{"type":"string"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"statcycletime":{"type":"string"},"state":{"type":"string"},"tenant":{"type":"string"},"total":{"type":"integer","format":"int32"},"tunnel_color":{"type":"string"},"tx_octets":{"type":"number"},"tx_pkts":{"type":"integer","format":"int64"},"vdevice_name":{"type":"string"},"vip_idx":{"type":"integer","format":"int32"},"vmanage_system_ip":{"type":"string"},"vqoe_score":{"type":"integer","format":"int32"}},"description":"app route specific response"},"AppRouteRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"app route response with page info"},"AppRouteTransportResp":{"type":"object","properties":{"app_probe_class":{"type":"string"},"color":{"type":"string","example":"3g"},"entry_time":{"type":"string","example":"1674813600000"},"jitter":{"type":"string","example":"0"},"latency":{"type":"integer","format":"int32","example":5},"loss_percentage":{"type":"integer","format":"int32","example":0}}},"AppRouteTunnelSummary":{"type":"object","properties":{"app_probe_class":{"type":"string"},"entry_time":{"type":"string"},"jitter":{"type":"integer","format":"int32","example":0},"latency":{"type":"number"},"loss_percentage":{"type":"number"},"name":{"type":"string","example":"172.16.255.11:lte-172.16.255.16:3g"},"rx_octets":{"type":"integer","format":"int32"},"tx_octets":{"type":"integer","format":"int32"}}},"AppRouteTunnenSummarResp":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTunnelSummary"}}}},"ApplicationHeatMapDetail":{"required":["fair_site","good_site","poor_site"],"type":"object","properties":{"fair_site":{"type":"integer","format":"int32","example":1},"good_site":{"type":"integer","format":"int32","example":10},"poor_site":{"type":"integer","format":"int32","example":1}}},"ApplicationSiteChartItem":{"required":["entry_time","qoe"],"type":"object","properties":{"entry_time":{"type":"integer","format":"int64","example":1639897200000},"qoe":{"type":"number","format":"double","example":9}}},"ApplicationSiteItem":{"required":["health","jitter","latency","loss","path"],"type":"object","properties":{"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"jitter":{"type":"number","format":"double","example":1},"latency":{"type":"number","format":"double","example":10},"loss":{"type":"number","format":"double","example":1},"path":{"type":"string","example":"Tunnel3->SIG"},"qoe":{"type":"number","format":"double","example":9}}},"ApplicationSitesItem":{"required":["fair_path","good_path","health","poor_path","siteid"],"type":"object","properties":{"fair_path":{"type":"integer","format":"int32","example":1},"good_path":{"type":"integer","format":"int32","example":10},"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"poor_path":{"type":"integer","format":"int32","example":1},"siteid":{"type":"string","example":"100"}}},"ApplicationsResponseNoUUID":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"object"}},"ApplicationsSiteItem":{"required":["application","family","health","jitter","latency","loss"],"type":"object","properties":{"application":{"type":"string","example":"http"},"family":{"type":"string","example":"audio"},"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"jitter":{"type":"number","format":"double","example":1},"latency":{"type":"number","format":"double","example":10},"loss":{"type":"number","format":"double","example":1}}},"ApplicationsSitesItem":{"required":["application","fair_site","family","good_site","health","poor_site"],"type":"object","properties":{"application":{"type":"string","example":"http"},"fair_site":{"type":"integer","format":"int32","example":1},"family":{"type":"string","example":"audio"},"good_site":{"type":"integer","format":"int32","example":10},"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"poor_site":{"type":"integer","format":"int32","example":1}}},"AppliedRecommendationsRes":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppliedRecommendationsResEntry"}},"AppliedRecommendationsResEntry":{"required":["actionId","appClassName","last updated","recommendationDef","siteId","state"],"type":"object","properties":{"actionId":{"type":"string","example":"MYhj3JBjAr"},"appClassName":{"type":"string","example":"office365"},"last updated":{"type":"string","example":"09 Apr 2023 21:31:51 UTC"},"recommendationDef":{"type":"string","example":"{\"tenantId\":\"jSZn6hVkvr\",\"actionId\":\"MYhj3JBjAr\",\"actionType\":\"SR\",\"appClass\":\"office365\",\"windowStart\":\"2023-03-22T02:00:00+00:00\",\"windowEnd\":\"2023-04-09T23:00:00+00:00\",\"isActive\":true,\"srcEndpointId\":\"SgaEHHOs38\",\"dstEndpointId\":null,\"metadata\":{\"defaultPathType\":\"Tunnel\",\"defaultInterfaceIds\":[\"public-internet\",\"mpls\"],\"recommendedPathType\":\"Tunnel\",\"recommendedInterfaceIds\":[\"public-internet\"]},\"predDefaultProbSlaViolation\":0.24967608,\"predRecommendedProbSlaViolation\":5.022502E-4,\"predNumSessions\":null,\"modelName\":null,\"version\":0,\"siteId\":\"12127\",\"state\":\"READY\",\"curState\":\"APPLIED\",\"applicationWindow\":{\"end\":null,\"start\":null},\"states\":[\"APPLIED\",\"NON_APPLIED\",\"APPLIED\"],\"timestamps\":[\"2023-04-03T21:28:49.146624+00:00\",\"2023-04-03T23:24:10.403133+00:00\",\"2023-04-03T23:45:21.623478+00:00\"],\"appClassId\":\"office365\",\"appClassName\":\"Office 365\",\"isAppClassSelected\":true}"},"siteId":{"type":"string","example":"12127"},"state":{"type":"string","example":"APPLIED"}}},"ApplyRecommendationRes":{"required":["notValidRecommendationIds","notValidSites","processId","waniPolicyId"],"type":"object","properties":{"notValidRecommendationIds":{"type":"string","example":"abc, xyz"},"notValidSites":{"type":"string","example":"200"},"processId":{"type":"string","example":"vsmart_policy_config-8978b772-183d-424e-b9ac-e633b8ffe516"},"waniPolicyId":{"type":"string","format":"uuid","example":"083b83e4-165d-45a8-947e-ba141d9129a2"}}},"AttachSitesRequestPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AttachSitesRequestPayloadInner"}},"AttachSitesRequestPayloadInner":{"type":"object","properties":{"acceleratedVpn":{"type":"boolean","example":true},"color":{"type":"string","example":"red"},"siteId":{"type":"string","example":"578"},"systemIp":{"type":"string","example":"1.1.1.178"},"tunnelCount":{"type":"number","example":4}}},"AuditFix":{"type":"object","properties":{"cloudType":{"type":"string"},"issuesToSync":{"type":"object"},"region":{"type":"string"}}},"AuditLogEntry":{"required":["auditdetails","entry_time","logdeviceid","logfeature","logid","logmessage","logmodule","loguser","logusersrcip","statcycletime","tenant"],"type":"object","properties":{"auditdetails":{"type":"array","items":{"type":"string"}},"entry_time":{"type":"integer","format":"int32","example":1659003590292},"id":{"type":"string","example":"iWJRRIIBMbLIyWbe1qH"},"logdeviceid":{"type":"string","example":"172.16.255.22"},"logfeature":{"type":"string","example":"user"},"logid":{"type":"string","format":"uuid","example":"918c6d64-729c-4304-b2c7-955a7c0e6a61"},"logmessage":{"type":"string","example":"Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879"},"logmodule":{"type":"string","example":"user"},"loguser":{"type":"string","format":"uuid"},"logusersrcip":{"type":"string","example":"172.16.255.19"},"statcycletime":{"type":"integer","format":"int32","example":1659003590292},"tenant":{"type":"string","example":"default"}}},"AuditLogHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/ChartObject"},"columns":{"$ref":"#/components/schemas/AuditLogHeaderColumns"},"fields":{"$ref":"#/components/schemas/GetStatDataFields"},"generatedOn":{"type":"integer","format":"int32","example":1655622555494},"viewKeys":{"$ref":"#/components/schemas/AuditLogHeaderViewKeys"}}},"AuditLogHeaderColumns":{"required":["dataType","property","title"],"type":"object","properties":{"dataType":{"type":"string","example":"date"},"displayFormat":{"type":"string","example":"DD MMM YYYY h:mm:ss A z"},"hideable":{"type":"boolean","example":true},"inputFormat":{"type":"string","example":"unix-time"},"isDisplay":{"type":"boolean","example":true},"minWidth":{"type":"integer","format":"int32","example":300},"property":{"type":"string","example":"entry_time"},"title":{"type":"string","example":"Timestamp"},"width":{"type":"integer","format":"int32","example":220}}},"AuditLogHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-AuditLogView"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"AuditLogQueryString":{"required":["query"],"type":"object","properties":{"query":{"$ref":"#/components/schemas/AuditLogQueryStringQuery"}}},"AuditLogQueryStringQuery":{"type":"object","properties":{"condition":{"type":"string","example":"AND"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogQueryStringQueryRules"}}}},"AuditLogQueryStringQueryRules":{"type":"object","properties":{"field":{"type":"string","example":"entry_time"},"operator":{"type":"string","example":"last_n_hours"},"type":{"type":"string","example":"date"},"value":{"type":"array","items":{"type":"string"}}}},"AuditReport":{"type":"object","properties":{"auditReport":{"type":"array","items":{"$ref":"#/components/schemas/AuditReportAuditReport"}},"auditStatus":{"type":"string","example":"IN_SYNC"}}},"AuditReportAuditReport":{"type":"object","properties":{"errString":{"type":"string"},"region":{"type":"string","example":"My-Region-1"},"reportType":{"type":"string","example":"Edge Gateway"},"resourceName":{"type":"string","example":"My-Interconnect-Gateway-1"},"status":{"type":"string","example":"IN_SYNC"}}},"AuditlogAggregationBody":{"type":"object"},"AuditlogDoccountBody":{"required":["aggregation","query"],"type":"object","properties":{"aggregation":{"$ref":"#/components/schemas/QueryWithAggregationAggregation"},"query":{"$ref":"#/components/schemas/AuditLogQueryStringQuery"}}},"AwsDirectConnectGateway":{"type":"object","properties":{"amazonSideAsn":{"type":"integer","format":"int64"},"gatewayAssociationList":{"type":"array","description":"List of associated Gateways","items":{"$ref":"#/components/schemas/GatewayAssociation"}},"ownerAccount":{"type":"string"},"virtualInterfaceAttachmentList":{"type":"array","description":"List of virtual interfaces attached to DxGW","items":{"$ref":"#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceAttachmentList"}},"vpcTagNamesForGatewayAssociations":{"type":"array","description":"VPC Tags associated to the Direct Connect Gateway","items":{"type":"string","description":"VPC Tags associated to the Direct Connect Gateway"}}},"description":"AWS Direct Connect Gateway specific Object."},"AwsDirectConnectGatewayVirtualInterfaceAttachmentList":{"type":"object","properties":{"attachmentState":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AZURE","GCP"]},"connectionId":{"type":"string","description":"Id of the private cross connect","example":"12345-1234-1234"},"connectionType":{"type":"string","description":"Type of AWS connection","example":"HCONN","enum":["HVIF","HCONN"]},"ownerAccount":{"type":"string"},"region":{"type":"string"},"stateChangeError":{"type":"string"},"virtualInterfaceData":{"$ref":"#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceData"},"virtualInterfaceId":{"type":"string"},"virtualInterfaceName":{"type":"string"},"virtualInterfaceType":{"type":"string","example":"TRANSIT","enum":["TRANSIT","PRIVATE","PUBLIC","ATTACHMENT"]}},"description":"Virtual Interface Object"},"AwsDirectConnectGatewayVirtualInterfaceData":{"type":"object","properties":{"advertisedPrefixList":{"type":"array","items":{"type":"string"}},"asn":{"type":"integer","format":"int64","example":65500},"bgpKey":{"type":"string","example":"EC-12345678"},"customerIpAddress":{"type":"string"},"ipAddress":{"type":"string"},"vlan":{"type":"integer","format":"int64","example":45678}},"description":"VIrtual Interface Object"},"AwsIamCredentials":{"type":"object","properties":{"externalId":{"type":"string"},"roleArn":{"type":"string"}}},"AwsKeyCredentials":{"type":"object","properties":{"apiKey":{"type":"string"},"secretKey":{"type":"string"}}},"AwsTransitGateway":{"type":"object","properties":{"amazonSideAsn":{"type":"integer","format":"int64"},"associationDefaultRouteTableId":{"type":"string","example":"tgw-rtb-07ace6b22f9de8502"},"autoAcceptSharedAttachments":{"type":"boolean"},"creationTime":{"type":"string","example":"11-Jun-2022 (00:10:30:00000)"},"defaultRouteTableAssociation":{"type":"boolean"},"defaultRouteTablePropogation":{"type":"boolean"},"dnsSupport":{"type":"boolean"},"multicastSupport":{"type":"boolean"},"ownerAccount":{"type":"string"},"propogationDefaultRouteTableId":{"type":"string"},"vpcAttachmentList":{"type":"array","description":"List of VPC attachments","items":{"$ref":"#/components/schemas/AwsVpcAttachments"}},"vpnEcmpSupport":{"type":"boolean"}},"description":"AWS Transit Gateway specific Object."},"AwsVirtualPrivateGateway":{"type":"object","properties":{"amazonSideAsn":{"type":"integer","format":"int64"},"availabilityZone":{"type":"string"},"vpcAttachmentList":{"type":"array","description":"List of VPC attachments","items":{"$ref":"#/components/schemas/AwsVpcAttachments"}},"vpgType":{"type":"string","example":"ipsec.1"}},"description":"AWS Virtual Private Gateway specific Object."},"AwsVpcAttachments":{"type":"object","properties":{"region":{"type":"string"},"vpcId":{"type":"string","description":"VPC Id","example":"vpc-012345-2000"},"vpcRoutePrefixes":{"type":"array","description":"List of ip prefixes to be advertized towards DxGw on the VPC routing table.","example":["198.18.0.4/30","198.18.0.7/30"],"items":{"type":"string","description":"List of ip prefixes to be advertized towards DxGw on the VPC routing table.","example":"[\"198.18.0.4/30\",\"198.18.0.7/30\"]"}},"vpcState":{"type":"string"},"vpcSubnetPrefixList":{"type":"array","description":"List of VPC subnets to be added to DxGw association.","example":["10.10.0.0/24","10.10.1.0/24"],"items":{"type":"string","description":"List of VPC subnets to be added to DxGw association.","example":"[\"10.10.0.0/24\",\"10.10.1.0/24\"]"}}},"description":"AWS VPC attachment Object"},"AzureCredentials":{"type":"object","properties":{"clientId":{"type":"string"},"cloudTenantId":{"type":"string"},"secretKey":{"type":"string"},"subscriptionId":{"type":"string"}}},"AzureERCPeering":{"type":"object","properties":{"advertisedPublicPrefixList":{"type":"array","items":{"type":"string"}},"azureAsn":{"type":"string"},"expressRouteConnectionId":{"type":"string","example":"12345"},"id":{"type":"string"},"name":{"type":"string"},"peerAsn":{"type":"string"},"peeringState":{"type":"string","example":"ENABLED","enum":["DISABLED","ENABLED"]},"peeringType":{"type":"string","example":"PUBLIC","enum":["PRIVATE","PUBLIC"]},"primaryAzurePort":{"type":"string"},"primaryPeerAddressPrefix":{"type":"string"},"secondaryAzurePort":{"type":"string"},"secondaryPeerAddressPrefix":{"type":"string"},"sharedKey":{"type":"string","description":"BGP Peering Key","example":"EC-12345"},"vlanId":{"type":"integer","format":"int64","example":1618}},"description":"Azure Express Route Circuit Peering"},"AzureERCServiceProviderProperties":{"type":"object","properties":{"bandwidthInMbps":{"type":"integer","format":"int64","example":1000},"peeringLocation":{"type":"string","example":"New York"},"serviceProviderName":{"type":"string"}},"description":"Azure Express Route Circuit Service Provider Properties"},"AzureExpressRouteCircuit":{"type":"object","properties":{"allowClassicOperations":{"type":"boolean","example":true},"bandwidthInGbps":{"type":"integer","format":"int32","example":200},"gatewayAssociationList":{"type":"array","items":{"$ref":"#/components/schemas/GatewayAssociation"}},"globalReachEnabled":{"type":"boolean","example":true},"peeringList":{"type":"array","items":{"$ref":"#/components/schemas/AzureERCPeering"}},"provisioningState":{"type":"string","example":"PROVISIONED"},"resourceGroupName":{"type":"string"},"serviceKey":{"type":"string"},"serviceProviderProperties":{"$ref":"#/components/schemas/AzureERCServiceProviderProperties"},"serviceProviderProvisioningState":{"type":"string","enum":["DEPROVISIONING","NOT_PROVISIONED","PROVISIONED","PROVISIONING"]},"sku":{"$ref":"#/components/schemas/AzureExpressRouteCircuitSku"},"vWanAttachmentList":{"type":"array","items":{"$ref":"#/components/schemas/AzureExpressRouteCircuitVWanAttachmentList"}},"vnetTagNamesForConnections":{"type":"array","items":{"$ref":"#/components/schemas/AzureExpressRouteCircuitVnetTagNamesForConnections"}}},"description":"Azure Express Route Circuit Object"},"AzureExpressRouteCircuitSku":{"type":"object","properties":{"family":{"type":"string","enum":["METERED_DATA","UNLIMITED_DATA"]},"name":{"type":"string"},"tier":{"type":"string","example":"STANDARD","enum":["BASIC","LOCAL","PREMIUM","STANDARD"]}},"description":"Express Route Circuit SKU"},"AzureExpressRouteCircuitVHubList":{"type":"object","properties":{"isDelete":{"type":"boolean","example":true},"vHub":{"$ref":"#/components/schemas/AzureVirtualHub"}}},"AzureExpressRouteCircuitVWanAttachmentList":{"type":"object","properties":{"vHubList":{"type":"array","items":{"$ref":"#/components/schemas/AzureExpressRouteCircuitVHubList"}},"vWan":{"$ref":"#/components/schemas/AzureVirtualWan"}},"description":"vWan Attachment Name"},"AzureExpressRouteCircuitVnetTagNamesForConnections":{"type":"object","properties":{"isDelete":{"type":"boolean","example":true},"vnetTagName":{"type":"string"}},"description":"Vnet Tag Object Names"},"AzureExpressRouteGateway":{"type":"object","properties":{"autoScaleConfiguration":{"type":"string"},"resourceGroupName":{"type":"string"},"vHubId":{"type":"string","description":"Id of the Azure vHUB.","example":"vhub-1234"}},"description":"Azure Express Route Gateway Object"},"AzureVirtualHub":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"addressPrefix":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AZURE","GCP"]},"id":{"type":"string"},"name":{"type":"string"},"provisioningState":{"type":"string","example":"PROVISIONED"},"region":{"type":"string"},"resourceGroupName":{"type":"string"},"routingState":{"type":"string"},"sku":{"type":"string","example":"STANDARD"},"tagList":{"type":"array","items":{"$ref":"#/components/schemas/AzureVirtualWanTagList"}},"virtualRouterAsn":{"type":"string"},"virtualRouterIp":{"type":"array","items":{"$ref":"#/components/schemas/AzureVirtualHubVirtualRouterIp"}},"vwanName":{"type":"string"}},"description":"Azure Virtual Hub"},"AzureVirtualHubVirtualRouterIp":{"type":"object","properties":{"privateIp":{"type":"string"}},"description":"Virtual Router IP"},"AzureVirtualNetworkGateway":{"type":"object","properties":{"enableBgp":{"type":"boolean","example":true},"publicIPAddress":{"type":"string"},"sku":{"$ref":"#/components/schemas/AzureVirtualNetworkGatewaySku"},"subnet":{"type":"string"},"virtualNetworkGatewayType":{"type":"string","example":"EXPRESS_ROUTE","enum":["VPN","EXPRESS_ROUTE"]}},"description":"Azure Virtual Network Gateway Object"},"AzureVirtualNetworkGatewaySku":{"type":"object","properties":{"capacity":{"type":"integer","format":"int32","example":100},"name":{"type":"string"},"tier":{"type":"string","example":"STANDARD"}},"description":"VNET Gateway SKU parameters"},"AzureVirtualWan":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string","description":"Cloud account name","example":"my-cloud-account"},"allowBranchToBranchTraffic":{"type":"boolean","example":false},"cloudType":{"type":"string","enum":["AWS","AZURE","GCP"]},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"provisioningState":{"type":"string","example":"PROVISIONED"},"region":{"type":"string"},"resourceGroupName":{"type":"string"},"tagList":{"type":"array","items":{"$ref":"#/components/schemas/AzureVirtualWanTagList"}},"virtualWanType":{"type":"string"},"vnetTovnetTrafficEnabled":{"type":"boolean","example":false}},"description":"Azure Virtual Wan"},"AzureVirtualWanTagList":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string","example":"mytag"}},"description":"Azure Virtual WAN Tag Object"},"Banner":{"type":"object","properties":{"loginMessage":{"type":"string"},"motd":{"type":"string"}}},"Bfd":{"type":"object","properties":{"bfdTimerOnTransportTunnels":{"$ref":"#/components/schemas/BfdTimerOnTransportTunnels"},"dscpForBfdPackets":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pollInterval":{"type":"integer","format":"int32"}}},"BfdTimerOnTransportTunnels":{"type":"object","properties":{"bizInternetTimer":{"$ref":"#/components/schemas/BizInternetTimer"},"lteTimer":{"$ref":"#/components/schemas/LteTimer"},"mplsTimer":{"$ref":"#/components/schemas/MplsTimer"},"publicInternetTimer":{"$ref":"#/components/schemas/PublicInternetTimer"}}},"BizInternetTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"CapDistribution":{"type":"object","properties":{"0-25":{"type":"integer","format":"int64"},"100":{"type":"integer","format":"int64"},"25-50":{"type":"integer","format":"int64"},"50-75":{"type":"integer","format":"int64"},"75-100":{"type":"integer","format":"int64"},"uncategorized":{"type":"integer","format":"int64"}}},"CapacityResp":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CapacityRespData"}},"distribution":{"$ref":"#/components/schemas/CapDistribution"}}},"CapacityRespData":{"type":"object","properties":{"avg_down_capacity_percentage":{"type":"number"},"avg_up_capacity_percentage":{"type":"number"},"bw_down":{"type":"integer","format":"int64"},"bw_up":{"type":"number"},"count":{"type":"integer","format":"int64"},"interface":{"type":"string"},"max_down_capacity_percentage":{"type":"number"},"max_up_capacity_percentage":{"type":"number"},"min_down_capacity_percentage":{"type":"number"},"min_up_capacity_percentage":{"type":"integer","format":"int32"},"range":{"type":"string"},"vdevice_name":{"type":"string"}}},"Cellular":{"required":["name","primarySlot","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"simSlot0":{"$ref":"#/components/schemas/SimSlotConfig"},"simSlot1":{"$ref":"#/components/schemas/SimSlotConfig"},"primarySlot":{"maximum":1,"minimum":0,"type":"integer","format":"int32"},"wanConfig":{"pattern":"(^Active$|^Standby$)","type":"string"}}}]},"CellularProfile":{"type":"object","properties":{"apn":{"type":"string"},"authMethod":{"pattern":"(^none$|^pap$|^chap$|^pap_or_chap$)","type":"string"},"id":{"maximum":16,"minimum":1,"type":"integer","format":"int32"},"password":{"type":"string"},"pdnType":{"pattern":"(^IPv4$|^IPv6$|^IPv4v6$)","type":"string"},"userName":{"type":"string"}}},"CertificateChain":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"CertificateData":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"CertificateStates":{"type":"object","properties":{"certificateTypes":{"type":"string"}},"description":"This is valid Certificate States "},"CertificateValidity":{"type":"object","properties":{"certificateValidity":{"type":"string"}},"description":"This is Certificate Validity "},"CgwResourceResponse":{"type":"object","properties":{"creationDate":{"type":"string"},"details":{"$ref":"#/components/schemas/CgwResourceResponseDetails"},"esourceId":{"type":"string"},"resourceType":{"type":"string"}}},"CgwResourceResponseDetails":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/CgwResourceResponseDetailsDevices"}},"vhubName":{"type":"string"},"virtualRouterAsn":{"type":"string"},"vwanName":{"type":"string"}}},"CgwResourceResponseDetailsDevices":{"type":"object","properties":{"publicIp":{"type":"string"},"uuid":{"type":"string"}}},"CgwVpnsResponse":{"type":"object","properties":{"accountName":{"type":"string","example":"awsTest"},"hostVpcId":{"type":"string","example":"vpc-0638351a9efaf77e9"},"hostVpcName":{"type":"string","description":"Returned for AWS/AWS_GOVCLOUD/GCP","example":"vpc-0638351a9efaf77e9"},"tag":{"type":"string","example":"test-tag-aws"},"tunnelCount":{"type":"integer","description":"Returned for AWS/AWS_GOVCLOUD/GCP","format":"int32","example":6},"vpnId":{"type":"string","example":"10"}}},"ChannelPowerSettings":{"type":"object","properties":{"radioBand2Dot4Ghz":{"$ref":"#/components/schemas/RadioBandSetting_2_4G"},"radioBand5Ghz":{"$ref":"#/components/schemas/RadioBandSetting_5G"}}},"ChartObject":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.chart.viewAuditlogHistogram.auditLog"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.chart.viewAuditlogHistogram.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.chart.viewAuditlogHistogram.count"}}},"CheckTagRulesResponse":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/TagRuleInfoDevices"}},"isConflict":{"type":"boolean"}}},"CloudConnectivityGateway":{"type":"object","properties":{"awsConnectivityGateway":{"$ref":"#/components/schemas/CloudConnectivityGatewayAws"},"azureConnectivityGateway":{"$ref":"#/components/schemas/CloudConnectivityGatewayAzure"},"cloudAccountId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AZURE","GCP"]},"connectivityGatewayState":{"type":"string"},"description":{"type":"string"},"gatewayId":{"type":"string"},"gatewayName":{"type":"string"},"gcpConnectivityGateway":{"$ref":"#/components/schemas/CloudConnectivityGatewayGcp"},"isVmanageCreated":{"type":"boolean","description":"Resource created by vManage","example":true},"newFormat":{"type":"boolean","description":"Option indicates object type","example":true},"region":{"type":"string"}},"description":"Cloud Connectivity Gateway Object"},"CloudConnectivityGatewayAws":{"type":"object","properties":{"awsConnectivityType":{"type":"string","example":"DIRECT_CONNECT_GATEWAY","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY"]},"directConnectGateway":{"$ref":"#/components/schemas/AwsDirectConnectGateway"},"transitGateway":{"$ref":"#/components/schemas/AwsTransitGateway"},"virtualPrivateGateway":{"$ref":"#/components/schemas/AwsVirtualPrivateGateway"}},"description":"AWS cloud Connectivity Gateway Object"},"CloudConnectivityGatewayAzure":{"type":"object","properties":{"azureConnectivityType":{"type":"string","enum":["EXPRESS_ROUTE_CIRCUIT","VIRTUAL_NETWORK_GATEWAY","EXPRESS_ROUTE_GATEWAY"]},"expressRouteCircuit":{"$ref":"#/components/schemas/AzureExpressRouteCircuit"},"expressRouteGateway":{"$ref":"#/components/schemas/AzureExpressRouteGateway"},"virtualNetworkGateway":{"$ref":"#/components/schemas/AzureVirtualNetworkGateway"}},"description":"Cloud Connectivity Gateway Object"},"CloudConnectivityGatewayGcp":{"type":"object","properties":{"gcConnectivityType":{"type":"string","example":"GCR_ATTACHMENT","enum":["GCR_ATTACHMENT"]},"interconnectAsn":{"type":"integer","description":"BGP ASN assigned to Interconnect Gateway.","format":"int64","example":64500},"pairingKey":{"type":"string","example":"96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1"},"routerInfo":{"$ref":"#/components/schemas/GcpCloudRouter"}},"description":"Google cloud Connectivity Gateway Object."},"CloudGatewayAdjusted":{"type":"object","properties":{"accountId":{"type":"string"},"cloudGatewayId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudGatewaySolution":{"type":"string"},"cloudProviderASN":{"type":"integer","description":"CGW details relevant to AWS/AWS_GOVCLOUD","format":"int32"},"cloudProviderMgmtReference":{"type":"string","description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"cloudType":{"type":"string"},"connectedSites":{"type":"integer","format":"int32"},"connectivityState":{"type":"string"},"connectivityStateUpdateTs":{"type":"number"},"customSettings":{"type":"boolean"},"description":{"type":"string"},"devices":{"type":"array","items":{"type":"string"}},"mrfRouterRole":{"type":"string"},"region":{"type":"string"},"resourceGroupName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"routeTableCount":{"type":"string","description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"s2sPermitted":{"type":"boolean","description":"Only applicable to GCP CloudGateways"},"settings":{"$ref":"#/components/schemas/CustomSettings"},"siteName":{"type":"string"},"status":{"type":"string"},"tunnelCidrBlocks":{"type":"array","description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"type":"object","description":"CGW details relevant to AWS/AWS_GOVCLOUD"}},"tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"$ref":"#/components/schemas/TunnelsInner"}},"vhubName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"virtualRouterAsn":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"vpns":{"type":"array","items":{"type":"string"}},"vwanName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"}}},"CloudGatewayListResponse":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudGatewayId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string"},"customSettings":{"type":"boolean"},"description":{"type":"string"},"region":{"type":"string"},"status":{"type":"string"}}},"CloudGatewayPost":{"type":"object","properties":{"accountId":{"type":"string"},"azureProperties":{"$ref":"#/components/schemas/CloudGatewayPostAzureProperties"},"cloudGatewayName":{"type":"string"},"cloudGatewayTag":{"type":"string"},"cloudType":{"type":"string"},"description":{"type":"string"},"devices":{"type":"array","items":{"type":"string"}},"mrfRouterRole":{"type":"string"},"region":{"type":"string"},"s2sPermitted":{"type":"boolean"},"settings":{"$ref":"#/components/schemas/AllOfcloudGatewayPostSettings"},"siteName":{"type":"string"},"sshKeyName":{"type":"string"}}},"CloudGatewayPostAzureProperties":{"type":"object","properties":{"nvaSource":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]},"resourceGroupName":{"type":"string"},"resourceGroupSource":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]},"vhubName":{"type":"string"},"vhubSource":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]},"vwanName":{"type":"string"},"vwanSource":{"type":"string","enum":["azure","azureStored","vManage","toBeCreated"]}},"description":"Used in Azure/Azure GovCloud CGW creation"},"CloudWidget":{"type":"object","properties":{"cgwDeviceSiteIds":{"type":"array","items":{"type":"string"}},"cgwDeviceStatus":{"$ref":"#/components/schemas/AllOfcloudWidgetCgwDeviceStatus"},"cgwSitesStatus":{"$ref":"#/components/schemas/WidgetStatus"},"cgwStatus":{"$ref":"#/components/schemas/WidgetStatus"},"cloudGatewaySolution":{"type":"string"},"cloudType":{"type":"string"},"numAccounts":{"type":"number"},"numTags":{"type":"number"},"numTunnels":{"type":"number"},"numVpcs":{"type":"number"},"numVpns":{"type":"number"}}},"Codes":{"type":"object","properties":{"device_code":{"type":"string"},"expires_in":{"type":"integer","format":"int32"},"interval":{"type":"integer","format":"int32"},"user_code":{"type":"string"},"verification_uri":{"type":"string"},"verification_uri_complete":{"type":"string"}},"description":"Response from Cisco SecureX device_authorization API"},"CommunicationPlan":{"required":["apns","lteApns","lteEnabled","name"],"type":"object","properties":{"apns":{"type":"array","description":"List of APNs associated with the Comm Plan","example":"[{name:M2MTEST}]","items":{"$ref":"#/components/schemas/Apn"}},"commPlanDescription":{"type":"string","description":"Description of the communication plan.","example":"sms data shared"},"commPlanName":{"type":"string","writeOnly":true},"lteApns":{"type":"array","description":"List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ","example":[],"items":{"$ref":"#/components/schemas/LteApn"}},"lteEnabled":{"type":"boolean","description":"Specifies whether the Comm Plan has LTE enabled","example":false},"name":{"type":"string","description":"Name of the communication plan.","example":"vm cp sms data share"}}},"ComponentEventMapping":{"type":"object","properties":{"component":{"type":"string","example":"Software"},"event":{"type":"string","example":"system-software-install-change"}}},"ConfigGroup":{"required":["name","solution","state","version"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"Mobility","enum":["mobility","sdwan","common","nfvirtual"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"topology":{"$ref":"#/components/schemas/Topology"},"version":{"type":"integer","description":" Group Version Flag","format":"int64"}}},"Configinfo":{"type":"object","properties":{"items":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/RegionPrefixinfo"}},"revision":{"type":"string","example":"20201120.ace4cb0"},"version":{"type":"string","example":"1.0.0"}}},"ConflictCheckResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/ConflictCheckResponseInner"}},"ConflictCheckResponseInner":{"type":"object","properties":{"deviceId":{"type":"string"},"isConflict":{"type":"boolean"},"noDevice":{"type":"array","items":{"type":"string"}}}},"ConnectResponse":{"type":"object","properties":{"VersionInfo":{"$ref":"#/components/schemas/VersionInformation"}},"description":"Response from ISE ERS version info api"},"ConnectToNtpServer":{"type":"object","properties":{"ipAddress":{"type":"string"},"vpn":{"type":"string"}}},"ConnectedSitesResponse":{"type":"object","properties":{"bfdSessions":{"type":"integer","format":"int32"},"bfdSessionsUp":{"type":"integer","format":"int32"},"device-model":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"statusBfd":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"ControlStatus":{"type":"object","properties":{"controlDown":{"type":"integer","format":"int32"},"controlUp":{"type":"integer","format":"int32"},"partial":{"type":"integer","format":"int32"}}},"CoreNetworkPolicyResponse":{"type":"object","properties":{"changeSetState":{"type":"string","example":"EXECUTION_SUCCEEDED"},"coreNetworkId":{"type":"string","example":"core-network-0008d82310d17b86b"},"createdAt":{"type":"string","example":"Dec.16, 2022 04:16 UTC"},"description":{"type":"string","example":"Core Network Policy"},"policyAlias":{"type":"string","example":"LIVE, LATEST"},"policyData":{"type":"string","example":"StringifiedJsonPolicyData"},"policyVersionId":{"type":"number","example":19}}},"CorporateWifi":{"required":["securityAuthType"],"type":"object","properties":{"aaaServerInfo":{"$ref":"#/components/schemas/AaaServerInfo"},"corporateWlan":{"type":"boolean"},"radiusServer":{"$ref":"#/components/schemas/RadiusServer"},"securityAuthType":{"pattern":"(WPA2-PSK_AES|WPA2-Enterprise)","type":"string"},"ssid":{"maxLength":32,"minLength":1,"type":"string"},"visibility":{"type":"boolean"},"wpaPskKey":{"type":"string"}}},"CountResponse":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":17193}}},"CountryRegionSettings":{"type":"object","properties":{"countryRegion":{"type":"string"},"regulatoryDomain":{"pattern":"(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)","type":"string"}}},"CreateBody":{"type":"object","properties":{"nodeName":{"type":"string","example":"testUser123"}},"description":"Body for PxGrid node create on ISE"},"CreateDeviceParams":{"type":"object","properties":{"deviceIP":{"type":"string"},"generateCSR":{"type":"boolean"},"password":{"type":"string"},"personality":{"type":"string"},"port":{"type":"string"},"protocol":{"type":"string"},"username":{"type":"string"}}},"CreateResponse":{"type":"object","properties":{"nodeName":{"type":"string","example":"vIPtela_Inc_Regression_testUser123"},"password":{"type":"string","example":"vjvR4vnzoLSAFPn9"},"userName":{"type":"string","example":"vIPtela_Inc_Regression_testUser123"}},"description":"Response from PxGrid node creation on ISE"},"CreateTenantModel":{"type":"object","properties":{"desc":{"type":"string"},"edgeConnectorEnable":{"type":"boolean"},"edgeConnectorSystemIp":{"type":"string"},"edgeConnectorTunnelInterfaceName":{"type":"string"},"getvBondAddress":{"type":"string"},"getvSmarts":{"type":"array","items":{"type":"string"}},"idpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"name":{"type":"string"},"oldIdpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"orgName":{"type":"string"},"spMetadata":{"type":"string"},"subDomain":{"type":"string"},"wanEdgeForecast":{"type":"string"}}},"Criteria":{"type":"object","properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}}},"CustomSettings":{"type":"object","properties":{"cloudGatewaySolution":{"type":"string"},"cloudType":{"type":"string"},"instanceSize":{"type":"string"},"ipSubnetPool":{"type":"string"},"name":{"type":"string"},"networkTier":{"type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"type":"integer","description":"Used for Azure/Azure GovCloud Custom settings","format":"int32"},"softwareImageId":{"type":"string"},"tunnelCount":{"type":"integer","description":"Tunnel Count for AWS Connect based and branch connect","format":"int32"}}},"DBSchema":{"type":"object","properties":{"countOfUniqueuVertexAndEdgeObjectsCreated":{"type":"integer","format":"int64","example":499},"countOfVertexAndEdgesRegisteredWithDeviceDataManager":{"type":"integer","format":"int64","example":423},"vertexDefinitionsForDataCollection":{"type":"array","items":{"type":"string"}},"vertexDefinitionsFoundInDBWithData":{"type":"array","items":{"$ref":"#/components/schemas/VertexDefinitions"}},"vertexDefinitionsFoundInDBWithoutData":{"type":"array","items":{"type":"string"}},"vertexDefinitionsNotFoundInDB":{"type":"array","items":{"type":"string"}},"vertexDefinitionsNotRegisteredWithDeviceDataManager":{"type":"array","items":{"type":"string"}}}},"DHCPPool":{"required":["leaseTimeDay","leaseTimeHour","leaseTimeMin","poolNetwork"],"type":"object","properties":{"leaseTimeDay":{"maximum":365,"minimum":0,"type":"integer","format":"int32"},"leaseTimeHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32"},"leaseTimeMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32"},"poolNetwork":{"type":"string"}}},"DPIAggregationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIAggregationResponseData"}},"header":{"$ref":"#/components/schemas/DPIAggregationResponseHeader"}}},"DPIAggregationResponseData":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":398},"family":{"type":"string","example":"network-service"},"octets":{"type":"integer","format":"int32","example":18768}}},"DPIAggregationResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/DPIAggregationResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DPIAggregationResponseHeaderFields"}},"generatedOn":{"type":"integer","format":"int64","example":1664160118911}}},"DPIAggregationResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"number"},"isDisplay":{"type":"boolean"},"property":{"type":"string","example":"octets"},"title":{"type":"string","example":"Octets"}}},"DPIAggregationResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"number"},"property":{"type":"string","example":"octets"}}},"DPIAppResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIAppResponseData"}},"header":{"$ref":"#/components/schemas/DPIAppResponseHeader"}}},"DPIAppResponseData":{"type":"object","properties":{"application":{"type":"string","example":"ipfix"},"octets":{"type":"number","example":72535008}}},"DPIAppResponseHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/DPIAppResponseHeaderChart"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DPIAppResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DPIAppResponseHeaderFields"}},"generatedOn":{"type":"number","example":1664506834428},"viewKeys":{"$ref":"#/components/schemas/DPIAppResponseHeaderViewKeys"}}},"DPIAppResponseHeaderChart":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.statistics.clientViewDpiApplication.dpiApplication"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiApplication.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiApplication.count"}}},"DPIAppResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"hideable":{"type":"boolean"},"property":{"type":"string","example":"application"},"title":{"type":"string","example":"Application"}}},"DPIAppResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"property":{"type":"string","example":"application"}}},"DPIAppResponseHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-dpi_applications"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"DPIDataObject":{"type":"object","properties":{"application":{"type":"string","example":"icmp"},"create_time":{"type":"integer","format":"int64","example":1664150420729},"dest_ip":{"type":"string","example":"10.74.49.77"},"dest_port":{"type":"integer","format":"int32","example":771},"device_model":{"type":"string","example":"vedge-C8000V"},"entry_time":{"type":"integer","format":"int64","example":1664150431860},"expire_time":{"type":"integer","format":"int64","example":1664150421784},"family":{"type":"string","example":"network-service"},"host_name":{"type":"string","example":"C8Kv-77"},"ip_proto":{"type":"integer","format":"int32","example":1},"octets":{"type":"integer","format":"int32","example":4032},"packets":{"type":"integer","format":"int32","example":7},"source_ip":{"type":"string","example":"10.124.10.249"},"source_port":{"type":"integer","format":"int32","example":0},"vdevice_name":{"type":"string","example":"1.1.70.7"},"vip_idx":{"type":"integer","format":"int32","example":172060},"vpn_id":{"type":"integer","format":"int32","example":512}}},"DPIResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIDataObject"}},"pageInfo":{"$ref":"#/components/schemas/DPIResponsePageInfo"}}},"DPIResponsePageInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":398},"endTime":{"type":"string","example":"1664148997536"},"startTime":{"type":"string","example":"1664159158463"}}},"DataCenter":{"type":"object","properties":{"dcPersonality":{"type":"string"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Node"}},"mgmtIPAddress":{"type":"string"},"name":{"type":"string"},"nmsPersonality":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"}}},"DataCenterRegistration":{"type":"object","properties":{"clusterEncKey":{"type":"string"},"clusterEnvKey":{"type":"string","writeOnly":true},"dataCenters":{"type":"array","items":{"$ref":"#/components/schemas/DataCenter"}},"disasterRecoverySettings":{"$ref":"#/components/schemas/DisasterRecoverySettings"},"host":{"$ref":"#/components/schemas/Host"},"vbonds":{"type":"array","items":{"$ref":"#/components/schemas/Node"}},"vmanageRootCA":{"type":"string"}}},"DeleteAllListsBody":{"type":"object","properties":{"type":{"type":"string","example":"identity"}},"description":"Body for deleteAllLists call, generic api for deleting all lists of a specified listType"},"DeleteTenantBulkModel":{"type":"object","properties":{"password":{"type":"string"},"tenantIdList":{"type":"array","items":{"type":"string"}}}},"DeleteTenantModel":{"type":"object","properties":{"password":{"type":"string"}}},"DetachSitesRequestPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/DetachSitesRequestPayloadInner"}},"DetachSitesRequestPayloadInner":{"type":"object","properties":{"color":{"type":"string","example":"red"},"siteId":{"type":"string","example":"578"},"systemIp":{"type":"string","example":"1.1.1.178"}}},"DetailsForIdentityVerificationForSdoToken":{"required":["sdoSessionId"],"type":"object","properties":{"sdoSessionId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string","description":"Session ID generated by SDO Identity Service. Please use this GET API - '/v1/securedeviceonboarding/getUrlForSdoIdentityService'to get URL of this Secure Device Onboarding Identity Service.","example":"e01c5b71-b056-4602-b140-42221ccc3fec"}}},"Device":{"type":"object","properties":{"criteria":{"$ref":"#/components/schemas/Criteria"},"unsupportedFeatures":{"type":"array","items":{"$ref":"#/components/schemas/UnsupportedFeature"}}}},"DeviceAppDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppDetailResponseData"}},"header":{"$ref":"#/components/schemas/DeviceAppDetailResponseHeader"},"pageInfo":{"$ref":"#/components/schemas/DeviceAppDetailResponsePageInfo"}}},"DeviceAppDetailResponseData":{"type":"object","properties":{"application":{"type":"string","example":"skydrive"},"create_time":{"type":"number","example":1664442429015},"dest_ip":{"type":"string","example":"13.75.134.18"},"dest_port":{"type":"number","example":8248},"device_model":{"type":"string","example":"vedge-C8000V"},"entry_time":{"type":"number","example":1664442435015},"expire_time":{"type":"number","example":1664442441015},"family":{"type":"string","example":"web"},"host_name":{"type":"string","example":"vm5"},"id":{"type":"string","example":"782FiIMBjBC8ScfIzJ8_"},"ip_proto":{"type":"number","example":17},"octets":{"type":"number","example":1000000},"packets":{"type":"number","example":10000},"source_ip":{"type":"string","example":"12.166.184.245"},"source_port":{"type":"number","example":2},"vdevice_name":{"type":"string","example":"172.16.255.15"},"vip_idx":{"type":"number","example":1},"vpn_id":{"type":"number","example":1}}},"DeviceAppDetailResponseHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/DeviceAppDetailResponseHeaderChart"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderFields"}},"generatedOn":{"type":"number","example":1664508103301},"viewKeys":{"$ref":"#/components/schemas/DeviceAppDetailResponseHeaderViewKeys"}}},"DeviceAppDetailResponseHeaderChart":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.statistics.viewDpiDevicesDetails.dpiDeviceAppli"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.statistics.viewDpiDevicesDetails.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.statistics.viewDpiDevicesDetails.count"}}},"DeviceAppDetailResponseHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-dpi_devices_detials"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"DeviceAppDetailResponsePageInfo":{"type":"object","properties":{"count":{"type":"number","example":10000},"endTime":{"type":"string","example":"1664435237739"},"startTime":{"type":"string","example":"1664442435015"}}},"DeviceAppResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseData"}},"header":{"$ref":"#/components/schemas/DeviceAppResponseHeader"}}},"DeviceAppResponseData":{"type":"object","properties":{"octets":{"type":"number","example":25554477465},"vdevice_name":{"type":"string","example":"172.16.255.15"}}},"DeviceAppResponseHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/DeviceAppResponseHeaderChart"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderFields"}},"generatedOn":{"type":"number","example":1664507953669},"viewKeys":{"$ref":"#/components/schemas/DeviceAppResponseHeaderViewKeys"}}},"DeviceAppResponseHeaderChart":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.statistics.clientViewDpiDevices.dpiDevice"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiDevices.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiDevices.count"}}},"DeviceAppResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"property":{"type":"string","example":"vdevice_name"},"title":{"type":"string","example":"Devices"}}},"DeviceAppResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"property":{"type":"string","example":"vdevice_name"}}},"DeviceAppResponseHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-dpi_devices"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"DeviceBlistDeleteResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"message":{"type":"string"}},"description":"Device blist delete response schema"},"DeviceBlistResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Device blist response payload","items":{"$ref":"#/components/schemas/DeviceBlistResponsePayloadInner"}},"DeviceBlistResponsePayloadInner":{"type":"object","properties":{"crashTime":{"type":"integer","format":"int64"},"crashVersion":{"type":"string"},"crashedReason":{"type":"string"},"deviceBlistState":{"type":"string"},"deviceModel":{"type":"string"},"deviceName":{"type":"string"},"nwpiState":{"type":"string"},"siteId":{"type":"number"},"systemIp":{"type":"string"},"type":{"type":"number"}},"description":"Device blist response payload"},"DeviceCountersData":{"type":"object","properties":{"crashCount":{"type":"integer","format":"int32","example":0},"expectedControlConnections":{"type":"integer","format":"int32","example":3},"number-vsmart-control-connections":{"type":"integer","format":"int32","example":3},"rebootCount":{"type":"integer","format":"int32","example":2},"system-ip":{"type":"string"}}},"DeviceCountersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceCountersData"}},"header":{"$ref":"#/components/schemas/DeviceResponseHeader"}}},"DeviceCpuCount":{"type":"object","properties":{"attributeField":{"type":"string","example":"total_cpu_count"},"enable":{"type":"boolean","example":true}}},"DeviceData":{"type":"object","properties":{"board-serial":{"type":"string","example":"12345704"},"certificate-validity":{"type":"string","example":"Valid"},"connectedVManages":{"type":"array","items":{"type":"string"}},"controlConnections":{"type":"string","example":"9"},"device-groups":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"vmanage"},"device-os":{"type":"string","example":"device-os"},"device-type":{"type":"string","example":"vmanage"},"deviceId":{"type":"string","example":"169.254.10.1"},"domain-id":{"type":"string","example":"0"},"host-name":{"type":"string","example":"169.254.10.1"},"isDeviceGeoData":{"type":"boolean","example":false},"lastupdated":{"type":"string","example":"1634627015139"},"latitude":{"type":"string","example":"37.666684"},"layoutLevel":{"type":"integer","format":"int32","example":1},"local-system-ip":{"type":"string","example":"172.16.255.200"},"longitude":{"type":"string","example":"-122.777023"},"max-controllers":{"type":"string","example":"0"},"model_sku":{"type":"string","example":"None"},"personality":{"type":"string","example":"vmanage"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"200"},"state":{"type":"string","example":"green"},"state_description":{"type":"string","example":"All daemons up"},"status":{"type":"string","example":"normal"},"statusOrder":{"type":"string","example":"4"},"system-ip":{"type":"string","example":"169.254.10.1"},"testbed_mode":{"type":"boolean","example":true},"timezone":{"type":"string","example":"UTC"},"total_cpu_count":{"type":"string","example":"8"},"uptime-date":{"type":"string","example":"1634626320000"},"uuid":{"type":"string","example":"96af574a-eadd-4b6a-97bf-d5c1e98f40f2"},"validity":{"type":"string","example":"valid"},"version":{"type":"string","example":"9"}}},"DeviceHardwareHealthDetail":{"type":"object","properties":{"bfdSessions":{"type":"string","example":"3"},"board-serial":{"type":"string","example":"12346568"},"controlConnections":{"type":"string","example":"3"},"cpuLoadDisplay":{"type":"string","example":"39.27"},"device-model":{"type":"string","example":"vedge-cloud"},"device-type":{"type":"string","example":"vedge"},"hardwareState":{"type":"string","example":"normal"},"host-name":{"type":"string","example":"vm11"},"lastupdated":{"type":"integer","format":"int64","example":1635371851165},"local-system-ip":{"type":"string","example":"172.16.255.21"},"memUsageDisplay":{"type":"string","example":"52.0"},"number-vsmart-peers":{"type":"integer","format":"int32","example":2},"ompPeers":{"type":"string","example":"2"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"100"},"system-ip":{"type":"string","example":"172.16.255.21"},"uptime-date":{"type":"integer","format":"int64","example":1635324240000},"uuid":{"type":"string","example":"63e8518c-e76f-4d5f-a4c7-28ffb669526b"},"version":{"type":"string","example":"20.7.999-1133"}}},"DeviceHealthDetailItem":{"required":["cpu_load","health","health_score","host_name","memory_utilization","qoe","reachability","site_id","system_ip"],"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}}},"DeviceHealthDetails":{"type":"object","properties":{"bfd_sessions":{"type":"integer","format":"int32"},"bfd_sessions_up":{"type":"integer","format":"int32"},"board_serial_number":{"type":"string"},"chassis_number":{"type":"string"},"configGroupId":{"type":"string"},"configGroupName":{"type":"string"},"configuration_device":{"type":"boolean"},"connected_vmanages":{"type":"array","items":{"type":"string"}},"controlConnectionsToVsmat":{"$ref":"#/components/schemas/DeviceHealthDetails"},"control_connections":{"type":"integer","format":"int32"},"control_connections_up":{"type":"integer","format":"int32"},"cpu_load":{"type":"number","format":"double"},"device_groups":{"type":"array","items":{"type":"string"}},"device_model":{"type":"string"},"device_type":{"type":"string"},"expected_vsmart_connections":{"type":"integer","format":"int32"},"has_geo_data":{"type":"boolean"},"health":{"type":"string","enum":["red","yellow","green"]},"latitude":{"type":"string"},"local_system_ip":{"type":"string"},"location":{"type":"string"},"longitude":{"type":"string"},"memory_utilization":{"type":"number","format":"double"},"name":{"type":"string"},"omp_peers":{"type":"integer","format":"int64"},"omp_peers_up":{"type":"integer","format":"int64"},"personality":{"type":"string"},"policyGroupId":{"type":"string"},"policyGroupName":{"type":"string"},"qoe":{"type":"integer","format":"int32"},"reachability":{"type":"string"},"sdraSessionCounts":{"$ref":"#/components/schemas/DeviceHealthDetails"},"sdra_ipsec_anyconnect":{"type":"integer","format":"int64"},"sdra_ipsec_soho":{"type":"integer","format":"int64"},"sdra_ipsec_unknown":{"type":"integer","format":"int64"},"sdra_sslvpn_anyconnect":{"type":"integer","format":"int64"},"site_id":{"type":"string"},"site_name":{"type":"string"},"software_version":{"type":"string"},"system_ip":{"type":"string"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"total_tloc_num":{"type":"integer","format":"int64"},"up_tloc_num":{"type":"integer","format":"int64"},"uptime_date":{"type":"integer","format":"int64"},"uuid":{"type":"string"},"vpn_ids":{"type":"array","items":{"type":"string"}},"vsmart_control_connections":{"type":"integer","format":"int32"}}},"DeviceHealthEntryItem":{"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"entry_time":{"type":"number","example":1657780200000},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"}}},"DeviceHealthHistoryItem":{"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"history":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthEntryItem"}},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}}},"DeviceHealthOverview":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/DeviceHealthOverviewDetail"},"total":{"$ref":"#/components/schemas/DeviceHealthOverviewTotal"}}},"DeviceHealthOverviewDetail":{"type":"object","properties":{"fair":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetailItem"}},"good":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetailItem"}},"poor":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetailItem"}}}},"DeviceHealthOverviewTotal":{"type":"object","properties":{"fair":{"type":"number","example":100},"good":{"type":"number","example":100},"poor":{"type":"number","example":100}}},"DeviceIP":{"type":"object","properties":{"deviceIp":{"type":"string"}},"description":"This is the valid DeviceIP"},"DeviceInfoExtendedResponse":{"type":"object","properties":{"cloudGatewayName":{"type":"string"},"configStatusMessage":{"type":"string"},"configuredSystemIP":{"type":"string"},"device-model":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"system-ip":{"type":"string"},"uptime-date":{"type":"number"},"uuid":{"type":"string"},"version":{"type":"string"}}},"DeviceInfoResponsePayloadData":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadDataDevices"}},"interfaces":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadDataInterfaces"}},"models":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadDataModels"}}}},"DeviceInfoResponsePayloadDataDevices":{"type":"object","properties":{"device-model":{"type":"string"},"device-type":{"type":"string"},"deviceId":{"type":"string"},"host-name":{"type":"string"},"latitude":{"type":"string"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"longitude":{"type":"string"},"site-id":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"DeviceInfoResponsePayloadDataInterfaces":{"type":"object","properties":{"ifname":{"type":"string"},"vdevice-host-name":{"type":"string"},"vdevice-name":{"type":"string"},"vpn-id":{"type":"string"}}},"DeviceInfoResponsePayloadDataModels":{"type":"object","properties":{"deviceClass":{"type":"string"},"name":{"type":"string"}}},"DeviceInterface":{"type":"object","properties":{"day0":{"type":"array","example":["GigabitEthernet0/0/0"],"items":{"type":"string","example":"[\"GigabitEthernet0/0/0\"]"}},"lan":{"type":"array","example":["GigabitEthernet","TenGigabitEthernet","Loopback"],"items":{"type":"string","example":"[\"GigabitEthernet\",\"TenGigabitEthernet\",\"Loopback\"]"}},"mgmt":{"type":"array","example":["GigabitEthernet","TenGigabitEthernet","Loopback"],"items":{"type":"string","example":"[\"GigabitEthernet\",\"TenGigabitEthernet\",\"Loopback\"]"}},"wan":{"type":"array","example":["GigabitEthernet","TenGigabitEthernet","Loopback"],"items":{"type":"string","example":"[\"GigabitEthernet\",\"TenGigabitEthernet\",\"Loopback\"]"}}}},"DeviceList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"DeviceLists":{"required":["entry_time"],"type":"object","properties":{"device_ip":{"type":"string","example":"1.1.1.1"},"entry_time":{"type":"integer","format":"int64","example":1639897200000},"host_name":{"type":"string","example":"vm1"},"site_name":{"type":"string","example":"sjc"}}},"DeviceModel":{"type":"object","properties":{"deviceModel":{"type":"string"}},"description":"This is the valid DeviceModel "},"DeviceModelsData":{"type":"object","properties":{"cpuCountAttribute":{"$ref":"#/components/schemas/DeviceCpuCount"},"deviceClass":{"type":"string","example":"cisco-router"},"deviceType":{"type":"string","example":"vedge"},"displayName":{"type":"string","example":"ISR4461"},"interfaces":{"$ref":"#/components/schemas/DeviceInterface"},"isCliSupported":{"type":"boolean","example":true},"name":{"type":"string","example":"vedge-ISR-4461"},"onboardCert":{"type":"boolean","example":true},"templateClass":{"type":"string","example":"cedge"},"templateSupported":{"type":"boolean","example":true}}},"DeviceModelsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceModelsData"}},"header":{"$ref":"#/components/schemas/DeviceResponseHeader"}}},"DeviceReachableData":{"type":"object","properties":{"availableVersions":{"type":"array","items":{"type":"string"}},"board-serial":{"type":"integer","format":"int64"},"board_type":{"type":"string"},"bootloader_version":{"type":"string"},"build_number":{"type":"integer","format":"int64"},"certificate-not-valid-after":{"type":"string"},"certificate-not-valid-before":{"type":"string"},"certificate-status":{"type":"string"},"certificate-validity":{"type":"string"},"chassis-number":{"type":"string"},"chassis-serial-number":{"type":"number","format":"float"},"connectedVManages":{"type":"array","items":{"type":"string"}},"controlConnections":{"type":"integer","format":"int64"},"controlConnectionsDown":{"type":"integer","format":"int32"},"controlConnectionsUp":{"type":"integer","format":"int64"},"cpuLoadDisplay":{"type":"number","format":"float"},"cpuState":{"type":"string"},"defaultVersion":{"type":"string"},"device-category":{"type":"string"},"device-groups":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string"},"device-os":{"type":"string"},"device-type":{"type":"string","example":"9"},"deviceId":{"type":"string"},"domain-id":{"type":"integer","format":"int32"},"expectedControlConnections":{"type":"integer","format":"int64"},"fips_mode":{"type":"string"},"firmwareAvailablePackages":{"type":"array","items":{"type":"string"}},"firmwareAvailableVersions":{"type":"array","items":{"type":"string"}},"firmwareVersion":{"type":"string"},"grid":{"type":"integer","format":"int32"},"groupId":{"type":"array","items":{"type":"string"}},"hardwareState":{"type":"string"},"hasGeoData":{"type":"boolean"},"host-name":{"type":"string"},"isDeviceGeoData":{"type":"boolean"},"lastDataSyncTime":{"type":"integer","format":"int64"},"lastupdated":{"type":"integer","format":"int64"},"latitude":{"type":"string"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"longitude":{"type":"string"},"memStatenormal":{"type":"string"},"memUsage":{"type":"integer","format":"int32"},"memUsageDisplay":{"type":"integer","format":"int32"},"model_sku":{"type":"string"},"mpPeers":{"type":"integer","format":"int32"},"name":{"type":"string"},"number-vbond-peers":{"type":"integer","format":"int32"},"number-vsmart-control-connections":{"type":"integer","format":"int64"},"number-vsmart-peers":{"type":"integer","format":"int64"},"ompPeersDown":{"type":"integer","format":"int64"},"ompPeersUp":{"type":"integer","format":"int32"},"organization-name":{"type":"string"},"personality":{"type":"string"},"platform":{"type":"string"},"policy-template-nam":{"type":"string"},"policy-template-name":{"type":"string"},"policy-template-version":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"integer","format":"int32"},"sp-organization-name":{"type":"string"},"state":{"type":"string"},"state_description":{"type":"string"},"status":{"type":"string"},"statusOrder":{"type":"integer","format":"int32"},"syncCompleted":{"type":"integer","format":"int64"},"syncQueued":{"type":"integer","format":"int64"},"syncScheduled":{"type":"integer","format":"int64"},"syncState":{"type":"string"},"system-ip":{"type":"string"},"testbed_mode":{"type":"boolean"},"timezone":{"type":"string"},"token":{"type":"string"},"total_cpu_count":{"type":"integer","format":"int64"},"uptime":{"type":"string"},"uptime-date":{"type":"integer","format":"int64"},"uuid":{"type":"string"},"vbond":{"type":"string"},"vedge-list-version":{"type":"integer","format":"int32"},"version":{"type":"string"},"vmanage-system-ip":{"type":"string"},"vmanageConnectionState":{"type":"string"},"vsmart-list-version":{"type":"integer","format":"int32","example":0}}},"DeviceResponseHeader":{"type":"object","properties":{"generatedOn":{"type":"integer","format":"int64","example":1635224742597}}},"DeviceStatusData":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":0},"detailsURL":{"type":"string","example":"/dataservice/device?personality=vbond&status=error"},"image":{"type":"string","example":"images/vsmart.png"},"name":{"type":"string","example":"vSmart"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/StatusList"}},"type":{"type":"string","example":"vSmart"}}},"DeviceTaskStatus":{"type":"object","properties":{"tasks":{"type":"string","example":"123"}},"description":"List of tasks"},"DeviceTlocDataWithBFD":{"type":"object","properties":{"bfdSessionsDown":{"type":"integer","format":"int32","example":0},"bfdSessionsUp":{"type":"integer","format":"int32","example":5},"color":{"type":"string","example":"red"},"controlConnectionsDown":{"type":"string","example":"vmanage"},"controlConnectionsUp":{"type":"integer","format":"int32","example":2},"system-ip":{"type":"string","example":"169.254.10.1"}}},"DeviceType":{"type":"object","properties":{"deviceType":{"type":"string"}},"description":"This is valid device type "},"DeviceUsageDetails":{"required":["carrierName","communicationPlan","controllerId","currentDataUsage","iccid","ratePlan","ratePlanType","slotId"],"type":"object","properties":{"carrierName":{"type":"string","description":"Name of the service provider.","example":"Singtel"},"communicationPlan":{"type":"string","description":"Name of the communication plan.","example":"vm cp sms data share"},"controllerId":{"type":"string","description":"Controller Id","example":"1"},"currentDataUsage":{"type":"string","description":"Current Data Usage.","example":"10MB"},"errorDetails":{"type":"string","description":"Details of any error encountered while retrieving device data usage","example":"No eSIM ICCIDs found"},"iccid":{"type":"string","description":"Identifier of the eSIM device.","example":"8988216716970004975"},"isBootstrap":{"type":"boolean","description":"Boolean flag that indicated if ICCID is on bootstrap account"},"otherEsimsDataUsage":{"type":"string","description":"Total data used by other eSIM devices.","example":"20MB"},"ratePlan":{"type":"string","description":"Name of the rate plan.","example":"vm fixed pool rp"},"ratePlanDataUsageLimit":{"type":"string","description":"Rate plan usage limit.","example":"50MB"},"ratePlanType":{"type":"string","description":"Rate plan type.","example":"Monthly - Pooled Subscriber"},"slotId":{"type":"integer","description":"Slot Id","format":"int32"},"totalDataUsage":{"type":"string","description":"Total data usage","example":"30MB"},"usageThresholdWarning":{"type":"string","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%."}}},"DeviceUuid":{"type":"object","properties":{"deviceUuid":{"type":"string"}},"description":"This is valid DeviceUuid"},"DeviceVmanageResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeviceVmanageResponseData"},"header":{"$ref":"#/components/schemas/DeviceResponseHeader"}}},"DeviceVmanageResponseData":{"type":"object","properties":{"ipAddress":{"type":"string"}}},"DevicesHealth":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetails"}},"header":{"type":"object","additionalProperties":{"type":"object"}},"total_devices":{"type":"integer","format":"int32"}}},"DevicesHealthOverview":{"type":"object","properties":{"fair":{"type":"integer","format":"int32"},"good":{"type":"integer","format":"int32"},"poor":{"type":"integer","format":"int32"}}},"DisabledAlarmDetails":{"type":"object","properties":{"endTime":{"type":"string","example":"2022-06-06 10:50:05 UTC"},"eventName":{"type":"string","example":"bfd-state-change"},"startTime":{"type":"string","example":"2022-06-06 09:50:05 UTC"}}},"DisasterRecoverySettings":{"type":"object","properties":{"delayThreshold":{"type":"integer","format":"int32"},"drPaused":{"type":"boolean"},"ignoredIndexes":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer","format":"int32"},"intervalModified":{"type":"boolean"},"pauseDR":{"$ref":"#/components/schemas/DisasterRecoverySettings"},"pauseReplication":{"type":"boolean"},"startTime":{"type":"string"}}},"DnaSenseResponse":{"type":"object","properties":{"html":{"type":"string","description":"Sense Post Contents","example":"Documentation for Monitor Overview..."}},"description":"Dna Sense Response"},"DomainDetail":{"type":"object","properties":{"domain":{"type":"string"},"resolvedIp":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"ERSActiveDirectoryGroups":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/UsergroupObject"}}}},"ERSActiveDirectoryUsers":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserObject"}}}},"EnrollOTPResponse":{"type":"object","properties":{"authToken":{"type":"string"},"cdnaServerIP":{"type":"string"},"cline_id":{"type":"string"},"enrolled":{"type":"boolean"},"lastUpdated":{"type":"string"},"member_id":{"type":"string"},"token_url":{"type":"string"}},"description":"Enroll CDNA Server Response."},"EnrollOTPSettings":{"type":"object","properties":{"token":{"type":"string"}}},"EntityOwnershipInfo":{"type":"object","properties":{"bucket":{"type":"string"},"entityName":{"type":"string"},"owner":{"type":"string"}}},"Entry":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"EquinixCredentials":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"}}},"EquinixLocationInfo":{"type":"object","properties":{"eqBillingAccountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/MultiCloudEdgeBillingAccountInfo"}},"eqNEInfo":{"$ref":"#/components/schemas/EquinixNEInfo"},"metroCode":{"type":"string"},"metroName":{"type":"string"},"networkRegion":{"type":"string"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"EquinixNEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","items":{"type":"string"}},"productSizeList":{"type":"array","items":{"type":"string"}}}},"EquinixPartnerPort":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string"},"connectType":{"type":"string"},"productUid":{"type":"string"},"speed":{"type":"string"},"vxcId":{"type":"string"},"vxcPermitted":{"type":"boolean"}}},"Ethernet":{"required":["ethernetInterfaceList","name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"ethernetInterfaceList":{"type":"array","items":{"$ref":"#/components/schemas/EthernetInterface"}}}}]},"EthernetInterface":{"required":["interfaceName","portType"],"type":"object","properties":{"aaaServerInfo":{"$ref":"#/components/schemas/AaaServerInfo"},"adminState":{"pattern":"(enabled|disabled)","type":"string"},"corporateLan":{"type":"boolean"},"interfaceName":{"pattern":"(^GigabitEthernet0/0$|^GigabitEthernet0/1$|^GigabitEthernet0/2$)","type":"string"},"ipAssignment":{"pattern":"(dynamic|static)","type":"string"},"ipv6Assignment":{"pattern":"(AutoConfig-SLAC)","type":"string"},"portType":{"pattern":"(LAN|WAN)","type":"string"},"staticIpAddress":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"staticIpAddressSubnetMask":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"staticRouteIp":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"wanConfiguration":{"pattern":"(Active)","type":"string"}}},"EventName":{"type":"object","properties":{"eventName":{"type":"string"}},"description":"This is valid eventName"},"EventQueryInputResponse":{"type":"object","properties":{"component":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"severityOptions":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"timeOptions":{"type":"array","items":{"$ref":"#/components/schemas/TimeOptions"}}}},"EventReadoutsResponsePayloadData":{"type":"object","properties":{"app":{"type":"string"},"app_grp":{"type":"string"},"app_vis":{"type":"string"},"art_vis":{"type":"string"},"common_app":{"type":"string"},"detail":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadDetail"}},"device_ip":{"type":"string"},"dia_vis":{"type":"string"},"domain_mon":{"type":"string"},"dscp":{"type":"string"},"dst_ip":{"type":"string"},"dst_pfx":{"type":"string"},"dst_pfx_len":{"type":"string"},"dst_port":{"type":"string"},"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"hub_wan_vis":{"type":"string"},"local_drop_rate_threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos_mon":{"type":"string"},"sampling":{"type":"string"},"source_site":{"type":"string"},"source_site_vmanage_version":{"type":"string"},"spl_intvl":{"type":"string"},"src_if":{"type":"string"},"src_ip":{"type":"string"},"src_pfx":{"type":"string"},"src_pfx_len":{"type":"string"},"src_port":{"type":"string"},"state":{"type":"string"},"stop_time":{"type":"integer","format":"int64"},"trace_id":{"type":"integer","format":"int32"},"trace_name":{"type":"string"},"vpn_id":{"type":"string"},"wan_drop_rate_threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}}},"EventReadoutsResponsePayloadDetail":{"type":"object","properties":{"application":{"type":"string"},"dropSendPkts":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadDropSendPkts"}},"eventHopPolicyInfo":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopTimeInfo"}},"eventHopStatistics":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopStatistics"}},"eventHopTimeInfo":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopTimeInfo"}},"eventImpactedFlowNum":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventImpactedFlowNum"}},"eventList":{"type":"array","items":{"type":"string"}},"eventNum":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventNum"}},"totalFlowNum":{"type":"integer","format":"int32"}}},"EventReadoutsResponsePayloadDropCauses":{"type":"object","properties":{"dropCause":{"type":"string"}}},"EventReadoutsResponsePayloadDropSendPkts":{"type":"object","properties":{"dropPkts":{"type":"integer","format":"int32"},"event":{"type":"string"},"sendPkts":{"type":"integer","format":"int32"}}},"EventReadoutsResponsePayloadEventHopStatistics":{"type":"object","properties":{"event":{"type":"string"},"hopStatistics":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadHopStatistics"}}}},"EventReadoutsResponsePayloadEventHopTimeInfo":{"type":"object","properties":{"eventHop":{"type":"string"},"eventHopWithEdge":{"type":"string"},"timeInfo":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadTimeInfo"}}}},"EventReadoutsResponsePayloadEventImpactedFlowNum":{"type":"object","properties":{"event":{"type":"string"},"impactedFlowNum":{"type":"string"}}},"EventReadoutsResponsePayloadEventNum":{"type":"object","properties":{"event":{"type":"string"},"eventNum":{"type":"string"}}},"EventReadoutsResponsePayloadHopStatistics":{"type":"object","properties":{"dropCauses":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadDropCauses"}},"eventNum":{"type":"string"},"hop":{"type":"string"},"hopWithEdge":{"type":"string"}}},"EventReadoutsResponsePayloadTimeInfo":{"type":"object","properties":{"endTime":{"type":"string"},"eventNum":{"type":"string"},"startTime":{"type":"string"}}},"EventSeverityResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/EventsBySeverity"}},"EventStats":{"type":"object","properties":{"Discarded Events":{"type":"integer","format":"int32","example":0},"Processed Events":{"type":"integer","format":"int32","example":0},"Total":{"type":"integer","format":"int32","example":0}}},"EventStatsDataResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadData1"}}},"description":"Event Stats Data schema for GET response"},"EventStatsDataResponsePayloadData":{"type":"object","properties":{"device_site_id":{"type":"string"},"event_stats_object":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadDataEventStatsObject"}}},"EventStatsDataResponsePayloadData1":{"type":"object","properties":{"auto-on-task-id":{"type":"integer","format":"int32"},"data":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadData"},"tenant":{"type":"string"},"type":{"type":"string"}}},"EventStatsDataResponsePayloadDataEventStatsObject":{"type":"object","properties":{"event_stats_list":{"type":"array","items":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadDataEventStatsObjectEventStatsList"}},"total_event_counter":{"type":"integer","format":"int32"}}},"EventStatsDataResponsePayloadDataEventStatsObjectEventStatsList":{"type":"object","properties":{"event_counter":{"type":"integer","format":"int32"},"event_failed_to_trace_counter":{"type":"integer","format":"int32"},"event_name":{"type":"string"},"event_to_trace_counter":{"type":"integer","format":"int32"}}},"EventsBySeverity":{"type":"object","properties":{"component":{"type":"string","example":"System"},"details":{"type":"string","example":"host-name=vm12; user-name=admin; user-id=2276"},"entry_time":{"type":"string"},"eventname":{"type":"string","example":"system-login-change"},"host_name":{"type":"string","example":"vm12"},"severity_level":{"type":"string","enum":["MINOR","MAJOR","MEDIUM","CRITICAL"]},"system_ip":{"type":"string","example":"172.16.255.22"}}},"ExecutiveSummaryReport":{"required":["reportName","scheduleConfig","timeRange"],"type":"object","properties":{"emailRecipient":{"maxItems":5,"minItems":0,"type":"array","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"],"items":{"type":"string","description":"Email address list to receive the report files","example":"[\"alice@cisco.com\",\"bob@google.com\"]"}},"reportName":{"maxLength":32,"minLength":1,"pattern":"(?=^.{1,32}$)[^&<>! \"]+$","type":"string","description":"Report Name","example":"ExecutiveSummaryReport"},"scheduleConfig":{"$ref":"#/components/schemas/ScheduleConfig"},"siteIds":{"type":"array","description":"Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.","example":[100,200],"items":{"type":"integer","format":"int64"}},"timeRange":{"type":"string","description":"Time range for report(one_week/one_month)","example":"one_week","enum":["one_week","one_month"]}},"description":"Executive summary report template"},"FeatureProfile":{"required":["name","solution","type"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the feature Profile.","example":"Profile file description"},"id":{"type":"string","description":"System generated unique identifier of the feature profile in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the feature Profile. Must be unique.","example":"system feature profile"},"solution":{"type":"string","description":"Solution of the feature Profile.","example":"sdwan"},"type":{"type":"string","description":"Type of the feature Profile.","example":"system"}},"description":"List of devices UUIDs associated with this group","example":"West coast retail store devices"},"FeatureTemplateType":{"type":"object","properties":{"umbrella":{"$ref":"#/components/schemas/Umbrella"}},"description":"Response from metaDataType API"},"FecAndPktDupResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"header":{"$ref":"#/components/schemas/FecAndPktDupResponseHeader"}}},"FecAndPktDupResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"string"}},"generatedOn":{"type":"number","example":1664508540280}}},"FirmwareImageRemoteUpgrade":{"type":"object","properties":{"action":{"type":"string","example":"firmwareupgrade"},"actionEnd":{"type":"string","example":"Wed Jan 12 03:00:00 IST 2023"},"actionEndMillis":{"type":"integer","format":"int32","example":1641936600000},"actionName":{"type":"string","example":"firmware_upgrade"},"actionStart":{"type":"string","example":"Tue Jan 11 23:00:00 IST 2023"},"actionStartMillis":{"type":"integer","format":"int32","example":1641922200000},"deviceType":{"type":"string","example":"vedge"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgradeDevices"}},"input":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgradeInput"},"timeZone":{"type":"string","example":"Asia/Kolkata"}}},"FirmwareImageRemoteUpgradeDevices":{"type":"object","properties":{"deviceIP":{"type":"string","example":"40.1.1.1"},"deviceId":{"type":"string","example":"CG113-4GW6B-KWC254402PM"}}},"FirmwareImageRemoteUpgradeInput":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgradeInputData"}},"versionType":{"type":"string","example":"remote"}}},"FirmwareImageRemoteUpgradeInputData":{"type":"object","properties":{"family":{"type":"string","example":"Teleworker"},"remoteServerId":{"type":"string","example":"192448a2-36bd-4f50-af04-03b428cd5a8f"},"version":{"type":"string","example":"875d4845-df12-4fdf-91f6-b73c601b2c3f"}}},"FlowInfoResponseData":{"type":"object","properties":{"app_group":{"type":"string"},"app_name":{"type":"string"},"appqoe_diverted":{"type":"boolean"},"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"big_drop":{"type":"boolean"},"big_wan_drop":{"type":"boolean"},"device_trace_id":{"type":"integer","format":"int32"},"domain":{"type":"array","items":{"type":"string"}},"domain_name":{"type":"string"},"domain_src":{"type":"string"},"downstream_device_list":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseDataDownstreamDeviceList"}},"downstream_dscp":{"type":"string"},"downstream_hop_list":{"$ref":"#/components/schemas/FlowInfoResponseDataDownstreamHopList"},"dpi_policy_used":{"type":"boolean"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"dst_sgt":{"type":"string"},"fif_dpi_not_classified":{"type":"boolean"},"flow_fin":{"type":"boolean"},"flow_id":{"type":"integer","format":"int32"},"flow_key":{"type":"string"},"flow_moved":{"type":"boolean"},"flow_readout":{"type":"object"},"max_local_drop_rate":{"type":"integer","format":"int32"},"max_wan_drop_rate":{"type":"integer","format":"int32"},"nat_translated":{"type":"boolean"},"path_changed":{"type":"boolean"},"policy_bypassed":{"type":"boolean"},"protocol":{"type":"string"},"qos_congested":{"type":"boolean"},"received_timestamp":{"type":"integer","format":"int64"},"server_no_response":{"type":"boolean"},"sla_violated":{"type":"boolean"},"sla_violated_bfd":{"type":"boolean"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"src_sgt":{"type":"string"},"start_device":{"type":"string"},"start_timestamp":{"type":"integer","format":"int64"},"tcp_flow_reset":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"},"upstream_device_list":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseDataUpstreamDeviceList"}},"upstream_dscp":{"type":"string"},"upstream_hop_list":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseDataUpstreamHopList"}},"utd_diverted":{"type":"boolean"},"vpn_id":{"type":"integer","format":"int32"},"wan_color_asym":{"type":"boolean"}}},"FlowInfoResponseDataDownstreamDeviceList":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"localColor":{"type":"string"},"remoteColor":{"type":"string"}}},"FlowInfoResponseDataDownstreamHopList":{"type":"object","properties":{"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"},"fif_dpi_not_classified":{"type":"boolean"}}},"FlowInfoResponseDataUpstreamDeviceList":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"ingress_pre_invalid":{"type":"boolean"}}},"FlowInfoResponseDataUpstreamHopList":{"type":"object","properties":{"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"}}},"FormPostResp":{"type":"object","properties":{"activityList":{"type":"string","example":"[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassisId, serial number): , - ESR-6300-LIC-K9-FAUSTEST126, 030557201979336385BE]"},"id":{"type":"string","example":"b5091b8e-e5ea-4096-8e4c-f17d0d60f2dd"},"vedgeListUploadMsg":{"type":"string","example":"Number of vEdges uploaded successfully: 1"},"vedgeListUploadStatus":{"type":"string","example":"vEdge list uploaded successfully"}}},"GatewayAssociation":{"type":"object","properties":{"advertisePrefixList":{"type":"array","example":["10.10.0.0/24","10.20.0.0/24"],"items":{"type":"string","example":"[\"10.10.0.0/24\",\"10.20.0.0/24\"]"}},"associatedGateway":{"$ref":"#/components/schemas/GatewayAssociationAssociatedGateway"},"associationAction":{"type":"string","example":"ASSOCIATE","enum":["ASSOCIATE","DISASSOCIATE","REMOVE_PREFIX_LIST","NO_ACTION"]},"associationId":{"type":"string","example":"12345"},"associationState":{"type":"string","example":"ASSOCIATED"},"stateChangeError":{"type":"string"}},"description":"Generic multicloud gateway association object"},"GatewayAssociationAssociatedGateway":{"type":"object","properties":{"cloudAccountId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AZURE","GCP"]},"description":{"type":"string"},"gatewayId":{"type":"string"},"gatewayName":{"type":"string"},"region":{"type":"string"}},"description":"Cloud Connectivity Gateway Object"},"GatewaysPushconfigBody":{"type":"object","properties":{"edgeGatewayName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}},"GcpCloudRouter":{"type":"object","properties":{"attachmentDetails":{"type":"array","description":"List of GCR Attachments","items":{"$ref":"#/components/schemas/GcpInterconnectAttachment"}},"cloudRouterAsn":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"network":{"type":"string"},"region":{"type":"string"}},"description":"Google cloud GCR Object."},"GcpCredentials":{"type":"object","properties":{"auth_provider_x509_cert_url":{"type":"string"},"auth_uri":{"type":"string"},"client_email":{"type":"string"},"client_id":{"type":"string"},"client_x509_cert_url":{"type":"string"},"private_key":{"type":"string"},"private_key_id":{"type":"string"},"project_id":{"type":"string"},"token_uri":{"type":"string"},"type":{"type":"string"}}},"GcpInterconnectAttachment":{"type":"object","properties":{"cloudRouterIpAddress":{"type":"string"},"customerIpAddress":{"type":"string"},"id":{"type":"string"},"mtu":{"type":"string","description":"MTU of the Interconnect attachment","example":"1500"},"name":{"type":"string"},"pairingKey":{"type":"string","example":"96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1"},"region":{"type":"string"},"secondaryZone":{"type":"boolean","description":"Option to create Interconnect attachment in secondary zone","example":true},"state":{"type":"string"}},"description":"Google cloud Interconnect Attachment Object."},"GeneralSchema":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"GetAccounts":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"clientEmail":{"type":"string"},"cloudGatewayEnabled":{"type":"boolean"},"cloudType":{"type":"string"},"credType":{"type":"string"},"description":{"type":"string"},"gcpBillingId":{"type":"string"},"privateKeyId":{"type":"string"},"regionList":{"type":"string"},"serviceDiscoveryEnabled":{"type":"boolean"}}},"GetAuditLogAggregation":{"required":["header"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"entryTimeList":{"type":"array","items":{"type":"string"}},"header":{"$ref":"#/components/schemas/AuditLogHeader"}}},"GetAuditLogBySeverity":{"required":["data","header"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"header":{"$ref":"#/components/schemas/AuditLogHeader"},"total_records":{"type":"integer","format":"int32","example":2}}},"GetAuditLogData":{"required":["data","header"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"header":{"$ref":"#/components/schemas/AuditLogHeader"}}},"GetAuditLogDoccount":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":44}}},"GetMapResponse":{"type":"object","properties":{"conn":{"type":"string"},"destId":{"type":"string"},"destType":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"}}},"GetMslaDevicesPayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetSingleMslaDevicePayload"}}}},"GetRegions":{"type":"object","properties":{"cloudType":{"type":"string"},"regionList":{"type":"string"}}},"GetSingleMslaDevicePayload":{"type":"object","properties":{"License_status":{"type":"string","example":"subscribed"},"UUID":{"type":"string","example":"d8ac4576-7085-4d51-a6a1-f09600755677"},"configuredSystemIP":{"type":"string","example":"172.16.254.3"},"deviceModel":{"type":"string","example":"vedge-cloud"},"hostName":{"type":"string","example":"vm4"},"hsecCompatible":{"type":"string","example":"No"},"hsecStatus":{"type":"string","example":"-"},"licenseType":{"type":"string","example":"prepaid"},"licenses":{"type":"array","items":{"type":"string"}},"msla":{"type":"string","example":"false"},"saAccount":{"type":"string","example":"316448"},"saNamme":{"type":"string","example":"testaccount1.viptela.com"},"subscription_id":{"type":"array","items":{"type":"string"}},"tag":{"type":"array","items":{"type":"string"}},"templateName":{"type":"string","example":"t1"},"vaAccount":{"type":"array","items":{"type":"string"}},"vaName":{"type":"string","example":"vManage_SDWAN_01"}}},"GetSitesResponse":{"type":"object","properties":{"acceleratedVpn":{"type":"boolean"},"aggTunnelStatus":{"type":"string"},"attached":{"type":"boolean"},"color":{"type":"string"},"hostname":{"type":"string"},"interface":{"type":"string"},"privateIp":{"type":"string"},"publicIp":{"type":"string"},"siteId":{"type":"string"},"systemIp":{"type":"string"},"tunnelCount":{"type":"number"},"tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"$ref":"#/components/schemas/TunnelsInner"}},"uuid":{"type":"string"}}},"GetStatDataFieldArray":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetStatDataFields"}},"GetStatDataFields":{"type":"object","properties":{"dataType":{"type":"string","example":"date"},"property":{"type":"string","example":"entry_time"}}},"GetStatQueryFieldArray":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetStatQueryFields"}},"GetStatQueryFieldOptions":{"required":["key","value"],"type":"object","properties":{"enableDateFields":{"type":"boolean","example":true},"isSelected":{"type":"boolean","example":true},"key":{"type":"string","example":"last_1_hour"},"number":{"type":"string","example":"1"},"value":{"type":"string","example":"Last 1 hour"}}},"GetStatQueryFields":{"required":["dataType","isRequired","multiSelect","name","property"],"type":"object","properties":{"dataType":{"type":"string","example":"date"},"fieldData":{"$ref":"#/components/schemas/GetStatQueryFieldsFieldData"},"isRequired":{"type":"boolean","example":true},"multiSelect":{"type":"boolean","example":true},"name":{"type":"string","example":"vmanage.server.auditlog.auditLogTime"},"options":{"type":"array","items":{"$ref":"#/components/schemas/GetStatQueryFieldOptions"}},"property":{"type":"string","example":"entry_time"}}},"GetStatQueryFieldsFieldData":{"type":"object","properties":{"type":{"type":"string","example":"dateList"}}},"GetTagRulesResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetTagRulesResponseInner"}},"GetTagRulesResponseInner":{"type":"object","properties":{"deviceAttribute":{"type":"string"},"rule":{"type":"string"},"tagId":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"GetTunnelsResponse":{"type":"object","properties":{"Private IP":{"type":"array","items":{"$ref":"#/components/schemas/GetTunnelsResponsePrivateIP"}}}},"GetTunnelsResponsePrivateIP":{"type":"object","properties":{"hostname":{"type":"string"},"tunnels":{"type":"string"}}},"GlobalSettings":{"type":"object","properties":{"accountId":{"type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"cgwBgpAsnOffset":{"type":"integer","description":"Used for GCP, AWS and AWS GovCloud Global settings","format":"int32"},"cloudGatewaySolution":{"type":"string"},"cloudType":{"type":"string"},"enableAutoCorrect":{"type":"boolean"},"enableDefRouteAdvertize":{"type":"boolean","description":"Used for Azure Global settings"},"enableMonitoring":{"type":"boolean","description":"Used for Azure Global settings"},"enablePeriodicAudit":{"type":"boolean"},"instanceSize":{"type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"intraTagComm":{"type":"boolean"},"ipSubnetPool":{"type":"string"},"mapTvpc":{"type":"boolean","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"name":{"type":"string"},"networkTier":{"type":"string","description":"Used for GCP Global settings"},"orgBgpAsn":{"type":"string","description":"Used for GCP, Azure and Azure GovCloud Global settings"},"policyManagement":{"type":"boolean","description":"Used for GCP Global settings"},"programDefaultRoute":{"type":"boolean","description":"Used for AWS/AWS GovCloud Global settings"},"region":{"type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"serviceDirPollTimer":{"type":"integer","description":"Used for GCP Global settings","format":"int32"},"skuScaleUnit":{"type":"integer","description":"Used for Azure/Azure GovCloud Global settings","format":"int32"},"softwareImageId":{"type":"string"},"tunnelCount":{"type":"integer","description":"Used for AWS/AWS GovCloud Global settings","format":"int32"},"tunnelType":{"type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"}}},"GroupId":{"type":"object","properties":{"groupId":{"type":"string"}},"description":"This is the valid GroupId"},"GuestWifi":{"type":"object","properties":{"securityAuthType":{"pattern":"(OPEN|WPA2-PSK_AES)","type":"string"},"ssid":{"maxLength":32,"minLength":1,"type":"string"},"visibility":{"type":"boolean"},"wpaPskKey":{"type":"string"}}},"GwDeviceSiteIds":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"integer","format":"int64"}},"GwDeviceStatus":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"},"statusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}},"unreachableCount":{"type":"integer","format":"int64"}}},"GwSiteStatus":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"},"statusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}}}},"GwStatus":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"},"statusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}}}},"HandleFileGenerationStatusNotificationRequest":{"required":["detailedMessage","status","transactionId"],"type":"object","properties":{"checksum":{"type":"string","description":"MD5 checksum value of the file"},"detailedMessage":{"type":"string","description":"Success or Failure reason in detail"},"fileName":{"type":"string","description":"Full path of the generated file"},"status":{"type":"string"},"transactionId":{"type":"string","description":"Transaction Id sent in the file generation RPC"}}},"Header":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/HeaderElement"}},"name":{"type":"string"},"value":{"type":"string"}}},"HeaderElement":{"type":"object","properties":{"name":{"type":"string"},"parameterCount":{"type":"integer","format":"int32"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}},"value":{"type":"string"}}},"HeaderObject":{"type":"object","properties":{"columns":{"type":"object","example":{}},"fields":{"type":"object","example":{}},"generatedOn":{"type":"integer","format":"int32","example":1643067620683},"viewKeys":{"type":"object","example":{}}},"description":"Header for Response"},"Host":{"type":"object","properties":{"dataCenterName":{"type":"string"},"dcPersonality":{"type":"string"},"ifname":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"},"serialno":{"type":"string"}}},"HostVpcTagPost":{"type":"object","properties":{"hostVpcs":{"type":"array","description":"Used for AWS, AWS GovCloud and GCP cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPostHostVpcsItems"}},"interconnectTag":{"type":"boolean"},"tagName":{"type":"string"},"vnets":{"type":"array","description":"Used for Azure and Azure GovCloud cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPostVnetsItems"}}}},"HostVpcTagPut":{"type":"object","properties":{"hostVpcs":{"type":"array","description":"Used for AWS, AWS GovCloud and GCP cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPutHostVpcsItems"}},"interconnectTag":{"type":"boolean"},"tagName":{"type":"string"},"vnets":{"type":"array","description":"Used for Azure and Azure GovCloud cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPutVnetsItems"}}}},"HostVpcTagResponse":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"hostVpcId":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"region":{"type":"string"},"resourceGroups":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"tag":{"type":"string"},"vnetId":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"}}},"HostVpcsResponse":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"hostVpcId":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"region":{"type":"string"},"resourceGroups":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetId":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"type":"string","description":"Used for Azure and Azure GovCloud cloud types"}}},"HttpError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Message about bad request or parameters errors"},"errorType":{"type":"string","description":"Type of error"},"operation":{"type":"string","description":"Operation title"}}},"IDPInfo":{"type":"object","properties":{"domains":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"idpMetadata":{"type":"string"},"mode":{"type":"string"}}},"Image":{"type":"object","properties":{"image":{"type":"string"}},"description":"This is the valid Image type "},"ImageData":{"type":"object","properties":{"applicationVendor":{"type":"string"},"applicationVendorVendor":{"type":"string","writeOnly":true},"arch":{"type":"string"},"controllerVersion":{"type":"string"},"cwVersion":{"type":"string"},"description":{"type":"string"},"displayChecksum":{"type":"string"},"displayChecksumType":{"type":"string"},"displayChecksumValidity":{"type":"string"},"family":{"type":"string"},"fileEntries":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"fileSizeStr":{"type":"string"},"fileSizebyte":{"type":"string"},"imagePropertiesJson":{"type":"string"},"imageType":{"type":"string","enum":["ImageType{type='software'}","ImageType{type='container'}","ImageType{type='lxc'}","ImageType{type='virtualmachine'}","ImageType{type='virtualmachine-diskimg'}","ImageType{type='virtualmachine-scaffold'}","ImageType{type='utdsignature'}","ImageType{type='utdsignatureips'}","ImageType{type='utdsignaturecustom'}","ImageType{type='waas'}","ImageType{type='dockertype'}","ImageType{type='firmware'}","ImageType{type='rumreport'}","ImageType{type='licensefile'}","ImageType{type='ackfile'}","ImageType{type='na'}"]},"imageTypeName":{"type":"string"},"md5Checksum":{"type":"string"},"networkFunctionType":{"type":"string"},"remoteServerId":{"type":"string"},"remoteServers":{"type":"string"},"sha256Checksum":{"type":"string"},"sha512Checksum":{"type":"string"},"smuDefectId":{"type":"string"},"smuDescription":{"type":"string"},"smuType":{"type":"string"},"storageData":{"type":"string"},"systemPropertiesXml":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tempImagePath":{"type":"string"},"updatedFileName":{"type":"string"},"version":{"type":"string"},"versionTypeName":{"type":"string"},"vnfPropertiesJson":{"type":"string"}}},"InProgressCount":{"type":"object","properties":{"inProgressCount":{"type":"integer","format":"int32","example":5}}},"InitBlob":{"type":"object","properties":{"vmanage_init_blob":{"$ref":"#/components/schemas/InitBlobVmanageInitBlob"}}},"InitBlobVmanageInitBlob":{"required":["internalCredentials","jwtCredentials","mode","pnp"],"type":"object","properties":{"internalCredentials":{"$ref":"#/components/schemas/InitBlobVmanageInitBlobInternalCredentials"},"jwtCredentials":{"$ref":"#/components/schemas/InitBlobVmanageInitBlobJwtCredentials"},"mode":{"type":"string","description":"vManage Mode","enum":["SDWANaaS","default"]},"pnp":{"$ref":"#/components/schemas/InitBlobVmanageInitBlobPnp"},"sdwanPortalUrl":{"type":"string","description":"SDWAN Portal Url"},"webhookUrl":{"type":"string","description":"Webhook Url to send notifications"}}},"InitBlobVmanageInitBlobInternalCredentials":{"required":["password","resetUrl","userName"],"type":"object","properties":{"password":{"type":"string","description":"password"},"resetUrl":{"type":"string","description":"Url to reset credentials"},"userName":{"type":"string","description":"userName"}}},"InitBlobVmanageInitBlobJwtCredentials":{"required":["client_id","client_secret","resetUrl","tokenUrl"],"type":"object","properties":{"client_id":{"type":"string","description":"client id"},"client_secret":{"type":"string","description":"client secret"},"resetUrl":{"type":"string","description":"Url to reset credentials"},"tokenUrl":{"type":"string","description":"Url to fetch token"}}},"InitBlobVmanageInitBlobPnp":{"required":["client_id","client_secret","resetUrl"],"type":"object","properties":{"client_id":{"type":"string","description":"client id"},"client_secret":{"type":"string","description":"client secret"},"env":{"type":"string","description":"PnP environment","enum":["STAGING","PROD_STAGING","PRODUCTION"]},"resetUrl":{"type":"string","description":"Url to reset credentials"}}},"InitiateFileGenerationRequest":{"required":["deviceUUID","requestedFileFormat","statsCommand"],"type":"object","properties":{"deviceUUID":{"type":"string","description":"UUID of the device"},"requestedFileFormat":{"type":"string"},"statsCommand":{"type":"string"}}},"InlineResponse200":{"type":"object","properties":{"data":{"type":"array","example":["MEGAPORT","EQUINIX"],"items":{"type":"string","example":"[\"MEGAPORT\",\"EQUINIX\"]"}}}},"InlineResponse2001":{"type":"object","properties":{"edgeBillingAccountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectBillingAccountInfo"}}}},"InlineResponse20010":{"type":"object","properties":{"gcpCloudRouters":{"type":"array","items":{"$ref":"#/components/schemas/GcpCloudRouter"}}}},"InlineResponse20011":{"type":"object","properties":{"portSpeeds":{"type":"array","description":"Supported speeds","example":["50, 100"],"items":{"type":"string","description":"Supported speeds","example":"[\"50, 100\"]"}}}},"InlineResponse20013":{"type":"object","properties":{"creationOptions":{"$ref":"#/components/schemas/InlineResponse20013CreationOptions"}}},"InlineResponse20013CreationOptions":{"type":"object","properties":{"expressRouteCircuitServiceProviderList":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse20013CreationOptionsExpressRouteCircuitServiceProviderList"}},"resourceGroupList":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse20013CreationOptionsResourceGroupList"}}}},"InlineResponse20013CreationOptionsExpressRouteCircuitServiceProviderList":{"type":"object","properties":{"bandwidthsOffered":{"type":"array","example":[50,100,200],"items":{"type":"integer","format":"int64"}},"id":{"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"peeringLocations":{"type":"array","items":{"type":"string"}},"provisioningState":{"type":"string","description":"Provisioning state of the resource","example":"Succeeded"},"type":{"type":"string","description":"Type of Resource","example":"/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/"}}},"InlineResponse20013CreationOptionsResourceGroupList":{"type":"object","properties":{"id":{"type":"string"},"location":{"type":"string"},"name":{"type":"string"}}},"InlineResponse2002":{"type":"object","properties":{"loopbackCgwColor":{"type":"array","example":["gold","biz-internet","private1","private2"],"items":{"type":"string","example":"[\"gold\",\"biz-internet\",\"private1\",\"private2\"]"}},"loopbackTunnelColor":{"type":"array","example":["gold","biz-internet","private1","private2"],"items":{"type":"string","example":"[\"gold\",\"biz-internet\",\"private1\",\"private2\"]"}}}},"InlineResponse2003":{"type":"object","properties":{"configuredHostname":{"type":"string","example":"ICGW1"},"configuredSystemIP":{"type":"string","example":"1.1.1.10"},"deviceModel":{"type":"string","example":"C8000v"},"uuid":{"type":"string"}}},"InlineResponse2004":{"type":"object","properties":{"data":{"type":"array","example":[{"size":"Small","spec":"small"},{"size":"Medium","spec":"medium"}],"items":{"$ref":"#/components/schemas/InlineResponse2004Data"}}}},"InlineResponse2004Data":{"type":"object","properties":{"size":{"type":"string","description":"instance size","example":"Small"},"spec":{"type":"string","description":"instance size","example":"small"}},"example":[{"size":"Small","spec":"small"},{"size":"Medium","spec":"medium"}]},"InlineResponse2005":{"type":"object","properties":{"data":{"type":"array","example":["C8000v 17.05.01a","C8000v 17.06.01a"],"items":{"type":"string","example":"[\"C8000v 17.05.01a\",\"C8000v 17.06.01a\"]"}}}},"InlineResponse2006":{"type":"object","properties":{"edgePartnerPortsList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectPartnerPorts"}}}},"InlineResponse2007":{"type":"object","properties":{"portSpeeds":{"type":"array","example":["50","100","200","500","1000","5000"],"items":{"type":"string","example":"[\"50\",\"100\",\"200\",\"500\",\"1000\",\"5000\"]"}}}},"InlineResponse2008":{"type":"object","properties":{"connectivityGateway":{"type":"array","items":{"$ref":"#/components/schemas/CloudConnectivityGateway"}}},"description":"Cloud Connectivity Gateway Object"},"InlineResponse2009":{"type":"object","properties":{"vWans":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse2009VWans"}}}},"InlineResponse2009VWans":{"type":"object","properties":{"vWan":{"$ref":"#/components/schemas/AzureVirtualWan"},"vWanInUse":{"type":"boolean","example":false}}},"InlineResponse200RunningTasks":{"type":"object","properties":{"action":{"type":"string"},"detailsURL":{"type":"string"},"endTime":{"type":"string"},"name":{"type":"boolean"},"processId":{"type":"string"},"rid":{"type":"string"},"scheduledAction":{"type":"boolean"},"startTime":{"type":"string"},"status":{"type":"string"},"tenantId":{"type":"string"},"tenantName":{"type":"string"},"userSessionIP":{"type":"string"},"userSessionUserName":{"type":"string"}}},"InstalledCerts":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/InstalledCertsInner"}},"InstalledCertsInner":{"type":"object","properties":{"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----"},"signerVmanageUUID":{"type":"string"}}},"InstanceSizeResponse":{"type":"object","properties":{"size":{"type":"string","example":"n1-standard-4"},"spec":{"type":"string","example":"n1-standard-4 (4 vCPU)"}}},"InterconnectAccount":{"type":"object","properties":{"credType":{"type":"string"},"description":{"type":"string"},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"equinixCredentials":{"$ref":"#/components/schemas/InterconnectAccountEquinixCredentials"},"megaportCredentials":{"$ref":"#/components/schemas/InterconnectAccountMegaportCredentials"},"regionList":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"List of regions","items":{"type":"string","description":"List of regions"}}}},"InterconnectAccountEquinixCredentials":{"type":"object","properties":{"clientId":{"type":"string","description":"Client Id of the Equinix Account.","example":"abcd-1234"},"clientSecret":{"type":"string","description":"Client secret of the Equinix Account.","example":"XXXX-XXXX-XXXX"}},"description":"Equinix Credential information."},"InterconnectAccountMegaportCredentials":{"type":"object","properties":{"password":{"type":"string","description":"Password of the Megaport Account.","example":"XXXXX"},"username":{"type":"string","description":"Username of the Megaport Account.","example":"cisco@megaport.com"}},"description":"Megaport Credential Information"},"InterconnectBillingAccountInfo":{"type":"object","properties":{"edgeBillingAccountId":{"type":"string","description":"Interconnect billing account Id","example":"12345"},"edgeBillingAccountName":{"type":"string","description":"Interconnect billing account name","example":"Cisco IC"}},"description":"Interconnect billing account Information"},"InterconnectConnectedSite":{"type":"object","properties":{"bfdSessions":{"type":"integer","format":"int32"},"bfdSessionsUp":{"type":"integer","format":"int32"},"device-model":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"statusBfd":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"InterconnectDashboard":{"type":"object","properties":{"connections":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDashboardConnections"}},"devices":{"type":"array","items":{"type":"string"}},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeGatewayId":{"type":"string"},"edgeGatewayName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"linkList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDashboardLinkList"}},"region":{"type":"string"},"resourceState":{"type":"string"},"resourceStateUpdateTs":{"type":"string"}}},"InterconnectDashboardConnections":{"type":"object","properties":{"connectivityName":{"type":"string"},"resourceState":{"type":"string"}}},"InterconnectDashboardLinkList":{"type":"object","properties":{"deviceLinkName":{"type":"string"},"resourceState":{"type":"string"}}},"InterconnectDeviceInfoExtended":{"type":"object","properties":{"configStatusMessage":{"type":"string"},"configuredSystemIP":{"type":"string"},"device-model":{"type":"string"},"device-type":{"type":"string"},"edgeGatewayName":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"system-ip":{"type":"string"},"uptimeDate":{"type":"number"},"uuid":{"type":"string"},"version":{"type":"string"}}},"InterconnectDeviceLink":{"type":"object","properties":{"bandwidth":{"type":"string","description":"Device-Link Bandwidth Input.","example":"50"},"deviceLinkName":{"type":"string","description":"Name of the Interconnect Device-Link.","example":"my-device-link"},"deviceLinkUuid":{"type":"string","description":"Uuid of the Interconnect Device-Link","example":"496bddbd-e104-44a7-ba62-7a285f642304"},"deviceLinksubnet":{"type":"string","description":"Subnet pool for Interconnect Gateway interfaces in the Device-Link.","example":"20.10.0.0/16"},"deviceList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDeviceLinkDeviceList"}},"dlMetroBandwidth":{"type":"string","description":"Device-Link Bandwidth at a given Metro.","example":"150"},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"linkBandwidth":{"type":"string","description":"Device-Link Bandwidth.","example":"50"},"resourceState":{"type":"string"},"resourceStateMessage":{"type":"string"},"resourceStateUpdateTs":{"type":"string"},"subnet":{"type":"string","description":"Subnet pool for Interconnect Gateway interfaces in the Device-Link.","example":"20.10.0.0/16"},"version":{"type":"string","description":"Version of the payload.","example":"1"}},"description":"Interconnect Device-Link Object"},"InterconnectDeviceLinkDeviceList":{"type":"object","properties":{"deviceInterfaceId":{"type":"string","description":"Interface used on the Interconnect Gateway to connect to the Device-Link.","example":"GigabitEthernet4"},"deviceIntfIpAddress":{"type":"string","description":"IP assigned to the Interconnect Gateway interface to connect to the Device-Link.","example":"20.10.0.2"},"deviceName":{"type":"string","description":"Name of the Interconnect Gateway in the Device-Link.","example":"ICGW_1"},"deviceUuid":{"type":"string","description":"Uuid of Interconnect Gateway in the Device-Link.","example":"0dc43131-47c9-4fce-8499-f02e3340c9fb"},"egwLoopBackCidr":{"type":"string","description":"IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.","example":"172.31.251.8/30"}}},"InterconnectGatewayExtended":{"type":"object","properties":{"description":{"type":"string"},"deviceUuid":{"type":"string"},"edgeAccountId":{"type":"string"},"edgeBillingAccountId":{"type":"string"},"edgeGatewayName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"egwBgpAsn":{"type":"string","description":"BGP ASN assigned to Interconnect Gateway","example":"64500"},"isCustomSetting":{"type":"boolean","description":"Custom Settings enabled for Interconnect Gateway","example":true},"licenseSkuId":{"type":"string","description":"License Sku Id of Interconnect Gateway","example":"12345"},"loopbackCidr":{"type":"string","description":"Ip pool allocated to Interconnect Gateway for Loopback Interfaces","example":"172.31.251.4/30"},"mrfSettings":{"$ref":"#/components/schemas/InterconnectMrfSettings"},"region":{"type":"string"},"regionId":{"type":"string"},"resourceState":{"type":"string"},"resourceStateMessage":{"type":"string"},"resourceStateUpdateTs":{"type":"string"},"settings":{"$ref":"#/components/schemas/InterconnectGatewaySettings"},"siteName":{"type":"string"}}},"InterconnectGatewayMonitoring":{"type":"object","properties":{"description":{"type":"string"},"deviceUuid":{"type":"string"},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeGatewayId":{"type":"string"},"edgeGatewayName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"isCustomSetting":{"type":"boolean","description":"Custom Settings enabled for Interconnect Gateway","example":true},"region":{"type":"string"},"resourceState":{"type":"string"},"siteName":{"type":"string"},"status":{"type":"string"}}},"InterconnectGatewaySettings":{"type":"object","properties":{"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"egwCustomSettingName":{"type":"string","description":"Assigned name of the Interconnect Gateway Custom Settings"},"instanceSize":{"type":"string"},"ipSubnetPool":{"type":"string","description":"Ip subnet pool assigned to the gateway","example":"192.168.10.0/24"},"softwareImageId":{"type":"string"}}},"InterconnectGlobalSettings":{"type":"object","properties":{"bgpAsn":{"type":"string"},"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"instanceSize":{"type":"string"},"invoiceReference":{"type":"string"},"ipSubnetPool":{"type":"string"},"loopbackCgwColor":{"type":"string"},"loopbackTunnelColor":{"type":"string"},"softwareImageId":{"type":"string"}}},"InterconnectLicense":{"type":"object","properties":{"currentStatus":{"type":"string","example":"AVAILABLE"},"edgeAccountName":{"type":"string","example":"mp-license-acc"},"endDate":{"type":"string","example":"2025-01-15"},"prodType":{"type":"string","example":"AWSHC"},"sku":{"type":"string","example":"AWS-HC-IIVXC-C"},"skuDaysForExpiry":{"type":"number","example":924},"skuId":{"type":"string"},"smartAccountId":{"type":"string","example":"100259"},"startDate":{"type":"string","example":"2022-01-19"},"subscriptionReferenceId":{"type":"string","example":"Sub1077241"},"technicalServiceUid":{"type":"string"},"virtualAccountId":{"type":"string","example":"109733"},"vxcBandwidth":{"type":"string","example":"1000"},"webOrderId":{"type":"string","example":"91358156"}}},"InterconnectLocationInfoEquinix":{"type":"object","properties":{"eqBillingAccountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectBillingAccountInfo"}},"eqNEInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo"},"metroCode":{"type":"string","example":"DT"},"metroName":{"type":"string"},"networkRegion":{"type":"string","example":"AMER"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"InterconnectLocationInfoMegaport":{"type":"object","properties":{"address":{"type":"string","example":"24700"},"country":{"type":"string","example":"USA"},"liveDate":{"type":"string","example":"1589292000000"},"market":{"type":"string","example":"US"},"metroName":{"type":"string","example":"Detroit"},"mpMVEInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo"},"networkRegion":{"type":"string","example":"MP1"},"siteCode":{"type":"string","example":"det-on1"},"status":{"type":"string","example":"Active"}}},"InterconnectLocationInfoMegaportMpMVEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","example":["oldest","current","newest"],"items":{"type":"string","example":"[\"oldest\",\"current\",\"newest\"]"}},"productSizeList":{"type":"array","example":["small","medium","large"],"items":{"type":"string","example":"[\"small\",\"medium\",\"large\"]"}}}},"InterconnectLocations":{"type":"object","properties":{"edgeLocationInfoList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectLocationsEdgeLocationInfoList"}}}},"InterconnectLocationsEdgeLocationInfoList":{"type":"object","properties":{"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"eqLocationInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoEquinix"},"locationId":{"type":"string"},"locationName":{"type":"string"},"mpLocationInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaport"}}},"InterconnectMrfSettings":{"type":"object","properties":{"mrfRouterRole":{"type":"string","description":"Multi Region Fabric router role","example":"border"},"mrfTransportGateway":{"type":"boolean","description":"Multi Region Fabric Transport Gateway","example":false},"nhmRegionId":{"type":"integer","description":"Network Hierarchy Region Id","format":"int64","example":123},"nhmRegionName":{"type":"string","description":"Network Hierarchy Region name","example":"My-Region"}}},"InterconnectPartnerPorts":{"type":"object","properties":{"cloudType":{"type":"string","enum":["AWS","AZURE","GCP"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"eqPartnerPort":{"$ref":"#/components/schemas/InterconnectPartnerPortsDetails"},"locationId":{"type":"string"},"mpPartnerPort":{"$ref":"#/components/schemas/InterconnectPartnerPortsDetails"},"name":{"type":"string"}},"description":"Interconnect partner port information"},"InterconnectPartnerPortsDetails":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string","description":"Megaport companyId for the region.","example":"2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc"},"connectType":{"type":"string","enum":["AWS","AWSHC","PRIMARY","SECONDARY","INTERCONNECT_ATTACHMENT"]},"productUid":{"type":"string","description":"Megaport id for the region.","example":"2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc"},"speed":{"type":"string","description":"Bandwidth speeds supported at the region."},"vxcId":{"type":"string","description":"Cross connect (VXC) id connected to the region","example":"None"},"vxcPermitted":{"type":"boolean","description":"Cross Connect enabled Megaport region.","example":true}},"description":"Megaport specific partner port fields."},"InterconnectWidget":{"type":"object","properties":{"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"gwDeviceSiteIds":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"integer","format":"int64"}},"gwDeviceStatus":{"$ref":"#/components/schemas/GwDeviceStatus"},"gwSitestatus":{"$ref":"#/components/schemas/GwSiteStatus"},"gwStatus":{"$ref":"#/components/schemas/GwStatus"},"numAccounts":{"type":"integer","format":"int64"},"numConn":{"type":"integer","format":"int64"},"numSdwanTunnels":{"type":"integer","format":"int64"}}},"InterfaceAggResp":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"interface":{"type":"string"},"rx_kbps":{"type":"number"},"tx_kbps":{"type":"number"},"vdevice_name":{"type":"string"}}},"InterfaceAggRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"interface aggregation response with page info"},"InterfaceColorResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"InterfaceDocCountRequest":{"type":"object","properties":{"dataType":{"type":"string"},"property":{"type":"string"}}},"InterfaceQuery":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/QueryWithRule"}}},"InterfaceResp":{"type":"object","properties":{"device_model":{"type":"string"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"fec_re":{"type":"integer","format":"int32"},"fec_rx":{"type":"integer","format":"int64"},"fec_tx":{"type":"integer","format":"int64"},"host_name":{"type":"string"},"id":{"type":"string"},"jitter":{"type":"integer","format":"int32"},"latency":{"type":"number"},"local_color":{"type":"string"},"local_system_ip":{"type":"string"},"loss":{"type":"integer","format":"int32"},"loss_percentage":{"type":"integer","format":"int32"},"name":{"type":"string"},"proto":{"type":"string"},"remote_color":{"type":"string"},"remote_system_ip":{"type":"string"},"rx_octets":{"type":"integer","format":"int64"},"rx_pkts":{"type":"integer","format":"int64"},"sla_class_list":{"type":"string"},"sla_class_names":{"type":"string"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"statcycletime":{"type":"string"},"state":{"type":"string"},"tenant":{"type":"string"},"total":{"type":"integer","format":"int32"},"tunnel_color":{"type":"string"},"tx_octets":{"type":"number"},"tx_pkts":{"type":"integer","format":"int64"},"vdevice_name":{"type":"string"},"vip_idx":{"type":"integer","format":"int32"},"vmanage_system_ip":{"type":"string"},"vqoe_score":{"type":"integer","format":"int32"}},"description":"interface specific response"},"InterfaceRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"interface response with page info"},"IpSecSecurity":{"type":"object","properties":{"authenticationType":{"pattern":"(ah-sha1-hmac|sha1-hmac)","type":"string"},"ipSecPairwiseKeying":{"type":"string"},"rekeyTime":{"type":"integer","format":"int32"},"replayWindow":{"type":"integer","format":"int32"}}},"IsVnetAttached":{"type":"object","properties":{"isVnetAttached":{"type":"boolean","example":true}}},"IseServer":{"required":["iseServerIP","password","sgt","userAndUserGroup","userName","vpn"],"type":"object","properties":{"activeDirectoryDomain":{"type":"string","example":"SDWAN-IDENTITY.CISCO.COM"},"iseCertName":{"type":"string","example":"iseCertificate"},"iseRootCert":{"type":"string"},"iseServerIP":{"type":"string","example":"172.27.216.141"},"joinPoint":{"type":"string","example":"SDWAN-IDENTITY"},"password":{"type":"string","example":"testPassword"},"pxGridCertName":{"type":"string","example":"pxGridCertificate"},"pxGridRootCert":{"type":"string"},"sgt":{"type":"string","example":"false"},"userAndUserGroup":{"type":"string","example":"true"},"userName":{"type":"string","example":"admin"},"vpn":{"type":"string","example":"0"}}},"Itemsinfo":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/RegionPrefixinfo"}},"LicenseUplodFile":{"type":"object","properties":{"data":{"type":"string"},"name":{"type":"string","format":"binary"}}},"LinkObject":{"type":"object","properties":{"href":{"type":"string","example":"https://172.27.216.141:9060/ers/config/adminuser/versioninfo"},"rel":{"type":"string","example":"self"},"type":{"type":"string","example":"application/json"}}},"LinkStateAlarmRequestBody":{"required":["enable","linkName"],"type":"object","properties":{"enable":{"type":"boolean"},"linkName":{"type":"string","example":"bgp"}},"description":"Request body for Link-State Alarms"},"LocalBackupInfo":{"type":"object","properties":{"backupState":{"type":"string","description":"Current stage of database backup workflow. This could be [SCHEDULED/IN_PROGRESS/CONFIG_DB_BACKUP_SUCCESS/CONFIG_DB_BACKUP_FAILED/STATS_DB_EXPORT_SUCCESS/STATS_DB_EXPORT_FAILED/CONFIG_DB_CONSISTENCY_CHECK_FAILED/LEADER_SUCCESS/ALL_SUCCESS/FAILURE/DELETED]","example":"IN_PROGRESS"},"backupType":{"type":"string","description":"Type of backup. This could be [SCHEDULED/ON_DEMAND]","example":"ON_DEMAND"},"createTime":{"type":"integer","description":"Epoch timestamp","format":"int64","example":1650994911131},"destination":{"$ref":"#/components/schemas/LocalDestination"},"downloadURL":{"type":"string","description":"Destination to download database backup from","example":"/dataservice/tenantbackup/download/1570057020772/backup_1570057020772_100919-181838.tar.gz"},"followerIpAddressList":{"type":"array","description":"List of vManage servers IP address who are running in follower mode","example":["10.0.105.38","10.0.105.39"],"items":{"type":"string","description":"List of vManage servers IP address who are running in follower mode","example":"[\"10.0.105.38\",\"10.0.105.39\"]"}},"localBackupInfoId":{"type":"string","description":"A unique UUID per database back up request","example":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"},"scheduleId":{"type":"string","description":"A unique UUID for scheduled database backup task","example":"9b08dce2-d33f-11ec-9d64-0242ac120002"},"srcIpAddress":{"type":"string","description":"IP address of the source vmanage server for database backup","example":"10.0.105.32"},"taskId":{"type":"string","description":"Unique task Id for a given database backup task","example":"f81ee476-d33f-11ec-9d64-0242ac120002"},"taskName":{"type":"string","description":"Task name in human readable format","example":"Schedule backup on 6/1/2022"}},"description":"List of all local backup info objects in the system"},"LocalBackupListResult":{"type":"object","properties":{"backupList":{"type":"array","description":"List of all local backup info objects in the system","items":{"$ref":"#/components/schemas/LocalBackupInfo"}}}},"LocalDestination":{"type":"object","properties":{"backupDest":{"type":"string","description":"Storage type. This could be [LOCAL/S3/SFTP/AZURE]","example":"LOCAL"},"backupDir":{"type":"string","description":"Location where the database backup file on a storage type. ","example":"/opt/data/backup/scheduledbackup/"},"backupStorageInGB":{"type":"integer","description":"Size of the database backup allowed to the stored at a backup destination","format":"int32","example":10},"backupTTLInDays":{"type":"integer","description":"Time to live for a database backup copy in the backup destination in days","format":"int32","example":30},"numOfReplica":{"type":"integer","description":"Number of replicas of the database backup file","format":"int32","example":2},"vmVersion":{"type":"string","description":"vManage software version against which the database backup was taken","example":"20.9"}}},"LoggingSystemMessages":{"type":"object","properties":{"maxFileSize":{"type":"integer","format":"int32"},"priority":{"type":"string"},"rotations":{"type":"integer","format":"int32"}}},"LoginAccessToRouter":{"type":"object","properties":{"authenticationOrder":{"type":"string"},"localPassword":{"type":"string"},"localUser":{"type":"string"}}},"LteApn":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"description":"List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ","example":[]},"LteTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"MapDefaults":{"type":"object","properties":{"conn":{"type":"string","example":"enabled"},"connType":{"type":"string","example":"Intra"},"destType":{"type":"string","example":"vpn"},"editable":{"type":"boolean","example":false},"srcType":{"type":"string","example":"vpn"}}},"MapStatus":{"type":"object","properties":{"destId":{"type":"string"},"destType":{"type":"string"},"mapped":{"type":"array","items":{"$ref":"#/components/schemas/MapStatusMapped"}},"outstandingMapping":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"},"unmapped":{"type":"string"}}},"MapStatusMapped":{"type":"object","properties":{"cloudType":{"type":"string"},"destId":{"type":"string"},"destRegion":{"type":"string"},"destType":{"type":"string"},"sourceRegion":{"type":"string"},"sourceTag":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"},"tunnelId":{"type":"string"}}},"MapSummary":{"type":"object","properties":{"Account ID":{"$ref":"#/components/schemas/MapSummaryAccountID"},"Azure Virtual WAN Hub ID":{"type":"string"},"accountName":{"type":"string"},"additionalDetails":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudGatewaySolution":{"type":"string"},"cloudProviderMgmtReference":{"type":"string"},"cloudType":{"type":"string"},"connectedSites":{"type":"integer","format":"int32"},"connectivityState":{"type":"string"},"connectivityStateUpdateTs":{"type":"string"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/MapSummaryDevices"}},"hostVpcs":{"$ref":"#/components/schemas/MapSummaryHostVpcs"},"operState":{"type":"string"},"region":{"type":"string"},"status":{"type":"string"},"tags":{"$ref":"#/components/schemas/MapSummaryTags"},"tunnels":{"type":"array","items":{"$ref":"#/components/schemas/MapSummaryTunnels"}},"vpns":{"$ref":"#/components/schemas/MapSummaryVpns"}}},"MapSummaryAccountID":{"type":"object","properties":{"Site To Cloud NCC Hub Name":{"type":"string"},"Site To Cloud NCC Spoke Name":{"type":"string"},"Site To Cloud Primary GCR Name":{"type":"string"},"Site To Cloud VPC ID":{"type":"string"},"Site To Cloud VPC Name":{"type":"string"},"Site To Site NCC Hub Name":{"type":"string"},"Site To Site VPC ID":{"type":"string"},"Site To Site VPC Name":{"type":"string"},"WAN VPC ID":{"type":"string"},"WAN VPC Name":{"type":"string"}}},"MapSummaryDevices":{"type":"object","properties":{"reachability":{"type":"string"},"systemIp":{"type":"string"},"uuid":{"type":"string"}}},"MapSummaryHostVpcs":{"type":"object","properties":{"accountId":{"type":"string"},"hostVpcId":{"type":"string"},"tag":{"type":"string"}}},"MapSummaryTags":{"type":"object","properties":{"tag":{"type":"string"}}},"MapSummaryTunnels":{"type":"object","properties":{"acceptedRouteCount":{"type":"integer","format":"int32"},"lastStatusChangeTimestamp":{"type":"string"},"outerIpAddr":{"type":"string"},"status":{"type":"string"},"statusMessage":{"type":"string"},"tunnelId":{"type":"string"}}},"MapSummaryVpns":{"type":"object","properties":{"vpnId":{"type":"string"}}},"MapVpnsResponse":{"type":"object","properties":{"id":{"type":"string","example":"a0b3f15d-a4e6-4e1d-86f9-8936284dbe1b"},"referenceCount":{"type":"integer","format":"int32","example":0},"segmentId":{"type":"string","example":"10"},"segmentName":{"type":"string","example":"vpn10"}},"description":"List of vpns for MultiCloud"},"MegaportCredentials":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}}},"MegaportLocationInfo":{"type":"object","properties":{"address":{"type":"string"},"country":{"type":"string"},"liveDate":{"type":"string"},"market":{"type":"string"},"metroName":{"type":"string"},"mpMVEInfo":{"$ref":"#/components/schemas/MegaportMVEInfo"},"networkRegion":{"type":"string"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"MegaportMVEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","items":{"type":"string"}},"productSizeList":{"type":"array","items":{"type":"string"}}}},"MegaportPartnerPort":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string"},"connectType":{"type":"string"},"productUid":{"type":"string"},"speed":{"type":"string"},"vxcId":{"type":"string"},"vxcPermitted":{"type":"boolean"}}},"MessagingResp":{"type":"object","properties":{"deviceIP":{"type":"string","example":"172.16.255.26"},"vmanages":{"type":"array","items":{"type":"string"}}}},"Meter":{"type":"object"},"MetricData":{"type":"object","properties":{"time":{"type":"string","description":"timestamp in seconds","example":"123344555"},"value":{"type":"integer","description":"count/value for corresponding timestamp","format":"int64","example":718}}},"Model400Error":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Model400ErrorError"}}},"Model400ErrorError":{"required":["code","details","message"],"type":"object","properties":{"code":{"type":"string","description":"Error code associated with the error event"},"details":{"type":"string","description":"Error message details"},"message":{"type":"string","description":"Error message title"}},"description":"error message"},"MplsTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"MultiCloudEdgeAccountInfo":{"type":"object","properties":{"accountCredentials":{"type":"string"},"credType":{"type":"string"},"description":{"type":"string"},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeBillingAccountInfo":{"$ref":"#/components/schemas/MultiCloudEdgeBillingAccountInfo"},"edgeLocationInfoList":{"type":"array","items":{"$ref":"#/components/schemas/MultiCloudEdgeLocationInfo"}},"edgePartnerPortsList":{"type":"array","items":{"$ref":"#/components/schemas/MultiCloudEdgePartnerPort"}},"edgeType":{"type":"string"},"equinixCredentials":{"$ref":"#/components/schemas/EquinixCredentials"},"megaportCredentials":{"$ref":"#/components/schemas/MegaportCredentials"},"orgName":{"type":"string"},"regionList":{"type":"array","items":{"type":"string"}}}},"MultiCloudEdgeBillingAccountInfo":{"type":"object","properties":{"edgeBillingAccountId":{"type":"string"},"edgeBillingAccountName":{"type":"string"},"edgeType":{"type":"string"}}},"MultiCloudEdgeLocationInfo":{"type":"object","properties":{"edgeType":{"type":"string"},"eqLocationInfo":{"$ref":"#/components/schemas/EquinixLocationInfo"},"locationId":{"type":"string"},"locationName":{"type":"string"},"mpLocationInfo":{"$ref":"#/components/schemas/MegaportLocationInfo"}}},"MultiCloudEdgePartnerPort":{"type":"object","properties":{"cloudType":{"type":"string"},"edgeType":{"type":"string"},"eqPartnerPort":{"$ref":"#/components/schemas/EquinixPartnerPort"},"locationId":{"type":"string"},"mpPartnerPort":{"$ref":"#/components/schemas/MegaportPartnerPort"},"name":{"type":"string"}}},"NATRule":{"required":["description","inPort","insideIp","interface","outPort","protocol"],"type":"object","properties":{"description":{"type":"string"},"inPort":{"maximum":65535,"minimum":1,"type":"integer","format":"int32"},"insideIp":{"type":"string"},"interface":{"type":"string"},"outPort":{"maximum":65535,"minimum":1,"type":"integer","format":"int32"},"protocol":{"pattern":"^udp$|^tcp$|^icmp$","type":"string"}}},"NameValuePair":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"Neo4jMetricsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricData"}},"limit":{"type":"integer","description":"limit given in reqeust. By default - 500","format":"int64","example":50},"pageNo":{"type":"integer","description":"Page Number given in request. By default - 1","format":"int32","example":3},"recordsCurrentPage":{"type":"integer","description":"Records present on the current page","format":"int64","example":20},"totalPages":{"type":"integer","description":"Total Pages calculates based on limit and totalRecords values","format":"int32","example":3},"totalRecords":{"type":"integer","description":"Total count of metrics records ignoring limit","format":"int32","example":120}}},"NetworkProtocol":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"DHCPPool":{"$ref":"#/components/schemas/DHCPPool"},"DNSSettings":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string"},"NTPSettings":{"maxItems":4,"minItems":1,"type":"array","items":{"type":"string"}},"NATRules":{"type":"array","items":{"$ref":"#/components/schemas/NATRule"}},"NTPInherit":{"type":"boolean"}}}]},"Node":{"type":"object","properties":{"ip":{"type":"string"},"name":{"type":"string"},"password":{"type":"string"},"serialno":{"type":"string"},"status":{"type":"string"},"username":{"type":"string"},"uuid":{"type":"string"}}},"NotificationsRuleData":{"type":"object","properties":{"@rid":{"type":"integer","format":"int64","example":1158},"accountDetails":{"type":"string","example":"cqx@cisco.com"},"alarmName":{"type":"string","example":"BFD_Node_Up"},"devicesAttached":{"type":"string","example":"1712133e-0246-4281-8152-3317b796d2bc"},"emailThreshold":{"type":"integer","format":"int64","example":5},"lastUpdated":{"type":"integer","format":"int64","example":1588177200725},"notificationRuleId":{"type":"string","example":"e947efc8-e86a-4eb4-b8ce-7ed0c2828f13"},"notificationRuleName":{"type":"string","example":"testwebhook"},"severity":{"type":"string","example":"Medium"},"updatedBy":{"type":"string","example":"admin"},"webhookPassword":{"type":"string","example":"$CRYPT$R21YRfP4HWOv+Z9nSi7zRw==$hEU/zplzA+IJlI/4LsNY/Q=="},"webhookUrl":{"type":"string","example":"https://localhost:8444"},"webhookUsername":{"type":"string","example":"admin"}}},"NotificationsRulesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationsRuleData"}}}},"NvaRulesListRequest":{"type":"object","properties":{"securityRulesList":{"type":"array","items":{"$ref":"#/components/schemas/NvaRulesListRequestSecurityRulesList"}}}},"NvaRulesListRequestSecurityRulesList":{"type":"object","properties":{"destinationPortRange":{"type":"string","example":"22"},"protocol":{"type":"string","example":"TCP"},"sourceAddressPrefix":{"type":"string","example":"192.168.1.1/32"}}},"NvaRulesResponse":{"type":"object","properties":{"accountId":{"type":"string","example":"112948124124"},"accountName":{"type":"string","example":"test_account_name"},"cloudType":{"type":"string","example":"AZURE"},"expirationTime":{"type":"string","example":"6/10/2022 6:12:36 PM UTC"},"nvaId":{"type":"string","example":"/subscriptions/112948124124/resourceGroups/test-resource-group/providers/Microsoft.Network/networkVirtualAppliances/CiscoSdwanV2-nva-399bdf13-65e9-4177-876b-d125bee704d6"},"resourceGroupName":{"type":"string","example":"test-resource-group"},"ruleName":{"type":"string","example":"test_rule"},"securityRulesList":{"$ref":"#/components/schemas/NvaRulesListRequest"}}},"NvaSkuListResponse":{"type":"object","properties":{"accountId":{"type":"string","example":"112948124124"},"accountName":{"type":"string","example":"test_account_name"},"cloudType":{"type":"string","example":"AZURE"},"nvaSkuId":{"type":"string","example":"ciscosdwan"},"nvaSkuName":{"type":"string","example":"ciscosdwan"},"scaleValueList":{"type":"array","items":{"$ref":"#/components/schemas/NvaSkuListResponseScaleValueList"}},"versionList":{"type":"array","items":{"type":"string"}}}},"NvaSkuListResponseScaleValueList":{"type":"object","properties":{"instanceCount":{"type":"integer","format":"int32"},"instanceType":{"type":"string"},"scaleUnit":{"type":"string"}}},"NvasResponse":{"type":"object","properties":{"nvaId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/networkVirtualAppliances/CiscoSdwanV2-nva-f383f40c-d07e-41be-bbc7-aa7abbfbf7fc"},"nvaName":{"type":"string","example":"CiscoSdwanV2-nva-f383f40c-d07e-41be-bbc7-aa7abbfbf7fc"},"source":{"type":"string","example":"vManage"},"uuids":{"type":"array","example":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"items":{"type":"string","example":"[\"C8K-2F69B355-2B3D-2801-EB48-F44789422299\",\"C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9\"]"}}}},"NwpiDomainMonitor":{"type":"object","properties":{"clientIp":{"type":"string"},"deviceToDomainId":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UuidToDomainId"}},"domainAppGrp":{"type":"string"},"domainAppVis":{"type":"string"},"domainList":{"type":"array","items":{"$ref":"#/components/schemas/DomainDetail"}},"traceId":{"type":"string"}}},"OMP":{"type":"object","properties":{"advertisementInterval":{"type":"integer","format":"int32"},"advertisements":{"pattern":"(IPv4|BGP|OSPF|Connected|Static)","type":"string"},"ecmpLimit":{"type":"integer","format":"int32"},"eorTimer":{"type":"integer","format":"int32"},"gracefulRestart":{"type":"integer","format":"int32"},"holdTime":{"type":"integer","format":"int32"},"pathsAdvertisedPerPrefix":{"type":"integer","format":"int32"}}},"OnDemandQueueEntry":{"type":"object","properties":{"complete":{"type":"boolean"},"completionTime":{"type":"integer","format":"int64"},"creationTime":{"type":"integer","format":"int64"},"data_type":{"type":"string","enum":["DPI","ConnectionEvents"]},"device_id":{"type":"string"},"end_time":{"type":"integer","format":"int64"},"id":{"type":"string"},"startProcessingTime":{"type":"integer","format":"int64"},"start_time":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["QUEUED","IN_PROGRESS","COMPLETED","FAILED"]},"tenant_id":{"type":"string"},"time_period":{"type":"string","enum":["LAST_N_HOURS","CUSTOM"]},"value":{"type":"integer","format":"int32"}}},"OnDemandSchedule":{"required":["scheduleType"],"type":"object","description":"On-demand schedule","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"}]},"OneOfAlarmConsumedEventsItems":{"type":"object"},"OneTimeSchedule":{"required":["scheduleType","startTime"],"type":"object","description":"One time schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (?:(?:([01]?\\d|2[0-3]):)?([0-5]?\\d):)?([0-5]?\\d)$","type":"string","description":"startTime string format is yyyy-MM-dd HH:mm:ss,UTC timezone","example":"2022-07-01 14:30:00"}}}]},"OrgID":{"type":"object","properties":{"vipObjectType":{"type":"string","example":"object"},"vipType":{"type":"string","example":"constant"},"vipValue":{"type":"string","example":"980"},"vipVariableName":{"type":"string","example":"system_org_id"}},"description":"Org ID"},"PageInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"endTime":{"type":"string"},"hasMoreData":{"type":"boolean"},"scrollId":{"type":"string"},"startTime":{"type":"string"},"totalCount":{"type":"integer","format":"int64"}}},"PartnerType":{"type":"object","properties":{"partnerType":{"type":"string","enum":["aci","dnac","wcm","mdp"]}},"description":"This is valid Partner Type","example":"dnac"},"PayloadItems":{"required":["_rid","business_relevance","common_family","common_family_display","common_name","common_name_display","nbar_family","nbar_name","qosmos_family","qosmos_name","traffic_class","uuid"],"type":"object","properties":{"_rid":{"type":"string","example":"0:PolicyAppListsNode:1675729045113:1700"},"business_relevance":{"type":"string","example":"business-irrelevant"},"common_family":{"type":"string","example":"web"},"common_family_display":{"type":"string","example":"Web"},"common_name":{"type":"string","example":"zulily"},"common_name_display":{"type":"string","example":"Zulily"},"nbar_family":{"type":"string","example":"web"},"nbar_name":{"type":"string","example":"zulily"},"qosmos_family":{"type":"string","example":"web"},"qosmos_name":{"type":"string","example":"zulily"},"traffic_class":{"type":"string","example":"transactional-data"},"uuid":{"type":"string","format":"uuid","example":"345fa8c9-6115-434b-b1f7-2c1d97f09f91"}}},"PolicyGroup":{"required":["name","solution","state","version"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"Mobility","enum":["mobility","sdwan","common","nfvirtual"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"version":{"type":"integer","description":" Group Version Flag","format":"int64"}}},"PolicyRule":{"type":"object","properties":{"action":{"pattern":"(drop|pass)","type":"string"},"destIp":{"type":"string"},"destPort":{"type":"integer","format":"int32"},"protocolType":{"type":"array","items":{"type":"string"}},"sourceIp":{"type":"string"},"sourcePort":{"type":"integer","format":"int32"}}},"PostAccounts":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"awsIamCredentials":{"$ref":"#/components/schemas/AwsIamCredentials"},"awsKeyCredentials":{"$ref":"#/components/schemas/AwsKeyCredentials"},"azureCredentials":{"$ref":"#/components/schemas/AzureCredentials"},"cloudGatewayEnabled":{"type":"boolean"},"cloudType":{"type":"string"},"description":{"type":"string"},"gcpCredentials":{"$ref":"#/components/schemas/GcpCredentials"},"serviceDiscoveryEnabled":{"type":"boolean"}}},"PostAccountsResponse":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"regionList":{"type":"string"}}},"PostMapRequest":{"type":"object","properties":{"cloudType":{"type":"string"},"connMatrix":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestConnMatrix"}}}},"PostMapRequestConnMatrix":{"type":"object","properties":{"conn":{"type":"string"},"destId":{"type":"string"},"destType":{"type":"string"},"mapped":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestMapped"}},"outstandingMapping":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestMapped"}},"srcId":{"type":"string"},"srcType":{"type":"string"},"unmapped":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestMapped"}}}},"PostMapRequestMapped":{"type":"object","properties":{"cgwAttachment":{"type":"string"},"cloudType":{"type":"string"},"destId":{"type":"string"},"destRegion":{"type":"string"},"destTag":{"type":"string"},"destType":{"type":"string"},"region":{"type":"string"},"sourceRegion":{"type":"string"},"sourceTag":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"},"tunnelId":{"type":"string"}}},"Prefixinfo":{"type":"object","properties":{"owned":{"type":"array","example":["23.89.48.0/20","64.68.96.0/24","64.68.103.0/24"],"items":{"type":"string","example":"[\"23.89.48.0/20\",\"64.68.96.0/24\",\"64.68.103.0/24\"]"}}}},"ProcessFirmwareRemoteImageReq":{"type":"object","properties":{"filePath":{"type":"string","example":"/home/admin/"},"remoteServerId":{"type":"string","example":"f7ae1f4b-9900-424f-92ca-22d2231f55dc"}}},"ProcessGetFirmwareRemoteImageReq":{"type":"object","properties":{"description":{"type":"string","example":"Firmware Image Path"},"filePath":{"type":"string","example":"/home/admin/"},"remoteServerId":{"type":"string","example":"f7ae1f4b-9900-424f-92ca-22d2231f55dc"},"versionId":{"type":"string","example":"9917f2ad-c152-406b-87cc-a3b251d0e1a8"}}},"ProcessResponse":{"type":"object","properties":{"id":{"type":"string","description":"Procees Id of the task","example":"51d0a0e4-983a-471c-9abb-724d58144884"}}},"ProfileParcel":{"required":["name","type"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Profile Parcel.","example":"Wifi 7 profile Parcel"},"id":{"type":"string","description":"System generated unique identifier of the Profile Parcel in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Profile Parcel. Must be unique.","example":"Wifi profile Parcel"},"type":{"type":"string","description":"type","example":"wifi","enum":["cellular","wifi","ethernet","globalSettings","networkProtocol","securityPolicy"]},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}},"discriminator":{"propertyName":"type"}},"Properties":{"type":"object","properties":{"name":{"type":"string","example":"vdevice-name"},"samples":{"type":"array","items":{"type":"string"}},"type":{"type":"string","example":"java.lang.String"}}},"ProviderAccountDetails":{"required":["accountId","accountUserName","apiKey","carrierName","isDefault"],"type":"object","properties":{"acceptTermsAndConditions":{"type":"boolean","description":"Boolean value which indicates if the account user accepts account provider's terms and conditions if they exist."},"accountData":{"$ref":"#/components/schemas/AccountData"},"accountId":{"type":"string","description":" ID of the account associated with user using provider service.","example":"100025578"},"accountUserName":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the user registered to the service.","example":"JaneDoe"},"apiKey":{"maxLength":2147483647,"minLength":1,"type":"string","description":"API key for the provider service.","example":"1d6fa2f9-5a7d-4af8-8ab5-4056f631"},"carrierName":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the service provider.","example":"Singtel"},"isDefault":{"type":"boolean","description":"Boolean value which indicates whether the provider is the default provider ."}}},"ProviderInfo":{"type":"object","properties":{"cmpType":{"type":"string"},"cmpUrl":{"type":"string"},"contactInfoLine1":{"type":"string"},"contactInfoLine2":{"type":"string"},"contactInfoLine3":{"type":"string"},"countryCode":{"type":"string"},"operatorLogoUrl":{"type":"string"},"operatorName":{"type":"string"},"termsAndConditions":{"type":"string"}}},"PublicInternetTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"PurgeFrequency":{"type":"object","properties":{"activeTime":{"type":"string","example":"60000"},"interval":{"type":"string","example":"60000"}}},"PushCgwConfig":{"type":"object","properties":{"cloudGatewayName":{"type":"string","example":"cgw-test"},"cloudType":{"type":"string","example":"GCP"}}},"PutAccounts":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudGatewayEnabled":{"type":"boolean"},"cloudType":{"type":"string"},"description":{"type":"string"},"gcpBillingId":{"type":"string"},"serviceDiscoveryEnabled":{"type":"boolean"}}},"PxGridInfo":{"required":["pxGridPassword","pxGridServerIp","pxGridUserName","status"],"type":"object","properties":{"AccessSecret":{"type":"string","example":"aB8rj1m1lp"},"description":{"type":"string","example":"pxgrid infor"},"deviceType":{"type":"string","example":"vsmart"},"nodeName":{"type":"string","example":"~ise-admin-ise-1"},"pxGridHostName":{"type":"string","example":"ISE-1.rtpaaa.net"},"pxGridPassword":{"type":"string","example":"NJkl00jklkJk"},"pxGridServerIp":{"type":"string","example":"172.27.16.141"},"pxGridUserName":{"type":"string","example":"testName"},"restBaseURL":{"type":"string","example":"https://ISE-1.rtpaaa.net:8910/pxgrid/ise/config/trustsec"},"status":{"type":"string","example":"created"}},"description":"pxgrid information for making pxgrid api calls"},"QoSAggResp":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":5},"entry_time":{"type":"string","example":"1674813600000"},"jitter":{"type":"integer","format":"int32","example":0},"latency":{"type":"integer","format":"int32","example":0},"local_color":{"type":"string","example":"3g"},"loss_percentage":{"type":"integer","format":"int32","example":0}}},"QoSQueryFieldsResp":{"type":"object","properties":{"dataType":{"type":"string","example":"date"},"fieldData":{"$ref":"#/components/schemas/QoSQueryFieldsRespFieldData"},"isRequired":{"type":"boolean","example":true},"name":{"type":"string","example":"Event Time"},"options":{"type":"array","items":{"$ref":"#/components/schemas/QueryFieldsOption"}},"property":{"type":"string","example":"entry_time"}}},"QoSQueryFieldsRespFieldData":{"type":"object","properties":{"type":{"type":"string","example":"dateList"}}},"QoSResp":{"type":"object","properties":{"device_model":{"type":"string"},"drop_in_bytes":{"type":"number"},"drop_in_kbps":{"type":"integer","format":"int32"},"drop_in_pkts":{"type":"integer","format":"int32"},"drop_in_pps":{"type":"integer","format":"int64"},"entry_time":{"type":"string"},"host_name":{"type":"string"},"id":{"type":"string"},"interface":{"type":"string"},"queue_name":{"type":"string"},"queued_bytes":{"type":"number"},"queued_bytes_in_kbps":{"type":"number"},"queued_pkts":{"type":"number"},"red_drop_bytes":{"type":"number"},"red_drop_pkts":{"type":"number"},"statcycletime":{"type":"string"},"tail_drop_bytes":{"type":"integer","format":"int64"},"tail_drop_pkts":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"time_interval":{"type":"integer","format":"int32"},"tx_bytes":{"type":"number"},"tx_bytes_in_kbps":{"type":"integer","format":"int64"},"tx_bytes_in_pps":{"type":"integer","format":"int64"},"tx_pkts":{"type":"number"},"vdevice_name":{"type":"string"},"vip_idx":{"type":"string"},"vip_time":{"type":"string"},"vmanage_system_ip":{"type":"string"}},"description":"QOS specific response"},"QoSRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QoSResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"QoS response with page info"},"QueryFieldsOption":{"type":"object","properties":{"enabledDateFields":{"type":"boolean","example":false},"key":{"type":"string","example":"last_3_hours"},"number":{"type":"string","example":"1"},"value":{"type":"string","example":"last 1 hour"}}},"QueryWithAggregationAggregation":{"type":"object","properties":{"metrics":{"type":"array","items":{"$ref":"#/components/schemas/QueryWithAggregationAggregationMetrics"}}}},"QueryWithAggregationAggregationMetrics":{"type":"object","properties":{"property":{"type":"string","example":"latency"},"type":{"type":"string","example":"avg"}}},"QueryWithRule":{"type":"object","properties":{"condition":{"type":"string","example":"AND"},"rules":{"$ref":"#/components/schemas/RuleTypes"}}},"QueueEntries":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/OnDemandQueueEntry"}}}},"QueueProperties":{"type":"object","properties":{"current_size":{"type":"integer","format":"int32"},"max_size":{"type":"integer","format":"int32"},"tenant_current_size":{"type":"integer","format":"int32"},"tenant_max_size":{"type":"integer","format":"int32"}}},"RadioBandSetting_2_4G":{"type":"object","properties":{"band":{"pattern":"(RADIO_2_DOT_4_GHZ)","type":"string"},"channel":{"pattern":"(auto|1|2|3|4|5|6|7|8|9|10|11)","type":"string"},"channelWidth":{"pattern":"(RADIO_CHANNEL_WIDTH_20_MHZ)","type":"string"},"transmitPower":{"pattern":"(auto|1|2|3|4|5|6|7)","type":"string"}}},"RadioBandSetting_5G":{"type":"object","properties":{"band":{"pattern":"(RADIO_5_GHZ)","type":"string"},"channel":{"pattern":"(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)","type":"string"},"channelWidth":{"pattern":"(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)","type":"string"},"transmitPower":{"pattern":"(auto|1|2|3|4|5|6|7)","type":"string"}}},"Radius":{"type":"object","properties":{"retransmit":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"},"server":{"type":"array","items":{"$ref":"#/components/schemas/RadiusServer"}},"timeout":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}}},"RadiusServer":{"required":["host","port","secret"],"type":"object","properties":{"host":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"port":{"minimum":0,"type":"integer","format":"int32"},"secret":{"type":"string"}}},"RecommendationsResponse":{"required":["recommendations"],"type":"object","properties":{"recommendations":{"type":"array","example":[{"siteName":"SITE_400","siteId":"400","count":2},{"siteName":"SITE_500","siteId":"500","count":6}],"items":{"$ref":"#/components/schemas/RecommendationsResponseRecommendations"}},"totalRecommendationCount":{"type":"integer","format":"int32","example":8}}},"RecommendationsResponseRecommendations":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":6},"siteId":{"type":"string","example":"500"},"siteName":{"type":"string","example":"SITE_500"}},"example":[{"siteName":"SITE_400","siteId":"400","count":2},{"siteName":"SITE_500","siteId":"500","count":6}]},"RedirectCodeResponse":{"type":"object","properties":{"message":{"type":"string","example":"Redirect success! Please close this window"},"type":{"type":"string","example":"ok"}}},"Reference":{"type":"object","properties":{"id":{"type":"string","example":"0836d356-b89a-4fb9-abbc-1bb14d270ac8"},"type":{"type":"string","example":"zoneBasedFW"}},"description":"single policy where list is referenced"},"ReferencedList":{"type":"object","properties":{"description":{"type":"string","example":"test"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}},"infoTag":{"type":"string"},"isActivatedByVsmart":{"type":"boolean","example":false},"lastUpdated":{"type":"integer","format":"int32","example":1644359006986},"listId":{"type":"string","format":"uuid","example":"851cb243-d0da-4d7f-bdf9-124d979eadb9"},"name":{"type":"string","example":"universal"},"owner":{"type":"string","example":"admin"},"readOnly":{"type":"boolean","example":false},"referenceCount":{"type":"integer","format":"int32","example":1},"references":{"type":"array","items":{"$ref":"#/components/schemas/Reference"}},"type":{"type":"string","example":"identity"},"version":{"type":"string","example":"0"}},"description":"A single list and where it is referenced"},"RegionListReadOnly":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"List of regions","items":{"type":"string","description":"List of regions"}},"RegionPrefixinfo":{"type":"object","properties":{"prefixes":{"$ref":"#/components/schemas/Prefixinfo"},"region":{"$ref":"#/components/schemas/Regioninfo"}}},"Regioninfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1},"name":{"type":"string","example":"us-west-1"},"responder_fqdn":{"type":"string","example":"pinger.us-west-1.infnet.webex.com"}}},"ReleaseLicensesRequest":{"type":"object","properties":{"devices":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"RemoveTagResponse":{"type":"object","properties":{"isTagPresentInTagRule":{"type":"boolean"},"tagsInTagRule":{"type":"array","items":{"$ref":"#/components/schemas/RemoveTagResponseTagsInTagRule"}}}},"RemoveTagResponseTagsInTagRule":{"type":"object","properties":{"configGroupId":{"type":"string"},"configGroupName":{"type":"string"},"deviceAttribute":{"type":"string"},"rid":{"type":"integer","format":"int32"},"rule":{"type":"string"},"tagId":{"type":"string"},"values":{"type":"string"}}},"ReoccurDailySchedule":{"required":["scheduleType","startTime"],"type":"object","description":"Daily schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^(?:(?:([01]?\\d|2[0-3]):)?([0-5]?\\d):)?([0-5]?\\d)$","type":"string","description":"startTime string format is HH:mm:ss"}}}]},"ReoccurMonthlySchedule":{"required":["scheduleType","startTime"],"type":"object","description":"Monthly schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (?:(?:([01]?\\d|2[0-3]):)?([0-5]?\\d):)?([0-5]?\\d)$","type":"string","description":"startTime string format is (yyyy-MM-dd HH:mm:ss), time zone is UTC","example":"2022-07-01 20:30:10"}}}]},"ReoccurWeeklySchedule":{"required":["dayOfWeek","scheduleType","startTime"],"type":"object","description":"Weekly schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^(?:(?:([01]?\\d|2[0-3]):)?([0-5]?\\d):)?([0-5]?\\d)$","type":"string","description":"startTime string format is HH:mm:ss","example":"20:30:10"},"dayOfWeek":{"maximum":7,"minimum":1,"type":"integer","description":"The day number of a week, mapping is as 1 - Sun, 2 - Mon, 3 - Tus, 4 - Wed, 5 - Thu, 6 - Fri, 7 - Sat","format":"int32","example":1}}}]},"ReportInfo":{"required":["activeStatus","createdBy","hasTask","lastUpdateTime","nextRunTime","onVmanage","reportConfig","reportId","reportStatus"],"type":"object","properties":{"activeStatus":{"type":"string","description":"Report active status(active,cancelled)","example":"active","enum":["active","cancelled"]},"createdBy":{"maxLength":64,"minLength":0,"type":"string","description":"user name for who created the report template.","example":"admin"},"debugInfo":{"type":"string"},"hasTask":{"type":"boolean","description":"If the report template has running task records or not","example":true},"lastUpdateTime":{"type":"integer","description":"Report template last update timestamp","format":"int64","example":1655968207288},"needRunImmediately":{"type":"boolean"},"nextRunTime":{"type":"integer","description":"Report next running timestamp","format":"int64","example":1655991420000},"onVmanage":{"type":"string","description":"vManage which scheduled report generating tasks","example":"10.1.1.100"},"reportConfig":{"$ref":"#/components/schemas/ExecutiveSummaryReport"},"reportId":{"type":"string","description":"The report UUID for report template","format":"uuid","example":"50671437-c88e-4514-aafa-103e58c4d9cc"},"reportStatus":{"type":"string","description":"Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))","example":"in_progress","enum":["not_scheduled","scheduled","in_progress","completed","failed"]},"taskNum":{"type":"integer","format":"int64"}},"description":"Report Template detail info"},"ReportSummaryInfo":{"required":["hasTask","nextRunTime","onVmanage","reportId","reportName","reportStatus","schedule","taskNum","timeFrame"],"type":"object","properties":{"emailRecipient":{"type":"array","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"],"items":{"type":"string","description":"Email address list to receive the report files","example":"[\"alice@cisco.com\",\"bob@google.com\"]"}},"hasTask":{"type":"boolean","description":"If the report template has running task records or not","example":true},"nextRunTime":{"type":"integer","description":"Report next running timestamp","format":"int64","example":1655991420000},"onVmanage":{"type":"string","description":"vManage which scheduled report generating tasks","example":"10.1.1.100"},"reportId":{"type":"string","description":"The report UUID for report template","format":"uuid","example":"50671437-c88e-4514-aafa-103e58c4d9cc"},"reportName":{"type":"string","description":"The report template name","example":"Daily-report"},"reportStatus":{"type":"string","description":"Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))","example":"in_progress","enum":["not_scheduled","scheduled","in_progress","completed","failed"]},"schedule":{"type":"string","description":"Report schedule information","example":"Daily"},"taskNum":{"type":"integer","description":"The number of scheduled tasks for report template","format":"int64","example":10},"timeFrame":{"type":"string","description":"Report time frame(7 Days/30 Days)","example":"7"}},"description":"Report summary information"},"ReportSummaryResponse":{"required":["reports"],"type":"object","properties":{"header":{"type":"object","additionalProperties":{"type":"object"}},"reports":{"type":"array","description":"Report List","items":{"$ref":"#/components/schemas/ReportSummaryInfo"}}},"description":"Query all reports summary information response"},"ReportTaskProcessStepInfo":{"required":["fileGenerated","reportDataQuery"],"type":"object","properties":{"emailSent":{"type":"boolean","description":"Email sent or not, if sending report via email is enabled","example":true},"fileGenerated":{"type":"boolean","description":"Report file is generated or not","example":true},"fileReplicated":{"type":"boolean","description":"Report file is all replicated or not when vManage is a cluster deployment","example":true},"reportDataQuery":{"type":"boolean","description":"Report data query success or not","example":true}},"description":"The detail status for each step of report generating task"},"ReportTaskQueryResponse":{"required":["taskList"],"type":"object","properties":{"header":{"type":"object","additionalProperties":{"type":"object"}},"taskList":{"type":"array","description":"Report Task list for specific report ID","items":{"$ref":"#/components/schemas/ReportTaskUIInfo"}}},"description":"Report task query response"},"ReportTaskUIInfo":{"required":["reportId","reportName","schedule","startTime","taskId","taskStatus","taskStepDetail","timeFrame"],"type":"object","properties":{"emailRecipient":{"type":"array","description":"Email address to receive the report files","example":["alice@cisco.com"],"items":{"type":"string","description":"Email address to receive the report files","example":"[\"alice@cisco.com\"]"}},"endTime":{"type":"integer","description":"Report task end timestamp","format":"int64","example":1656677563859},"followerVmanages":{"type":"array","description":"In Cluster deployment, the follower vManage IP address which needs to replicate the report file from source vManage which generated the report file.","example":["10.0.105.38","10.0.105.39"],"items":{"type":"string","description":"In Cluster deployment, the follower vManage IP address which needs to replicate the report file from source vManage which generated the report file.","example":"[\"10.0.105.38\",\"10.0.105.39\"]"}},"onVmanage":{"type":"string","description":"IP address of the source vManage which is scheduled to generate report file. Default value is \"localhost\" for single node vManage deployment.","example":"10.0.105.32"},"reportDownloadUrl":{"type":"string","description":"Report file download URL","example":"/reports/6f4464a5-f656-4407-acac-4c273e143a0a/tasks/c3855560-462b-46d6-8c2e-82cc9cfc105a/download"},"reportId":{"type":"string","description":"Report Template UUID","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66af26"},"reportName":{"type":"string","description":"Report name for task","example":"SJC site summary report-20220916-123123"},"schedule":{"type":"string","description":"Report schedule information","example":"Daily"},"startTime":{"type":"integer","description":"Report task start timestamp","format":"int64","example":1656677463859},"taskId":{"type":"string","description":"Task UUID","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"taskStatus":{"type":"string","description":"Report Task status","example":"in_progress","enum":["failure","in_progress","success"]},"taskStepDetail":{"$ref":"#/components/schemas/ReportTaskProcessStepInfo"},"timeFrame":{"type":"string","description":"Report time frame (7 Days or 30 Days)","example":"7"}},"description":"Report Task list for specific report ID"},"ResourceGroup":{"type":"object","properties":{"desc":{"type":"string"},"deviceIPs":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"deviceIps":{"uniqueItems":true,"type":"array","writeOnly":true,"items":{"type":"string"}},"id":{"type":"object"},"mgmtSytemIpsMap":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"siteIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}},"siteIdsIncludeShared":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int64"}},"uuidSytemIpsMap":{"type":"object","additionalProperties":{"type":"string"}}}},"ResourceGroupsResponse":{"type":"object","properties":{"resourceGroupId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group"},"source":{"type":"string","example":"azureStored"}}},"RuleTypes":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"type":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}}},"SDAVCCloudConnector":{"required":["name","value"],"type":"object","properties":{"name":{"type":"string","example":"testName"},"value":{"type":"string","example":"testValue"}}},"SGTResponse":{"type":"object","properties":{"securityGroups":{"type":"array","items":{"$ref":"#/components/schemas/SecurityGroup"}}},"description":"Security Groups Returned from ISE"},"SSIDConfig":{"type":"object","properties":{"qosSettings":{"pattern":"(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)","type":"string"},"securityAuthType":{"pattern":"(OPEN|WPA2-PSK_AES)","type":"string"},"ssid":{"maxLength":32,"minLength":1,"type":"string"},"visibility":{"type":"boolean"},"wpaPskKey":{"type":"string"}}},"ScheduleConfig":{"required":["scheduleType"],"type":"object","properties":{"scheduleType":{"type":"string","description":"Schedule type","example":"on_demand","enum":["on_demand","reoccur_onetime","reoccur_daily","reoccur_weekly","reoccur_monthly"]}},"description":"schedule config","discriminator":{"propertyName":"scheduleType"},"oneOf":[{"$ref":"#/components/schemas/OnDemandSchedule"},{"$ref":"#/components/schemas/OneTimeSchedule"},{"$ref":"#/components/schemas/ReoccurDailySchedule"},{"$ref":"#/components/schemas/ReoccurWeeklySchedule"},{"$ref":"#/components/schemas/ReoccurMonthlySchedule"}]},"SdraDeviceStatsShort":{"type":"object","properties":{"host_name":{"type":"string"},"ipsec_anyconnect":{"type":"integer","format":"int64"},"ipsec_soho":{"type":"integer","format":"int64"},"ipsec_unknown":{"type":"integer","format":"int64"},"site_id":{"type":"integer","format":"int64"},"sslvpn_anyconnect":{"type":"integer","format":"int64"},"system_ip":{"type":"string"}}},"SdraHeadendSummary":{"type":"object","properties":{"ipsec_enabled":{"type":"integer","format":"int64"},"sslvpn_enabled":{"type":"integer","format":"int64"}}},"SdraSessionCount":{"type":"object","properties":{"ipsec_anyconnect":{"type":"integer","format":"int64"},"ipsec_soho":{"type":"integer","format":"int64"},"ipsec_unknown":{"type":"integer","format":"int64"},"sslvpn_anyconnect":{"type":"integer","format":"int64"}}},"SdraSessionSummary":{"type":"object","properties":{"top":{"type":"array","items":{"$ref":"#/components/schemas/SdraDeviceStatsShort"}},"total":{"$ref":"#/components/schemas/SdraSessionCount"}}},"SecurityGroup":{"type":"object","properties":{"description":{"type":"string","example":"Any Security Group"},"id":{"type":"string","example":"92bb1950-8c01-11e6-996c-525400b48521"},"name":{"type":"string","example":"ANY"},"tag":{"type":"integer","format":"int32","example":65535}}},"SecurityPolicy":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"policyName":{"type":"string"},"defaultAction":{"pattern":"(drop|pass)","type":"string"},"policyRules":{"type":"array","items":{"$ref":"#/components/schemas/PolicyRule"}}}}]},"SecurityPolicyDeviceList":{"required":["amp_down","amp_up","ips_down","ips_up","urlf_down","urlf_up","zbfw_down","zbfw_up"],"type":"object","properties":{"amp_down":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"amp_up":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"ips_down":{"type":"array","example":["2.2.2.2"],"items":{"type":"string","example":"[\"2.2.2.2\"]"}},"ips_up":{"type":"array","example":["1.1.1.1"],"items":{"type":"string","example":"[\"1.1.1.1\"]"}},"urlf_down":{"type":"array","example":["3.3.3.3"],"items":{"type":"string","example":"[\"3.3.3.3\"]"}},"urlf_up":{"type":"array","example":["1.1.1.1"],"items":{"type":"string","example":"[\"1.1.1.1\"]"}},"zbfw_down":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"zbfw_up":{"type":"array","example":["1.1.1.1","2.2.2.2","3.3.3.3"],"items":{"type":"string","example":"[\"1.1.1.1\",\"2.2.2.2\",\"3.3.3.3\"]"}}}},"SeveritySummary":{"type":"object"},"SimSlotConfig":{"required":["attachProfileId","profileList","slotNumber"],"type":"object","properties":{"attachProfileId":{"maximum":16,"minimum":1,"type":"integer","format":"int32"},"carrierName":{"type":"string"},"dataProfileIdList":{"maxItems":1,"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}},"profileList":{"maxItems":16,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CellularProfile"}},"slotNumber":{"maximum":1,"minimum":0,"type":"integer","format":"int32"}}},"SimpleKeyValueMapping":{"type":"object","properties":{"key":{"type":"string","example":"system"},"value":{"type":"string","example":"System"}}},"SimpleMessageResponse":{"type":"object","properties":{"Message":{"type":"string","example":"Successfully dump data in log file"}}},"SiteHealth":{"type":"object","properties":{"fullConnectivity":{"type":"integer","format":"int32"},"noConnectivity":{"type":"integer","format":"int32"},"partialConnectivity":{"type":"integer","format":"int32"}}},"SiteHealthItem":{"required":["apps_health","apps_usage","devices_health","site_health","site_id","tunnels_health"],"type":"object","properties":{"apps_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"apps_usage":{"type":"number","example":1000},"devices_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"site_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"site_id":{"type":"string","example":"600"},"tunnels_health":{"type":"string","example":"good","enum":["good","fair","poor"]}}},"SiteHealthTopologyItem":{"required":["fair_site_count","good_site_count","poor_site_count"],"type":"object","properties":{"fair_site_count":{"type":"number","example":20},"good_site_count":{"type":"number","example":30},"poor_site_count":{"type":"number","example":10}}},"SmartAccountModel":{"type":"object","properties":{"clientCredentials":{"type":"boolean"},"env":{"type":"string"},"organization_name":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"},"validity_string":{"type":"string"}}},"SoftwareVersion":{"required":["activeVersion","lastupdated","vdevice-dataKey","vdevice-host-name","vdevice-name"],"type":"object","properties":{"activeVersion":{"type":"string","example":"17.12.01.0.169449"},"lastupdated":{"type":"number","example":1674025491478},"vdevice-dataKey":{"type":"string","example":"172.16.255.11-"},"vdevice-host-name":{"type":"string","example":"vm1"},"vdevice-name":{"type":"string","example":"172.16.255.11"}}},"Span":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/SpanContext"},"recording":{"type":"boolean"},"status":{"$ref":"#/components/schemas/Status"}}},"SpanContext":{"type":"object","properties":{"remote":{"type":"boolean"},"spanId":{"$ref":"#/components/schemas/SpanId"},"traceFlags":{"$ref":"#/components/schemas/TraceFlags"},"traceId":{"$ref":"#/components/schemas/TraceId"},"traceState":{"$ref":"#/components/schemas/TraceState"},"valid":{"type":"boolean"}}},"SpanId":{"type":"object","properties":{"valid":{"type":"boolean"}}},"SshKeyList":{"type":"object","properties":{"sshKeyName":{"type":"string"}}},"StatisticsProcessingCounters":{"type":"object","properties":{"counters":{"type":"array","items":{"$ref":"#/components/schemas/StatsTypeProcessingCounters"}}}},"StatsTypeProcessingCounters":{"type":"object","properties":{"compressed_size":{"type":"integer","format":"int64"},"files_number":{"type":"integer","format":"int64"},"processing_time":{"type":"integer","format":"int64"},"records_number":{"type":"integer","format":"int64"},"stats_type":{"type":"string"},"uncompressed_size":{"type":"integer","format":"int64"}}},"Status":{"type":"object","properties":{"canonicalCode":{"type":"string","enum":["OK","CANCELLED","UNKNOWN","INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS","UNAUTHENTICATED"]},"description":{"type":"string"},"ok":{"type":"boolean"}}},"StatusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}},"StatusObject":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"message":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}}},"SwImagesResponse":{"type":"object","properties":{"deviceModel":{"type":"string","example":"vedge-C8000V"},"displayName":{"type":"string","example":"C8000v 17.04.01b"},"isPaygImage":{"type":"boolean","example":false},"softwareImageId":{"type":"string","example":"Cisco-C8k-17.04.01b-42cb6e93-8d9d-490b-a73c-e3e56077ffd1"},"version":{"type":"string","example":"17.04.01b"}}},"SyncDevicesResp":{"type":"object","properties":{"processId":{"type":"string","example":"c82d4877-dc04-4580-aedc-3a10166dab4d"}}},"SyncRootCertChain":{"type":"object","properties":{"syncRootCertChain":{"type":"string","example":"done"}}},"SyncStatusResponse":{"type":"object","properties":{"Last Synced":{"type":"string","example":"04 Dec 2020 19:23:54 UTC"},"webexSyncNeeded":{"type":"boolean","example":true}}},"Systems":{"type":"object","properties":{"consoleBaudRate":{"type":"string"},"description":{"type":"string"},"deviceGroup":{"type":"string"},"gpsLatitude":{"type":"string"},"gpsLongitude":{"type":"string"},"hostName":{"type":"string"},"location":{"type":"string"},"onDemandTunnel":{"type":"string"},"onDemandTunnelIdleTimeout":{"type":"integer","format":"int32"},"portHopping":{"type":"string"},"portOffset":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"systemIp":{"type":"string"},"timeZone":{"type":"string"}}},"Tacacs":{"type":"object","properties":{"authentication":{"type":"string","enum":["ASCII","PAP"]},"server":{"type":"array","items":{"$ref":"#/components/schemas/TacacsServer"}},"timeout":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}}},"TacacsServer":{"type":"object","properties":{"address":{"type":"string"},"authPort":{"type":"integer","format":"int32"},"key":{"type":"string"},"priority":{"maximum":7,"minimum":1,"type":"integer","format":"int32"},"secretKey":{"type":"string"},"vpn":{"maximum":65535,"minimum":1,"type":"integer","format":"int32"},"vpnIpSubnet":{"type":"string"}}},"TagRuleInfo":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/TagRuleInfoDevices"}},"isConflict":{"type":"boolean"},"parentTaskId":{"type":"string"}}},"TagRuleInfoDevices":{"type":"object","properties":{"devicesWithConfigGroup":{"type":"array","items":{"type":"string"}},"devicesWithTemplateConfig":{"type":"array","items":{"type":"string"}},"matchingDevices":{"type":"array","items":{"$ref":"#/components/schemas/TagRuleInfoMatchingDevices"}}}},"TagRuleInfoMatchingDevices":{"type":"object","properties":{"chassisNumber":{"type":"string"},"configuredSiteId":{"type":"string"},"configuredSystemIP":{"type":"string"},"deploymentStatus":{"type":"string"},"deviceModel":{"type":"string"},"serialNumber":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"TagsResponse":{"type":"object","properties":{"tag":{"type":"string","example":"test-tag"}}},"TaskHistoryResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskHistoryResponsePayloadData"}}},"description":"Auto on task schema for GET response"},"TaskHistoryResponsePayloadData":{"type":"object","properties":{"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"events":{"type":"array","items":{"type":"string"}},"expire-time":{"type":"integer","format":"int32"},"sites":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"},"traces":{"type":"boolean"},"type":{"type":"string"}}},"TaskId":{"type":"object","properties":{"id":{"type":"string","example":"reboot-01232017T154359940"}}},"TaskIdResponse":{"required":["taskId"],"type":"object","properties":{"taskId":{"type":"string","description":"Task ID","format":"uuid","example":"e2e28c40-cb1e-45d7-9637-98e145a70174"}}},"TaskTracesResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Auto on task schema for GET response","items":{"$ref":"#/components/schemas/TaskTracesResponsePayloadInner"}},"TaskTracesResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Auto on task schema for GET response"},"Taskid":{"type":"object","properties":{"id":{"type":"string","example":"6c723f65-9106-4f43-9d2b-a033a39353b3"}},"description":"Task id for polling status"},"TasksCreatePostRequestPayload":{"type":"object","properties":{"duration":{"type":"string","description":"Task duration"},"events":{"type":"array","description":"Event list","items":{"type":"string","description":"Event list"}},"sites":{"type":"array","description":"Site list","items":{"type":"string","description":"Site list"}},"taskName":{"type":"string","description":"Task name"}},"description":"Auto on task create schema for POST request"},"TasksCreateResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"expire-time":{"type":"integer","format":"int32"},"sites":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"}},"description":"Auto on task create schema for POST response"},"TasksDeleteResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"message":{"$ref":"#/components/schemas/TasksDeleteResponsePayloadMessage"},"taskId":{"type":"string"}},"description":"Auto on task schema for DELETE response"},"TasksDeleteResponsePayloadMessage":{"type":"object","properties":{"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"events":{"type":"string"},"expire-time":{"type":"integer","format":"int64"},"message":{"type":"string"},"sites":{"type":"string"},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"},"traces":{"type":"boolean"}}},"TasksStopResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"message":{"type":"string"},"state":{"type":"string"},"taskId":{"type":"string"},"taskName":{"type":"string"}},"description":"Auto on task stop schema for POST response"},"Telemetry":{"type":"object","properties":{"meter":{"$ref":"#/components/schemas/Meter"},"tracer":{"$ref":"#/components/schemas/Tracer"}}},"TenantStatus":{"type":"object","properties":{"controlStatus":{"$ref":"#/components/schemas/ControlStatus"},"getvEdgeHealth":{"$ref":"#/components/schemas/VEdgeHealth"},"getvSmartStatus":{"$ref":"#/components/schemas/VSmartStatus"},"siteHealth":{"$ref":"#/components/schemas/SiteHealth"},"tenantId":{"type":"string"},"tenantName":{"type":"string"}}},"TenantStatusListModel":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TenantStatus"}},"header":{"$ref":"#/components/schemas/Header"}}},"Threadpool":{"type":"object","properties":{"consumerClass":{"type":"string","example":"com.viptela.vmanage.server.device.common.DataCollectionManager"},"consumerMethod":{"type":"string","example":"startMonitorThreads"},"threadPoolName":{"type":"string","example":"sync-queue-monitor"},"threadPoolSize":{"type":"integer","format":"int64","example":1}}},"ThreadpoolsResponse":{"type":"object","properties":{"threadPools":{"type":"array","items":{"$ref":"#/components/schemas/Threadpool"}},"totalThreadCount":{"type":"integer","format":"int64","example":300}}},"TimeOptions":{"type":"object","properties":{"enableDateFields":{"type":"boolean","example":false},"key":{"type":"string","example":"last_24_hours"},"value":{"type":"string","example":"Last 24 hours"}}},"Tokens":{"type":"object","properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer","format":"int32"},"refresh_token":{"type":"string"},"scope":{"type":"string"},"token_type":{"type":"string"}},"description":"Response from Cisco SecureX token API"},"Topology":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/Device"}},"siteDevices":{"type":"integer","format":"int32"}}},"TopologyGroup":{"required":["name","solution","state","version"],"type":"object","properties":{"activeStatus":{"type":"boolean"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"Mobility","enum":["mobility","sdwan","common","nfvirtual"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"version":{"type":"integer","description":" Group Version Flag","format":"int64"}}},"TraceCftRecordResponsePayload":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TraceCftRecordResponsePayloadData"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Get cft record for GET response"},"TraceCftRecordResponsePayloadData":{"type":"object","properties":{"agg_total_bytes":{"type":"integer","format":"int32"},"agg_total_fif_bytes":{"type":"integer","format":"int32"},"agg_total_fif_packets":{"type":"integer","format":"int32"},"agg_total_fin_flows":{"type":"integer","format":"int32"},"agg_total_flows":{"type":"integer","format":"int32"},"agg_total_packets":{"type":"integer","format":"int32"},"agg_total_ttl_ms":{"type":"integer","format":"int32"},"app_group":{"type":"string"},"app_name":{"type":"string"},"avg_bps":{"type":"integer","format":"int32"},"avg_concurrent_flows":{"type":"integer","format":"int32"},"avg_cps":{"type":"number"},"avg_pps":{"type":"number"},"avg_ttl_ms":{"type":"number"},"bps":{"type":"integer","format":"int32"},"concurrent_flows":{"type":"integer","format":"int32"},"cps":{"type":"number"},"device_name":{"type":"string"},"device_trace_id":{"type":"integer","format":"int32"},"device_uuid":{"type":"string"},"if_name":{"type":"string"},"last_report_ts":{"type":"integer","format":"int32"},"local_color":{"type":"string"},"max_bps":{"type":"integer","format":"int32"},"max_concurrent_flows":{"type":"integer","format":"int32"},"max_cps":{"type":"number"},"max_pps":{"type":"number"},"max_ttl_ms":{"type":"integer","format":"int32"},"min_bps":{"type":"integer","format":"int32"},"min_concurrent_flows":{"type":"integer","format":"int32"},"min_cps":{"type":"number"},"min_pps":{"type":"number"},"min_ttl_ms":{"type":"integer","format":"int32"},"model":{"type":"string"},"pps":{"type":"number"},"received_timestamp":{"type":"integer","format":"int64"},"system_ip":{"type":"string"},"vpn_id":{"type":"integer","format":"int32"}}},"TraceFlags":{"type":"object","properties":{"byte":{"type":"string","format":"byte"},"sampled":{"type":"boolean"}}},"TraceId":{"type":"object","properties":{"traceRandomPart":{"type":"integer","format":"int64"},"valid":{"type":"boolean"}}},"TraceInfoResponsePayload":{"type":"object","properties":{"entry_time":{"type":"integer","format":"int64"},"summary":{"$ref":"#/components/schemas/TraceInfoResponsePayloadSummary"},"trace-id":{"type":"integer","format":"int32"}},"description":"Trace base info Data Response schema"},"TraceInfoResponsePayloadSummary":{"type":"object","properties":{"agg-client-prefix":{"type":"string"},"agg-src-sgt":{"type":"string"},"agg-svr-prefix":{"type":"string"},"app":{"type":"string"},"app-grp":{"type":"string"},"app-vis":{"type":"string"},"art-vis":{"type":"string"},"common_app":{"type":"string"},"device-ip":{"type":"string"},"dia-vis":{"type":"string"},"domain-mon":{"type":"string"},"dscp":{"type":"string"},"dst-ip":{"type":"string"},"dst-pfx":{"type":"string"},"dst-pfx-len":{"type":"string"},"dst-port":{"type":"string"},"duration":{"type":"string"},"hub-wan-vis":{"type":"string"},"local-drop-rate-threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos-mon":{"type":"string"},"sampling":{"type":"string"},"source-site":{"type":"string"},"source-site-vmanage-version":{"type":"string"},"spl-intvl":{"type":"string"},"src-if":{"type":"string"},"src-ip":{"type":"string"},"src-pfx":{"type":"string"},"src-pfx-len":{"type":"string"},"src-port":{"type":"string"},"state":{"type":"string"},"stop-time":{"type":"integer","format":"int64"},"taskId":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"trace-trigger-event":{"type":"string"},"vpn-id":{"type":"string"},"vpn-list":{"type":"string"},"wan-drop-rate-threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}}},"TraceState":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}}}},"Tracer":{"type":"object","properties":{"currentSpan":{"$ref":"#/components/schemas/Span"}}},"TunnelHealthData":{"type":"object","properties":{"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"loss_percentage":{"type":"number","format":"double"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}}},"TunnelHealthHistoryItem":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"history":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthEntryItem"}},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"summary":{"$ref":"#/components/schemas/TunnelHealthData"}}},"TunnelHealthOverview":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/TunnelHealthOverviewDetail"},"total":{"$ref":"#/components/schemas/TunnelHealthOverviewTotal"}}},"TunnelHealthOverviewDetail":{"type":"object","properties":{"fair":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthOverviewEntry"}},"good":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthOverviewEntry"}},"poor":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthOverviewEntry"}}}},"TunnelHealthOverviewEntry":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"loss_percentage":{"type":"number","format":"double"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}}},"TunnelHealthOverviewTotal":{"type":"object","properties":{"fair":{"type":"number","example":100},"good":{"type":"number","example":100},"poor":{"type":"number","example":100}}},"TunnelScallingRequestPayload":{"type":"object","properties":{"branchEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/TunnelScallingRequestPayloadBranchEndpoints"}},"cloudType":{"type":"string","example":"AWS"}}},"TunnelScallingRequestPayloadBranchEndpoints":{"type":"object","properties":{"acceleratedVpn":{"type":"boolean","example":true},"cloudType":{"type":"string","example":"AWS"},"color":{"type":"string","example":"red"},"hostName":{"type":"string","example":"test_device"},"siteId":{"type":"string","example":"578"},"status":{"type":"string","example":"unavailable"},"systemIp":{"type":"string","example":"1.1.1.178"},"tunnelCount":{"type":"number","example":4},"uuid":{"type":"string","example":"C8K-b78a317a-0d6c-4023-9690-8559d6ac803d"}}},"Tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"$ref":"#/components/schemas/TunnelsInner"}},"TunnelsInner":{"type":"object","properties":{"acceptedRouteCount":{"type":"integer","format":"int32"},"lastStatusChangeTimestamp":{"type":"string"},"outerIpAddr":{"type":"string"},"status":{"type":"string"},"statusMessage":{"type":"string"},"tunnelId":{"type":"string"},"tunnelInnerIp":{"type":"array","items":{"type":"string"}}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"UMTSInput":{"type":"object","properties":{"deviceUUID":{"type":"object","example":"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f"},"localColor":{"type":"string","example":"lte"},"remoteColor":{"type":"string","example":"remote-color-all"},"remoteSystem":{"type":"string","example":"172.16.255.16,172.16.255.14"}}},"UMTSRecord":{"type":"object","properties":{"event_subtype":{"type":"string","example":"NONE"},"event_type":{"type":"string","example":"PERIODIC"},"hops":{"$ref":"#/components/schemas/UMTSRecordHop"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.15"},"proto":{"type":"string","example":"ipsec"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.202"},"sent_qos":{"type":"number","example":72},"state":{"type":"string","example":"up"},"vip_idx":{"type":"number","example":99},"vip_time":{"type":"number","example":1643400901399}}},"UMTSRecordHop":{"type":"object","properties":{"hop":{"type":"array","items":{"$ref":"#/components/schemas/UMTSRecordHopsHop"}}}},"UMTSRecordHopsHop":{"type":"object","properties":{"hostname":{"type":"string","example":"vm5"},"idx":{"type":"number","example":99},"ip":{"type":"string","example":"10.1.15.13"},"jitter":{"type":"number","example":0},"lbl_info":{"type":"number","example":0},"loss":{"type":"number","example":0},"recv_qos":{"type":"number","example":0},"reply_qos":{"type":"number","example":0},"rtt":{"type":"number","example":0},"rtt_max":{"type":"number","example":0},"rtt_min":{"type":"number","example":0}}},"UMTSSaveInput":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/UMTSRecord"}}}},"UMTSSession":{"type":"object","properties":{"download_status":{"type":"string","example":"success"},"payload":{"type":"string","example":"{\"deviceUUID\":\"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f\",\"localColor\":\"lte\",\"remoteSystem\":\"172.16.255.16\",\"remoteColor\":\"lte\",\"actionType\":\"ON_DEMANDING\",\"sessionId\":\"5596803a-e594-413b-89f2-2acecd1d5f92\"}"},"renewalTime":{"type":"number","example":1654566270967},"requestStatus":{"type":"string","example":"stop"},"sessionId":{"type":"string","example":"5596803a-e594-413b-89f2-2acecd1d5f92"},"startTime":{"type":"number","example":1654566270968},"status":{"type":"string","example":"success"},"statusMessage":{"type":"string","example":"device error"},"type":{"type":"string","example":"ON_DEMANDING"},"user":{"type":"string","example":"admin"},"userIp":{"type":"string","example":"100.1.2.3"},"uuid":{"type":"string","example":"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f"}}},"Umbrella":{"type":"object","properties":{"api-key":{"$ref":"#/components/schemas/APIKey"},"api-secret":{"$ref":"#/components/schemas/APISecret"},"org-id":{"$ref":"#/components/schemas/OrgID"}},"description":"Umbrella object"},"UnsupportedFeature":{"type":"object","properties":{"parcelId":{"type":"string","format":"uuid"},"parcelType":{"type":"string","enum":["wan/vpn/interface/gre","wan/vpn/interface/ethernet","wan/vpn/interface/cellular","wan/vpn/interface/ipsec","wan/vpn/interface/serial","routing/ospf","lan/vpn/interface/ethernet","lan/vpn/interface/svi","lan/vpn/interface/ipsec","lan/vpn"]}}},"UpdateCgw":{"type":"object","properties":{"accountId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string"},"description":{"type":"string"},"deviceChanges":{"$ref":"#/components/schemas/UpdateCgwDeviceChanges"},"devices":{"type":"array","description":"Used for AZURE updateCgw","items":{"type":"string","description":"Used for AZURE updateCgw"}},"mrfRouterRole":{"type":"string"},"region":{"type":"string"},"resourceGroupName":{"type":"string","description":"Used for AZURE updateCgw"},"s2sPermitted":{"type":"boolean","description":"Used for GCP updateCgw"},"settings":{"$ref":"#/components/schemas/AllOfupdateCgwSettings"},"vhubId":{"type":"string","description":"Used for AZURE updateCgw"}}},"UpdateCgwDeviceChanges":{"type":"object","properties":{"devicesAdded":{"type":"array","items":{"type":"string"}},"devicesDeleted":{"type":"array","items":{"type":"string"}}},"description":"Used for GCP updateCgw"},"UpdateReportTemplateResponse":{"required":["reportId"],"type":"object","properties":{"reportId":{"type":"string","description":"Report ID","format":"uuid","example":"e2e28c40-cb1e-45d7-9637-98e145a70174"}}},"UpdateTenantModel":{"type":"object","properties":{"desc":{"type":"string"},"edgeConnectorEnable":{"type":"boolean"},"edgeConnectorSystemIp":{"type":"string"},"edgeConnectorTunnelInterfaceName":{"type":"string"},"getvBondAddress":{"type":"string"},"getvSmarts":{"type":"array","items":{"type":"string"}},"idpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"name":{"type":"string"},"oldIdpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"spMetadata":{"type":"string"},"subDomain":{"type":"string"},"wanEdgeForecast":{"type":"string"}}},"UpdateTenantvSmartModel":{"type":"object","properties":{"destvSmartUuid":{"type":"string"},"srcvSmartUuid":{"type":"string"}}},"UserGroupsBody":{"type":"object","properties":{"filter":{"type":"string","example":"Cert Publishers"}}},"UserGroupsDataObject":{"type":"object","properties":{"ERSActiveDirectoryGroups":{"$ref":"#/components/schemas/ERSActiveDirectoryGroups"}},"description":"Data Object for Users Groups call"},"UserGroupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupsDataObject"},"header":{"$ref":"#/components/schemas/HeaderObject"}},"description":"User Groups Data from ISE active directory domain"},"UserObject":{"type":"object","properties":{"adUserSamAccountName":{"type":"string","example":"guests"}},"description":"Object containing the users name"},"UsergroupObject":{"type":"object","properties":{"name":{"type":"string","example":"b1.com/Builtin/Administrators"},"sid":{"type":"string","example":"b1.com/S-1-5-32-544"},"type":{"type":"string","example":"BUILTIN, DOMAIN LOCAL"}}},"UsersBody":{"type":"object","properties":{"filter":{"type":"string"}},"description":"Users body with regex filter for which users to retrieve from ISE"},"UsersDataObject":{"type":"object","properties":{"ERSActiveDirectoryUsers":{"$ref":"#/components/schemas/ERSActiveDirectoryUsers"}},"description":"Data Object for Users get call"},"UsersResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UsersDataObject"},"header":{"$ref":"#/components/schemas/HeaderObject"}},"description":"Users returned from ISE active directory domain"},"Uuid":{"type":"object","properties":{"uuid":{"type":"string"}},"description":"This is valid uuid"},"UuidToDomainId":{"type":"object","properties":{"domain":{"type":"string"},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/UuidToDomainIdMapping"}}}},"UuidToDomainIdMapping":{"type":"object","properties":{"domainId":{"type":"integer","format":"int32"},"uuid":{"type":"string"}}},"VEdgeBootstrapConfig":{"type":"object","properties":{"bootstrapConfigType":{"type":"string"},"uuid":{"type":"array","items":{"type":"string"}}}},"VEdgeHealth":{"type":"object","properties":{"error":{"type":"integer","format":"int32"},"normal":{"type":"integer","format":"int32"},"warning":{"type":"integer","format":"int32"}}},"VPNID":{"type":"object","properties":{"vpn":{"type":"string"}},"description":"This is the valid list of VPN-IDs"},"VSmartStatus":{"type":"object","properties":{"down":{"type":"integer","format":"int32"},"up":{"type":"integer","format":"int32"}}},"Variable":{"required":["jsonPath","varName"],"type":"object","properties":{"jsonPath":{"type":"string"},"varName":{"type":"string"}}},"VedgeCheckResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VedgeCheckResponseData"},"header":{"$ref":"#/components/schemas/VedgeCheckResponseHeader"}}},"VedgeCheckResponseData":{"type":"object","properties":{"vEdgeDevicePresent":{"type":"boolean"}},"description":"data field"},"VedgeCheckResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderFields"}},"generatedOn":{"type":"integer","format":"int64"},"viewKeys":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderViewKeys"}},"description":"header field"},"VedgeCheckResponseHeaderColumns":{"type":"object","properties":{"actionColumn":{"type":"boolean"},"arrayDataType":{"type":"string"},"color":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsColor"},"colorProperty":{"type":"string"},"dataType":{"type":"string"},"defaultPropertyKey":{"type":"string"},"defaultPropertyValue":{"type":"string"},"display":{"type":"string"},"displayFormat":{"type":"string"},"editable":{"type":"boolean"},"hideable":{"type":"boolean"},"hostValueType":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsKeyvalue"}},"iconProperty":{"type":"string"},"inputFormat":{"type":"string"},"isLeftPinned":{"type":"boolean"},"isPinned":{"type":"boolean"},"keyvalue":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsKeyvalue"}},"keyvalueProperty":{"type":"string"},"maxWidth":{"type":"integer","format":"int32"},"minWidth":{"type":"integer","format":"int32"},"prependedString":{"type":"boolean"},"property":{"type":"string"},"sort":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsSort"},"title":{"type":"string"},"toolTipProperty":{"type":"string"},"visible":{"type":"boolean"},"width":{"type":"integer","format":"int32"}}},"VedgeCheckResponseHeaderColumnsColor":{"type":"object","properties":{"key":{"type":"string"},"property":{"type":"string"},"value":{"type":"string"}}},"VedgeCheckResponseHeaderColumnsKeyvalue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"VedgeCheckResponseHeaderColumnsSort":{"type":"object","properties":{"direction":{"type":"string"},"priority":{"type":"integer","format":"int32"}}},"VedgeCheckResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","description":"dataType field"},"display":{"type":"string","description":"display field"},"property":{"type":"string","description":"property field"}}},"VedgeCheckResponseHeaderViewKeys":{"type":"object","properties":{"uniqueKey":{"type":"array","items":{"type":"string"}}}},"VedgeInventoryData":{"type":"object","properties":{"chasisNumber":{"type":"string","example":"0a452cf0-5db7-47c2-80bf-7e619e294a6b"},"deviceType":{"type":"string","example":"vedge"},"local-system-ip":{"type":"string","example":"172.16.255.14"},"serialNumber":{"type":"string","example":"12345707"},"site-id":{"type":"string","example":"400"},"system-ip":{"type":"string","example":"0.0.0.0"},"validity":{"type":"string","example":"valid"}}},"VersionInformation":{"type":"object","properties":{"currentServerVersion":{"type":"string","example":"1.2"},"link":{"$ref":"#/components/schemas/LinkObject"},"supportedVersions":{"type":"string","example":"1.0,1.1,1.2"}}},"VertexDefinitions":{"type":"object","properties":{"inEdges":{"type":"array","items":{"type":"string"}},"name":{"type":"string","example":"TemplateMaster"},"outEdges":{"type":"array","items":{"type":"string"}},"properties":{"type":"array","items":{"$ref":"#/components/schemas/Properties"}}}},"VhubsListResponse":{"type":"object","properties":{"source":{"type":"string","example":"vManage"},"vhubId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/cgw-test"},"vhubName":{"type":"string","example":"cgw-test"}}},"VnfType":{"type":"object","properties":{"vnfType":{"type":"string"}},"description":"This is the valid VnfType"},"VsmartSyncResponse":{"type":"object","properties":{"id":{"type":"string","example":"push_file_template_configuration-9101ae23-c48b-4c33-af3a-4444e4a63b02"}},"description":"Response for a vsmart sync with the task id for the push from vManage to vSmarts"},"VwanListResponse":{"type":"object","properties":{"source":{"type":"string","example":"vmanage"},"vwanId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualWans/test-vwan"},"vwanName":{"type":"string","example":"test-vwan"}}},"WanEdgeDevicesResponse":{"type":"object","properties":{"configuredHostName":{"type":"string","example":"aws-test2"},"configuredSystemIp":{"type":"string","example":"9.1.1.2"},"deviceModel":{"type":"string","example":"vedge-C8000V"},"isPaygUuid":{"type":"boolean","example":false},"uuid":{"type":"string","example":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1"}}},"WanSpec":{"required":["accountId","cloudRegion","mappedBranches","resourceGroup","vpn"],"type":"object","properties":{"accountId":{"type":"string","format":"uuid"},"cloudRegion":{"type":"string"},"mappedBranches":{"type":"string"},"resourceGroup":{"type":"string"},"vpn":{"type":"string"},"wanId":{"type":"string","format":"uuid"}}},"WebexDataCenter":{"type":"object","properties":{"ETag":{"type":"string","example":"vmanagemockwebexetag"},"config":{"$ref":"#/components/schemas/Configinfo"}}},"WidgetStatus":{"type":"object","properties":{"count":{"type":"number"},"name":{"type":"string"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/WidgetStatusStatusList"}}}},"WidgetStatusStatusList":{"type":"object","properties":{"count":{"type":"number"},"message":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}}},"Widgets":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/CloudWidget"}},"Wifi":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"ssidConfigList":{"maxItems":4,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SSIDConfig"}},"guestWifi":{"$ref":"#/components/schemas/GuestWifi"},"corporateWifi":{"$ref":"#/components/schemas/CorporateWifi"},"advancedRadioSetting":{"$ref":"#/components/schemas/AdvancedRadioSetting"}}}]},"uploadHSECAuthFile":{"type":"object","properties":{"data":{"type":"string","format":"binary"}}},"Schema2HubGeneratedSecurityprofileparceltypePost":{"oneOf":[{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-inspection-profile/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/intrusion-prevention/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/url-filtering/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-malware-protection/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption-profile/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption/post/request_schema.json"}]},"Schema2HubGeneratedSecurityprofileparceltypePut":{"oneOf":[{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-inspection-profile/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/intrusion-prevention/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/url-filtering/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/advanced-malware-protection/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption-profile/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/unified/ssl-decryption/put/request_schema.json"}]},"Schema2HubGeneratedPolicyobjectlisttypePost":{"oneOf":[{"$ref":"schema/profileparcel/sdwan/policy-object/security-data-ip-prefix/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-fqdn/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-port/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-localapp/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-localdomain/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-ipssignature/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-urllist/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-protocolname/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-geolocation/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-identity/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-scalablegrouptag/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/app-list/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/sla-class/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/data-ipv6-prefix/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/data-prefix/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/policer/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/app-probe/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/tloc/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/color/post/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/preferred-color-group/post/request_schema.json"}]},"Schema2HubGeneratedPolicyobjectlisttypePut":{"oneOf":[{"$ref":"schema/profileparcel/sdwan/policy-object/security-data-ip-prefix/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-fqdn/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-port/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-localapp/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-localdomain/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-ipssignature/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-urllist/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-protocolname/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-geolocation/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-identity/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-scalablegrouptag/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/app-list/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/sla-class/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/class/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/data-ipv6-prefix/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/data-prefix/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/policer/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/app-probe/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/tloc/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/color/put/request_schema.json"},{"$ref":"schema/profileparcel/sdwan/policy-object/preferred-color-group/put/request_schema.json"}]}}}}
\ No newline at end of file
diff --git a/Cisco/Catalyst SD-WAN Manager/OpenAPIs/cisco_catalyst_sdwan_manager-20.15.json b/Cisco/Catalyst SD-WAN Manager/OpenAPIs/cisco_catalyst_sdwan_manager-20.15.json
new file mode 100644
index 0000000..b721760
--- /dev/null
+++ b/Cisco/Catalyst SD-WAN Manager/OpenAPIs/cisco_catalyst_sdwan_manager-20.15.json
@@ -0,0 +1 @@
+{"openapi":"3.0.1","info":{"title":"Cisco SD-WAN vManage API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"20.15","x-vendor-api-version":"2.0.0"},"servers":[{"url":"/dataservice"}],"paths":{"/aas/init":{"post":{"tags":["SDWAN as a Platform"],"summary":"Initialize SDWAN as a Platform","description":"Initialize SDWAN as a Platform","operationId":"initAasProperties","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitBlob"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/aas/reset-credentials/{credType}":{"post":{"tags":["SDWAN as a Platform"],"summary":"SDWAN as a Platform - Manage Credentials","description":"SDWAN as a Platform - Manage Credentials","operationId":"resetCredentials","parameters":[{"name":"credType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/accesstoken/{regionBaseUri}/{clientId}":{"get":{"tags":["Monitoring - SecureX Integration"],"description":"Get Access Token for SecureX Ribbon","operationId":"getSecureXAccessToken","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/aaa":{"get":{"tags":["Administration - User and Group"],"description":"Get aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getAaaConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aaa"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Administration - User and Group"],"description":"Update aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"updateAaaConfig","requestBody":{"description":"aaa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aaa"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"createAaaConfig","requestBody":{"description":"aaa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Aaa"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete aaa configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"deleteAaaConfig","responses":{"200":{"description":"Ok"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/events/{sseSessionId}":{"get":{"operationId":"listenAuthEvents","parameters":[{"name":"sseSessionId","in":"path","description":"sse session Id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/event-stream":{}}}}}},"/admin/radius":{"get":{"tags":["Administration - User and Group"],"description":"Get radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getRadiusConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Administration - User and Group"],"description":"Update radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"updateRadiusConfig","requestBody":{"description":"radius","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"createRadiusConfig","requestBody":{"description":"radius","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete radius configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"deleteRadiusConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/tacacs":{"get":{"tags":["Administration - User and Group"],"description":"Get tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getTacacsConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Administration - User and Group"],"description":"Update tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"updateTacacsConfig","requestBody":{"description":"tacacs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - User and Group"],"description":"Create tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"createTacacsConfig","requestBody":{"description":"tacacs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Administration - User and Group"],"description":"Delete tacacs configuration
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"deleteTacacsConfig","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tacacs"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/user":{"get":{"tags":["Administration - User and Group"],"description":"Get all users","operationId":"findUsers_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"User":{"description":"User","value":[]}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"},"post":{"tags":["Administration - User and Group"],"description":"Create a user","operationId":"createUser_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":"{\n \"group\":[\n \"demogrp\"\n ],\n \"description\":\"Demo User\",\n \"userName\":\"demouser\",\n \"password\":\"password\"\n \"locale\":\"en_US\"\n \"resGroupName\":\"global\"\n}"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/activeSessions":{"get":{"tags":["Administration - User and Group"],"description":"Get active sessions","operationId":"getActiveSessions_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"All active sessions for this tenant (except for the requesting session)":{"description":"All active sessions for this tenant (except for the requesting session)","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read"}},"/admin/user/admin/password":{"post":{"tags":["Administration - User and Group"],"description":"Update admin default password","operationId":"updateAdminPassword_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/admin/user/lockUser/{userName}":{"put":{"tags":["Administration - User and Group"],"description":"Lock a user account","operationId":"lockUser","parameters":[{"name":"userName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Lock user account":{"description":"Lock user account","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/password/validate":{"post":{"tags":["Administration - User and Group"],"description":"Validate user password","operationId":"validatePassword_1","requestBody":{"description":"User password","content":{"application/json":{"schema":{"type":"object"},"examples":{"User password":{"description":"User password","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Manage Users-read"}},"/admin/user/password/{userName}":{"put":{"tags":["Administration - User and Group"],"description":"Update user password","operationId":"updatePassword_1","parameters":[{"name":"userName","in":"path","description":"User name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/profile/locale":{"put":{"tags":["Administration - User and Group"],"description":"Update profile locale","operationId":"updateProfileLocale_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/admin/user/profile/password":{"put":{"tags":["Administration - User and Group"],"description":"Update profile password","operationId":"updateProfilePassword_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/admin/user/removeSessions":{"delete":{"tags":["Administration - User and Group"],"description":"Remove sessions","operationId":"removeSessions_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"List of sessions":{"description":"List of sessions","value":[]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/reset":{"post":{"tags":["Administration - User and Group"],"description":"Unlock a user","operationId":"resetUser_1","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/user/role":{"get":{"tags":["Administration - User and Group"],"description":"Check whether a user has admin role","operationId":"findUserRole_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"User has admin role":{"description":"User has admin role","value":"{isAdmin: true}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write,Device Monitoring-read,Device Monitoring-write,System-read,System-write"}},"/admin/user/userAuthType":{"get":{"tags":["Administration - User and Group"],"description":"Find user authentication type, whether it is SAML enabled","operationId":"findUserAuthType_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"User authentication type":{"description":"User authentication type","value":"{userAuthType: SAML}"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/admin/user/{userName}":{"put":{"tags":["Administration - User and Group"],"description":"Update user","operationId":"updateUser_1","parameters":[{"name":"userName","in":"path","description":"User name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{"userName":"demouser","password":"newpasswd"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete user","operationId":"deleteUser_1","parameters":[{"name":"userName","in":"path","description":"User name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/usergroup":{"get":{"tags":["Administration - User and Group"],"description":"Get all user groups","operationId":"findUserGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"User groups":{"description":"User groups","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"},"post":{"tags":["Administration - User and Group"],"description":"Create user group","operationId":"createUserGroup","requestBody":{"description":"User group","content":{"application/json":{"schema":{"type":"object"},"examples":{"User group":{"description":"User group","value":{"groupName":"demogrp","groupDesc":"user group description","tasks":[{"feature":"Interface","read":true,"enabled":true,"write":true},{"feature":"Routing","read":true,"enabled":true,"write":true},{"feature":"Security","read":true,"enabled":true,"write":true},{"feature":"System","read":true,"enabled":true,"write":true},{"feature":"Policy","read":true,"enabled":true,"write":true},{"feature":"Alarms","read":true,"enabled":true,"write":true},{"feature":"Audit Log","read":true,"enabled":true,"write":true},{"feature":"Device Monitoring","read":true,"enabled":true,"write":true},{"feature":"RBAC VPN","read":true,"enabled":true,"write":true},{"feature":"Certificates","read":true,"enabled":true,"write":true},{"feature":"Device Inventory","read":true,"enabled":true,"write":true},{"feature":"Template Configuration","read":true,"enabled":true,"write":true},{"feature":"Template Deploy","read":true,"enabled":true,"write":true},{"feature":"Policy Configuration","read":true,"enabled":true,"write":true},{"feature":"Security Policy Configuration","read":true,"enabled":true,"write":true},{"feature":"Policy Deploy","read":true,"enabled":true,"write":true},{"feature":"Cloud OnRamp","read":true,"enabled":true,"write":true},{"feature":"Software Upgrade","read":true,"enabled":true,"write":true},{"feature":"Device Reboot","read":true,"enabled":true,"write":true},{"feature":"Manage Users","read":true,"enabled":true,"write":true},{"feature":"Tools","read":true,"enabled":true,"write":true},{"feature":"Settings","read":true,"enabled":true,"write":true},{"feature":"Cluster","read":true,"enabled":true,"write":true},{"feature":"Colocation","read":true,"enabled":true,"write":true},{"feature":"vAnalytics","read":true,"enabled":true,"write":true},{"feature":"Events","read":true,"enabled":true,"write":true}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/usergroup/definition":{"get":{"tags":["Administration - User and Group"],"description":"Get user groups in a grid table","operationId":"createGroupGridColumns","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"User group in grid table":{"description":"User group in grid table","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"}},"/admin/usergroup/keyvalue":{"get":{"tags":["Administration - User and Group"],"description":"Get user groups as key value map","operationId":"findUserGroupsAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Map of user groups":{"description":"Map of user groups","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-read,Manage Users-write"}},"/admin/usergroup/{userGroupId}":{"put":{"tags":["Administration - User and Group"],"description":"Update user group","operationId":"updateUserGroup","parameters":[{"name":"userGroupId","in":"path","description":"User group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"User group","content":{"application/json":{"schema":{"type":"object"},"examples":{"User group":{"description":"User group","value":{"groupName":"demogrp","groupDesc":"user group description","tasks":[{"feature":"Policy","enabled":true,"read":true,"write":false},{"feature":"Routing","enabled":true,"read":true,"write":false},{"feature":"Security","enabled":true,"read":true,"write":false},{"feature":"Interface","enabled":true,"read":true,"write":false},{"feature":"System","enabled":true,"read":true,"write":false},{"feature":"Alarms","enabled":true,"read":true,"write":false},{"feature":"Audit Log","enabled":true,"read":true,"write":false},{"feature":"Certificates","enabled":true,"read":true,"write":false},{"feature":"Cloud OnRamp","enabled":true,"read":true,"write":false},{"feature":"Cluster","enabled":true,"read":true,"write":false},{"feature":"Colocation","enabled":true,"read":true,"write":false},{"feature":"Device Inventory","enabled":true,"read":true,"write":false},{"feature":"Device Monitoring","enabled":true,"read":true,"write":false},{"feature":"Device Reboot","enabled":true,"read":true,"write":false},{"feature":"Events","enabled":true,"read":true,"write":false},{"feature":"Manage Users","enabled":true,"read":true,"write":false},{"feature":"Policy Configuration","enabled":true,"read":true,"write":false},{"feature":"Policy Deploy","enabled":true,"read":true,"write":false},{"feature":"RBAC VPN","enabled":true,"read":true,"write":false},{"feature":"Security Policy Configuration","enabled":true,"read":true,"write":false},{"feature":"Settings","enabled":true,"read":true,"write":false},{"feature":"Software Upgrade","enabled":true,"read":true,"write":false},{"feature":"Template Configuration","enabled":true,"read":true,"write":false},{"feature":"Template Deploy","enabled":true,"read":true,"write":false},{"feature":"Tools","enabled":true,"read":true,"write":false},{"feature":"vAnalytics","enabled":true,"read":true,"write":false}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete user group","operationId":"deleteUserGroup","parameters":[{"name":"userGroupId","in":"path","description":"User group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Manage Users-write"}},"/admin/vpngroup":{"get":{"tags":["Administration - User and Group"],"description":"Get VPN groups","operationId":"getVpnGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN groups":{"description":"VPN groups","value":{"data":[{"name":"VPNGroup","vpnGroupId":"34bb9532-60bd-464b-bb35-393f7bac5e56","description":"Sample","owner":"admin","lastUpdated":1590190679126,"segments":["c952c18b-30b3-4f0b-b985-494693d7adfb"],"hasRbacGroup":true,"userGroupName":"demo"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-read,RBAC VPN-write"},"post":{"tags":["Administration - User and Group"],"description":"Add VPN group","operationId":"createVpnGroup","requestBody":{"description":"VPN group","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPN group":{"description":"VPN group","value":{"rbacRequired":true,"userGroupName":"demo","name":"VPNGroup","description":"Sample","segments":["c952c18b-30b3-4f0b-b985-494693d7adfb"]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-write"}},"/admin/vpngroup/{id}":{"put":{"tags":["Administration - User and Group"],"description":"Update VPN group","operationId":"editVpnGroup","parameters":[{"name":"id","in":"path","description":"VPN group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN group","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPN group":{"description":"VPN group","value":{"rbacRequired":true,"userGroupName":"demo","name":"VPNGroup","description":"Sample","vpnGroupId":"34bb9532-60bd-464b-bb35-393f7bac5e56","segments":["c952c18b-30b3-4f0b-b985-494693d7adfb","64b30b74-08e2-4b4b-81ca-d019c7e452d5"]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-write"},"delete":{"tags":["Administration - User and Group"],"description":"Delete VPN group","operationId":"deleteVpnGroup","parameters":[{"name":"id","in":"path","description":"VPN group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-write"}},"/alarms":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarms for given query. If query is empty then last 30 mins data will be returned.","operationId":"getRawAlarmData","parameters":[{"name":"query","in":"query","description":"Query","allowEmptyValue":true,"schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Alarms":{"description":"Alarms","$ref":"#/components/examples/alarm"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get alarms for given query.","operationId":"postRawAlarmData","parameters":[{"name":"page","in":"query","description":"Specify page number. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Specify page size. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Specify a field by which alarms need to be sorted","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Select sorting order. Use ASC for ascending and DESC for descending","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Alarm query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"200 Response":{"description":"200 Response","$ref":"#/components/examples/alarm"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/aggregation":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get aggregated count of alarms based on given query.","operationId":"getAggregationData","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmAggregationResponse"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get aggregated count of alarms based on given query.","operationId":"postAggregationData","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmAggregationResponse"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/clear":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Clear the alarm for a specific UUID.","operationId":"clearStaleAlarm","requestBody":{"description":"Clear Alarm","content":{"application/json":{"schema":{"type":"object"},"examples":{"Clear alarm by UUID":{"description":"Clear alarm by UUID","value":{"alarm_uuid":"25103468-8860-48c2-8ff9-763d1dd93b81"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Clear alarm by UUID":{"description":"Clear alarm by UUID","$ref":"#/components/examples/clear"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-write"}},"/alarms/count":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get the count of alarms which are active and not acknowledged by user.","operationId":"getCount_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Alarm count":{"description":"Alarm count","$ref":"#/components/examples/get_count"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get the count of alarms as per the query passed.","operationId":"postCount","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get active alarms count":{"description":"Get active alarms count","$ref":"#/components/examples/filter_by_active"},"Get alarms count filter by hours":{"description":"Get alarms count filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms count filter between dates":{"description":"Get alarms count filter between dates","$ref":"#/components/examples/filter_between_dates"},"Get alarms count filter by type":{"description":"Get alarms count filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms count filter by system ip":{"description":"Get alarms count filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms count filter by severity":{"description":"Get alarms count filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms count filter by site-id":{"description":"Get alarms count filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmCountPostResponse"},"examples":{"Alarm count response":{"description":"Alarm count response","$ref":"#/components/examples/post_count"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/disabled":{"get":{"tags":["Monitoring - Alarms Details"],"description":"List all disabled alarms","operationId":"listDisabledAlarm","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisabledAlarmDetails"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Enable/Disable alarms by event name","operationId":"disableEnableAlarm","parameters":[{"name":"eventName","in":"query","description":"Event name","required":true,"schema":{"type":"string"},"examples":{"BFD":{"description":"BFD","value":"bfd-state-change"},"System Login":{"description":"System Login","value":"system-login-change"},"Memory usage":{"description":"Memory usage","value":"memory-usage"},"Control connection":{"description":"Control connection","value":"control-connection-state-change"}}},{"name":"disable","in":"query","schema":{"type":"boolean"}},{"name":"time","in":"query","description":"Specify the duration for which the alarm is disabled. Duration between 0-72 hours","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/doccount":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get the count of alarms as per the query passed.","operationId":"getDocCount","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get active alarms count":{"description":"Get active alarms count","$ref":"#/components/examples/filter_by_active"},"Get alarms count filter by severity":{"description":"Get alarms count filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms count filter by system ip":{"description":"Get alarms count filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms count filter between dates":{"description":"Get alarms count filter between dates","$ref":"#/components/examples/filter_between_dates"},"Get alarms count filter by type":{"description":"Get alarms count filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms count filter by site-id":{"description":"Get alarms count filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get alarms count filter by hours":{"description":"Get alarms count filter by hours","$ref":"#/components/examples/filter_by_hours"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Count":{"description":"Count","$ref":"#/components/examples/doccount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get the count of alarms as per the query passed.","operationId":"postDocCount","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get active alarms count":{"description":"Get active alarms count","$ref":"#/components/examples/filter_by_active"},"Get alarms count filter by hours":{"description":"Get alarms count filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms count filter between dates":{"description":"Get alarms count filter between dates","$ref":"#/components/examples/filter_between_dates"},"Get alarms count filter by type":{"description":"Get alarms count filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms count filter by system ip":{"description":"Get alarms count filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms count filter by severity":{"description":"Get alarms count filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms count filter by site-id":{"description":"Get alarms count filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Count":{"description":"Count","$ref":"#/components/examples/doccount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/dump":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Dump correlation engine server cache in log file","operationId":"dumpCorrelationEngineData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/fields":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get fields and types","operationId":"getAlarmDataFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/fields"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/link-state-alarm":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get configuration for link-state alarm","operationId":"getLinkStateAlarmConfig","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Response":{"description":"Response","value":{"bgp-peer-state-change":"enabled"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Enable/Disable a specific link-state alarm","operationId":"enableDisableLinkStateAlarm","parameters":[{"name":"linkName","in":"query","description":"Link Name","required":true,"schema":{"type":"string"},"examples":{"BGP":{"description":"BGP","value":"bgp-peer-state-change"},"OSPF":{"description":"OSPF","value":"ospf-neighbor-state-change"}}},{"name":"enable","in":"query","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/markallasviewed":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Mark all alarms as acknowledged by the user","operationId":"markAllAlarmsAsViewed","parameters":[{"name":"type","in":"query","description":"Specify type. Allowed values: [\"active\", \"cleared\"]","schema":{"type":"string"},"examples":{"Active":{"description":"Active","value":"active"},"Cleared":{"description":"Cleared","value":"cleared"}}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Empty":{"description":"Empty"},"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Response":{"description":"Response","$ref":"#/components/examples/markallasviewed"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/markviewed":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Mark alarms as acknowledged based on list of UUIDs.","operationId":"markAlarmsAsViewed","requestBody":{"description":"Mark alarms as viewed","content":{"application/json":{"schema":{"type":"object"},"examples":{"List of UUIDs":{"description":"List of UUIDs","value":{"uuid":["29f9bf31-0fbe-4114-b8f0-e6234699485c"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmCountResponse"},"examples":{"Mark viewed":{"description":"Mark viewed","$ref":"#/components/examples/markviewed"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/master":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get topic details.","operationId":"getMasterManagerState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Topics":{"description":"Topics","$ref":"#/components/examples/master"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/notviewed":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarms which are not acknowledged by the user.","operationId":"getNonViewedAlarms","parameters":[{"name":"state","in":"query","description":"Specify the not viewed alarm state to be fetched. Allowed values : [\"active\", \"cleared\"] ","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Not viewed alarms":{"description":"Not viewed alarms","$ref":"#/components/examples/notviewed"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/page":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get paginated alarms","operationId":"getPage","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"}}},{"name":"scrollId","in":"query","description":"Scroll ID","schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of alarms per page","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/page"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"post":{"tags":["Monitoring - Alarms Details"],"description":"Get paginated alarm raw data","operationId":"postPage","parameters":[{"name":"scrollId","in":"query","description":"Scroll ID","schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of alarms per page","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Alarm query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/page"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/purgefrequency":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Set alarm purge timer","operationId":"setPeriodicPurgeTimer","parameters":[{"name":"interval","in":"query","description":"Purge interval","schema":{"type":"string"}},{"name":"activeTime","in":"query","description":"Active time","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurgeFrequency"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/query/fields":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get query fields","operationId":"getAlarmQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query fields":{"description":"Query fields","$ref":"#/components/examples/query_fields"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/query/input":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm field details","operationId":"getFieldDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmQueryInputResponse"},"examples":{"Field details":{"description":"Field details","$ref":"#/components/examples/query_input"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/reset":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Reset correlation engine.","operationId":"reset","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/reset"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/alarms/restart":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Restart correlation engine.","operationId":"restartCorrelationEngine","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/restart"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/alarms/rulenamedisplay/keyvalue":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm types.","operationId":"getAlarmTypesAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleKeyValueMapping"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/rulenamedisplay_keyvalue"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/severity":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarms by severity","operationId":"getBySeverity","parameters":[{"name":"severity-level","in":"query","description":"Severity level","required":true,"schema":{"type":"array","items":{"type":"string"}},"examples":{"critical":{"description":"critical","value":"critical"},"major":{"description":"major","value":"major"},"minor":{"description":"minor","value":"minor"},"medium":{"description":"medium","value":"medium"}}},{"name":"deviceId","in":"query","description":"Device System IP","schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"Query","allowEmptyValue":true,"schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/page"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/severity/summary":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm severity histogram","operationId":"getAlarmSeverityCustomHistogram","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get alarms filter by severity":{"description":"Get alarms filter by severity","$ref":"#/components/examples/filter_by_severity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get active alarms":{"description":"Get active alarms","$ref":"#/components/examples/filter_by_active"},"Get alarms filter by type":{"description":"Get alarms filter by type","$ref":"#/components/examples/filter_by_type"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","$ref":"#/components/examples/filter_between_dates"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeveritySummary"},"examples":{"Severity":{"description":"Severity","$ref":"#/components/examples/severity"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/severitymappings":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Gets alarm severity mappings","operationId":"getAlarmSeverityMappings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmSeverityMappingResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/severitymappings"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/starttracking/{testName}":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Start tracking events","operationId":"startTracking","parameters":[{"name":"testName","in":"path","description":"Test Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/starttracking"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/stats":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm statistics","operationId":"getStats","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmStatsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/stoptracking/{testName}":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Stop tracking events","operationId":"stopTracking","parameters":[{"name":"testName","in":"path","description":"Test Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleMessageResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/starttracking"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/topic":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get topic on which alarms for given device are publishing.","operationId":"getDeviceTopic","parameters":[{"name":"ip","in":"query","description":"Device system IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmTopic"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/alarms/topn":{"post":{"tags":["Monitoring - Alarms Details"],"description":"Returns top-n alarm count based on given query","operationId":"getTopN","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Input query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topn by system IP":{"description":"Topn by system IP","$ref":"#/components/examples/topn_by_systemip"},"Topn by host name":{"description":"Topn by host name","$ref":"#/components/examples/topn_by_hostname"},"Topn by type":{"description":"Topn by type","$ref":"#/components/examples/topn_by_type"},"Topn by severity":{"description":"Topn by severity","$ref":"#/components/examples/topn_by_severity"},"Topn by rule name display":{"description":"Topn by rule name display","$ref":"#/components/examples/topn_by_rulenamedisplay"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topn by system IP":{"description":"Topn by system IP","$ref":"#/components/examples/topn_by_systemip-2"},"Topn by host name":{"description":"Topn by host name","$ref":"#/components/examples/topn_by_hostname-2"},"Topn by type":{"description":"Topn by type","$ref":"#/components/examples/topn_by_type-2"},"Topn by severity":{"description":"Topn by severity","$ref":"#/components/examples/topn_by_severity-2"},"Topn by rule name display":{"description":"Topn by rule name display","$ref":"#/components/examples/topn_by_rulenamedisplay-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/alarms/uuid/{alarm_uuid}":{"get":{"tags":["Monitoring - Alarms Details"],"description":"Get alarm details for given UUID","operationId":"getAlarmDetails","parameters":[{"name":"alarm_uuid","in":"path","description":"Alarm UUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/uuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/app-registry/app":{"get":{"tags":["Configuration - App Registry"],"description":"Get All the App for the given conditions","operationId":"getAllAppList","parameters":[{"name":"filterAttributeType","in":"query","schema":{"type":"string"}},{"name":"filterAttributeValue","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/app/category":{"get":{"tags":["Configuration - App Registry"],"description":"Get the stats of all type of apps","operationId":"getAppListCategory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/app/discoveredapps":{"get":{"tags":["Configuration - App Registry"],"description":"Get All network discovered apps","operationId":"getNetworkDiscoveredApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/app/filtermap":{"get":{"tags":["Configuration - App Registry"],"description":"Get all available filters for applist","operationId":"getAttributeMappingForApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"data":[{"applicationSource":["hardcoded"],"applicationFamily":["instant-messaging","game"],"businessRelevance":["business-irrelevant","business-relevant","default"],"trafficClass":["multimedia-conferencing","network-control"],"applicationList":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/app/kubernetesapps":{"get":{"tags":["Kubernetes Services"],"description":"Obtain all services associated with clusters","operationId":"getKubernetesServices","parameters":[{"name":"isCached","in":"query","schema":{"type":"boolean","default":false}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveredServices"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/applications":{"get":{"tags":["Configuration - Policy App Registry"],"description":"Get All the App for the given conditions","operationId":"getAppList","parameters":[{"name":"trafficClass","in":"query","description":"Traffic Class","schema":{"type":"string"},"example":"bulk-data"},{"name":"businessRelevance","in":"query","description":"Business Relevance","schema":{"type":"string"},"example":"business-relevant"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetAppRegistryAppResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Policy App Registry"],"description":"Edit App Details","operationId":"editAppDetails","requestBody":{"content":{"*/*":{"schema":{"type":"array","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"items":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/applications/{appId}":{"put":{"tags":["Configuration - Policy App Registry"],"description":"Edit App Details","operationId":"editAppDetailsWithUUID","parameters":[{"name":"appId","in":"path","description":"appId","required":true,"schema":{"type":"string"},"example":"3fda54ed-3b92-49e5-b1e5-adec30bfd17f"}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/GetAppRegistryAppIdReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadItems"},"examples":{"Status":{"description":"Status","$ref":"#/components/examples/GetAppRegistryAppIdResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/clusters":{"get":{"tags":["Kubernetes Services"],"description":"Obtain all clusters with associated cloud accounts","operationId":"getKubernetesCluster","parameters":[{"name":"isCached","in":"query","schema":{"type":"boolean","default":true}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClusterProperties"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Kubernetes Services"],"description":"Manually upload kubeConfig","operationId":"postCluster","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/clusters/{id}":{"put":{"tags":["Kubernetes Services"],"description":"Edit the discovery status of a cluster","operationId":"editKubernetesCluster","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"enable or disable Cluster Discovery Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutProperties"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Kubernetes Services"],"description":"Delete manually uploaded cluster","operationId":"deleteKubernetesCluster","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/saasfeed":{"get":{"tags":["Configuration - App Registry"],"description":"Get All Saas feed details","operationId":"getActiveSaasFeeds","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"data":[{"appName":"AAAA","status":"enable","feedCount":123,"feedId":"someId"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/app-registry/saasfeed/app/configure":{"put":{"tags":["Configuration - App Registry"],"description":"Get All the App for the given conditions","operationId":"disableorEnableSaasFeedForSelectedApp","requestBody":{"description":"Onboard","content":{"application/json":{"schema":{"type":"object"},"examples":{"onboarding-payload":{"description":"onboarding-payload","value":[{"feedId":"someId","enable":true}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy"}},"/app-registry/saasfeed/app/{feedId}":{"get":{"tags":["Configuration - App Registry"],"description":"Get All Saas feed details of a particular application","operationId":"getAllSaasFeedForSelectedApp","parameters":[{"name":"feedId","in":"path","description":"Feed ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponseNoUUID"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log","description":"Get stat raw data","operationId":"getStatDataRawAuditLogData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log with post action","description":"Get raw property data with post action","operationId":"getRawPropertyData","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data aggregation query string":{"description":"Data aggregation query string","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["3"]}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/aggregation":{"get":{"tags":["Administration - Audit Log"],"summary":"Get raw property data aggregated","description":"Get raw property data aggregated","operationId":"getPropertyAggregationData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogAggregation"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get raw property data aggregated with post action","description":"Get raw property data aggregated with post action","operationId":"getPostPropertyAggregationData","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data aggregation query string":{"description":"Data aggregation query string","value":{"aggregation":{"histogram":{"interval":30,"order":"asc","property":"entry_time","type":"minute"}},"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["3"]}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogAggregation"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/doccount":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log Doc count","description":"Get response count of a query","operationId":"getCount","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogDoccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log Doc count","description":"Get response count of a query","operationId":"getCountPost","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data aggregation query string":{"description":"Data aggregation query string","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["3"]}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogDoccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/fields":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log fields","description":"Get fields and type","operationId":"getStatDataFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatDataFieldArray"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/page":{"get":{"tags":["Administration - Audit Log"],"summary":"Get raw property data in bulk","description":"Get raw property data in bulk","operationId":"getStatBulkRawPropertyData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Administration - Audit Log"],"summary":"Get raw property data in bulk with post action","description":"Get raw property data in bulk with post action","operationId":"getPostStatBulkRawPropertyData","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data aggregation query string":{"description":"Data aggregation query string","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["3"]}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/query/fields":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log query fields","description":"Get query fields","operationId":"getStatQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatQueryFieldArray"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/severity":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log","description":"Get audit logs for last 3 hours","operationId":"generateAuditLog","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditLogBySeverity"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/auditlog/severity/summary":{"get":{"tags":["Administration - Audit Log"],"summary":"Get vManage Audit Log Histogram","description":"Get audit log severity histogram","operationId":"getAuditSeverityCustomHistogram","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/backupinfo":{"delete":{"tags":["Scheduled Backup Restore"],"summary":"Deletes a local database operation","description":"Delete all or a specific backup file stored in vManage","operationId":"deleteSchduledBackup","parameters":[{"name":"taskId","in":"query","schema":{"type":"string"}},{"name":"backupInfoId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/backupinfo/{localBackupInfoId}":{"get":{"tags":["Scheduled Backup Restore"],"summary":"Get details of database backup task for given localBackupInfo object","description":"Get a localBackupInfo record by localBackupInfoId","operationId":"getLocalBackupInfo","parameters":[{"name":"localBackupInfoId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalBackupInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}}},"/backup/download/{path}":{"get":{"tags":["Scheduled Backup Restore"],"summary":"Download the database backup file for the given backup file path","description":"Download a Backup File that is already stored in vManage","operationId":"downloadBackupFile","parameters":[{"name":"path","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/export":{"post":{"tags":["Scheduled Backup Restore"],"summary":"Issues database backup request","description":"Trigger a backup of configuration database and statstics database and store it in vManage","operationId":"exportBackup","requestBody":{"description":"backup request information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalBackupInfo"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/backup/list":{"get":{"tags":["Scheduled Backup Restore"],"summary":"Get list of all database backup requests","description":"List all backup files of a tenant stored in vManage","operationId":"listBackup","parameters":[{"name":"size","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalBackupListResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/cdna/sense/{tag}":{"get":{"tags":["System - Cloud Service CDNA"],"description":"Get Sense Service","operationId":"getCdnaSenseService","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnaSenseResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/cdna/server":{"get":{"tags":["System - Cloud Service CDNA"],"description":"Get CDNA Server Details","operationId":"getCdnaServer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollOTPResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["System - Cloud Service CDNA"],"description":"Enroll CDNA Server with OTP","operationId":"enrollCdnaServer","requestBody":{"description":"CDNA OTP Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollOTPSettings"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrollOTPResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["System - Cloud Service CDNA"],"description":"Delete CDNA Server Details","operationId":"deleteCdnaServer","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/certdetails":{"post":{"tags":["Certificate Management - Device"],"summary":"get certificaate details","description":"get certificaate details","operationId":"getCertDetails","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/controller/bulkcsr":{"post":{"tags":["Certificate Management - Device"],"summary":"Generate CSR for all controller","description":"Generate CSR for all controller","operationId":"generateCSRforAllController","parameters":[{"name":"csrKeyLength","in":"query","description":"Optional Parameter: CSR Key Length","schema":{"type":"string"},"examples":{"csrKeyLength":{"description":"csrKeyLength","value":4096}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/controller/certstatus":{"get":{"tags":["Certificate Management - Device"],"summary":"invalidate the device","description":"invalidate the device","operationId":"getControllerCertStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Cert Status":{"description":"Cert Status","$ref":"#/components/examples/GetControllerCertStatusResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/csr/details":{"get":{"tags":["Certificate Management - Device"],"summary":"Get CSR detail view","description":"Get CSR detail view","operationId":"getCSRViewRightMenus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"CSR Details":{"description":"CSR Details","$ref":"#/components/examples/GetCSRDetailsResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/device/details":{"get":{"tags":["Certificate Management - Device"],"summary":"Get device detail view","description":"Get device detail view","operationId":"getDeviceViewRightMenus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Device Details":{"description":"Device Details","$ref":"#/components/examples/GetDeviceDetailsResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/device/invalidate":{"post":{"tags":["Certificate Management - Device"],"summary":"invalidate the device","description":"invalidate the device","operationId":"invalidateDevice","requestBody":{"description":"Device UUID","content":{"application/json":{"schema":{"type":"object"},"examples":{"Payload":{"description":"Payload","$ref":"#/components/examples/PostDeviceInvalidateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Task ID":{"description":"Task ID","$ref":"#/components/examples/PostDeviceInvalidateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/device/list":{"get":{"tags":["Certificate Management - Device"],"summary":"get device list","description":"get device list","operationId":"getDevicesList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Device List":{"description":"Device List","$ref":"#/components/examples/GetDeviceListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/device/stage":{"post":{"tags":["Certificate Management - Device"],"summary":"Stop data traffic to device","description":"Stop data traffic to device","operationId":"stageDevice","requestBody":{"description":"Payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Payload":{"description":"Payload","$ref":"#/components/examples/PostDeviceStageRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Task ID":{"description":"Task ID","$ref":"#/components/examples/PostDeviceStageResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/forcesync/rootCert":{"post":{"tags":["Certificate Management - Device"],"summary":"force Sync RootCert to all devices","description":"force Sync RootCert to all devices","operationId":"forceSyncRootCert","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Task ID":{"description":"Task ID","$ref":"#/components/examples/PostForceSyncRootCertResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/generate/csr":{"post":{"tags":["Certificate Management - Device"],"summary":"generate CSR on target device","description":"get certificaate details","operationId":"generateCSR","requestBody":{"description":"Device IP","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device IP":{"description":"Device IP","$ref":"#/components/examples/PostGenerateCSRRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Device List":{"description":"Device List","$ref":"#/components/examples/PostGenerateCSRResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/generate/enterprise/csr/vedge":{"post":{"tags":["Certificate Management - Device"],"summary":"generate CSR on hardware WAN edge device","description":"generate CSR on hardware WAN edge device","operationId":"generateEnterpriseCSR","requestBody":{"description":"Device UUID","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device UUID":{"description":"Device UUID","$ref":"#/components/examples/PostGenerateEnterpriseCSRRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Task ID":{"description":"Task ID","$ref":"#/components/examples/PostGenerateEnterpriseCSRResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/generate/wanedge/csr":{"post":{"tags":["Certificate Management - Device"],"summary":"generate CSR on WAN edge device","description":"generate CSR on WAN edge device","operationId":"generateEdgeDeviceCSR","requestBody":{"description":"Device UUID","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device UUID":{"description":"Device UUID","$ref":"#/components/examples/PostGenerateWanEdgeCSRRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Task ID":{"description":"Task ID","$ref":"#/components/examples/PostGenerateWanEdgeCSRResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/install/signedCert":{"post":{"tags":["Certificate Management - Device"],"summary":"install Certificate","description":"install Certificate","operationId":"installCertificate","requestBody":{"description":"Certificate","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate":{"description":"Certificate","$ref":"#/components/examples/PostInstallSignedCertRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Task ID":{"description":"Task ID","$ref":"#/components/examples/PostInstallSignedCertResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/jks":{"put":{"tags":["Certificate Management - Device"],"summary":"update JKS","description":"update JKS","operationId":"updateJks","requestBody":{"description":"JSON payload with encoded JKS.","content":{"application/json":{"schema":{"type":"string"},"examples":{"Put JKS Request":{"description":"Put JKS Request","$ref":"#/components/examples/PutJKSRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Put JKS Response":{"description":"Put JKS Response","$ref":"#/components/examples/PutJKSResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/list/status":{"get":{"tags":["Certificate Management - Device"],"summary":"get certificate data","description":"get certificate data","operationId":"getListStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/mthub/list":{"get":{"tags":["Certificate Management - Device"],"summary":"vSmart Mthub list","description":"vSmart Mthub list","operationId":"setvSmartMtHubList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"},"examples":{"GET MTHub List Response":{"description":"GET MTHub List Response","$ref":"#/components/examples/GetMTHubListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/record":{"get":{"tags":["Certificate Management - Device"],"summary":"get device certificate data","description":"get device certificate data","operationId":"getCertificateData","parameters":[{"name":"requestID","in":"query","description":"Request ID parameter","schema":{"type":"string"},"examples":{"requestID":{"description":"requestID","value":"d65f2b6c-c00a-4432-a87d-d2b6269b01b3"}}},{"name":"dataObject","in":"query","description":"Device property as DataObject parameter","schema":{"type":"string"},"examples":{"CSR":{"description":"CSR","value":"csr"},"UUID":{"description":"UUID","value":"uuid"},"Reachability":{"description":"Reachability","value":"reachability"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"},"examples":{"Get Record Response":{"description":"Get Record Response","$ref":"#/components/examples/GetRecordResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/reset/rsa":{"post":{"tags":["Certificate Management - Device"],"summary":"resetRSA for controllers","description":"resetRSA for controllers","operationId":"resetRSA","requestBody":{"description":"JSON payload with deviceIP details for rsa reset","content":{"application/json":{"schema":{"type":"string"},"examples":{"Reset RSA Request":{"description":"Reset RSA Request","$ref":"#/components/examples/PostResetRSARequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Post Reset RSA Response":{"description":"Post Reset RSA Response","$ref":"#/components/examples/PostResetRSAResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/revoke/enterprise/certificate":{"post":{"tags":["Certificate Management - Device"],"summary":"Revoking enterprise CSR for hardware vEdge","description":"Revoking enterprise CSR for hardware vEdge","operationId":"decommissionEnterpriseCSRForVedge","requestBody":{"description":"JSON parameter with Device UUID","content":{"application/json":{"schema":{"type":"string"},"examples":{"Revoke Enterprise Certificate Request":{"description":"Revoke Enterprise Certificate Request","$ref":"#/components/examples/PostRevokeEnterpriseCertificateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Revoke Enterprise Certificate Response":{"description":"Revoke Enterprise Certificate Response","$ref":"#/components/examples/PostRevokeEnterpriseCertificateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/rootcertchains":{"get":{"tags":["Certificate Management - Device"],"summary":"get root cert chain","description":"get root cert chain in the system","operationId":"getRootCertChains","parameters":[{"name":"action","in":"query","description":"Action Parameter to fetch root cert chains","required":true,"schema":{"type":"string"},"examples":{"Get":{"description":"Get","value":"get"},"Verify":{"description":"Verify","value":"verify"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"},"examples":{"Verify Action: Root Cert Chains Response":{"description":"Verify Action: Root Cert Chains Response","$ref":"#/components/examples/GetRootCertChainsVerifyActionResponse"},"Get Action: Root Cert Chains Response":{"description":"Get Action: Root Cert Chains Response","$ref":"#/components/examples/GetRootCertChainsGetActionResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Certificate Management - Device"],"summary":"update root cert chain","description":"save root cert chain in the system","operationId":"saveRootCertChain","requestBody":{"description":"JSON payload with RootCertChain and Certificate details.","content":{"application/json":{"schema":{"type":"string"},"examples":{"Root Cert Chain":{"description":"Root Cert Chain","$ref":"#/components/examples/PutRootCertChainsRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Root Cert Chains Save Response":{"description":"Root Cert Chains Save Response","$ref":"#/components/examples/PutRootCertChainsResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/rootcertificate":{"get":{"tags":["Certificate Management - Device"],"summary":"Get device root certificate detail view","description":"Get device root certificate detail view","operationId":"getRootCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateChain"},"examples":{"Root Certificate Response":{"description":"Root Certificate Response","$ref":"#/components/examples/GetRootCertificateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/rsakeylengthdefault":{"get":{"tags":["Certificate Management - Device"],"summary":"Check if all devices in network use 2048-b RSA Key length for their device certs.","description":"Check if all devices in network use 2048-b RSA Key length for their device certs.","operationId":"rsaKeyLength2048ForAllDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"RSA Key Length Default":{"description":"RSA Key Length Default","$ref":"#/components/examples/GetRSAKeyLengthDefaultResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/save/vedge/list":{"post":{"tags":["Certificate Management - Device"],"summary":"change VedgeList Validity","description":"change VedgeList Validity","operationId":"saveVEdgeList","requestBody":{"description":"JSON payload with RootCertChain and Certificate details.","content":{"application/json":{"schema":{"type":"string"},"examples":{"vEdge List":{"description":"vEdge List","$ref":"#/components/examples/PostSaveVedgeListRequest"},"vEdge List with optional Serial Number parameter":{"description":"vEdge List with optional Serial Number parameter","$ref":"#/components/examples/PostSaveVedgeListOptionalParameterRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Save vEdge List Response":{"description":"Save vEdge List Response","$ref":"#/components/examples/PostSaveVedgeListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/stats/detail":{"get":{"tags":["Certificate Management - Device"],"summary":"Get certificate details","description":"Get certificate details","operationId":"getCertificateDetail","parameters":[{"name":"status","in":"query","description":"Certificate Status","schema":{"type":"string"},"examples":{"All":{"description":"All","value":"all"},"Warning":{"description":"Warning","value":"warning"},"Null":{"description":"Null","value":null},"Revoked":{"description":"Revoked","value":"revoked"},"Normal":{"description":"Normal","value":"normal"},"Invalid":{"description":"Invalid","value":"invalid"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateData"},"examples":{"Stats Detail Response":{"description":"Stats Detail Response","$ref":"#/components/examples/GetStatsDetailResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/stats/summary":{"get":{"tags":["Certificate Management - Device"],"summary":"Get certificate expiration status","description":"Get certificate expiration status","operationId":"getCertificateStats","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"},"examples":{"Stats Summary Response":{"description":"Stats Summary Response","$ref":"#/components/examples/GetStatsSummaryResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/syncvbond":{"get":{"tags":["Certificate Management - Device"],"summary":"sync vManage UUID to all vBond","description":"sync vManage UUID to all vBond","operationId":"syncvBond","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Sync vBond Response":{"description":"Sync vBond Response","$ref":"#/components/examples/GetSyncVbondResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/tokengeneratedlist":{"get":{"tags":["Certificate Management - Device"],"summary":"get token generated list","description":"get token generated list","operationId":"getTokenList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Token Generated List Response":{"description":"Token Generated List Response","$ref":"#/components/examples/GetTokenGeneratedList"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vedge":{"get":{"tags":["Certificate Management - Device"],"summary":"get device installed cert","description":"get device installed cert","operationId":"getInstalledCert","parameters":[{"name":"uuid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstalledCerts"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vedge/csr":{"get":{"tags":["Certificate Management - Device"],"summary":"get device CSR","description":"get device CSR","operationId":"getvEdgeCSR","parameters":[{"name":"uuid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vedge/list":{"get":{"tags":["Certificate Management - Device"],"summary":"get vEdge list","description":"get vEdge list","operationId":"getvEdgeList","parameters":[{"name":"state","in":"query","description":"Certificate State","schema":{"type":"string"},"examples":{"C8300-1N1S-4T2X":{"description":"C8300-1N1S-4T2X","value":"C8300-1N1S-4T2X"},"ASR1002-HX":{"description":"ASR1002-HX","value":"ASR1002-HX"},"C8000v":{"description":"C8000v","value":"C8000v"}}},{"name":"state","in":"query","description":"Certificate State","schema":{"type":"string"},"examples":{"CSR Failed":{"description":"CSR Failed","value":"csrfailed"},"Certificate Installed":{"description":"Certificate Installed","value":"certinstalled"},"Token Generated":{"description":"Token Generated","value":"tokengenerated"},"Certificate Installation Failed":{"description":"Certificate Installation Failed","value":"certinstallfailed"},"Bootstrap Config Generated":{"description":"Bootstrap Config Generated","value":"bootstrapconfiggenerated"},"CSR Generated":{"description":"CSR Generated","value":"csrgenerated"},"Certificate serial number pushed to controllers":{"description":"Certificate serial number pushed to controllers","value":"certserialpushedtocontrollers"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Vedge List Response":{"description":"Vedge List Response","$ref":"#/components/examples/GetVedgeListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Certificate Management - Device"],"summary":"Save vEdge list (send to controller)","description":"Save vEdge list (send to controller)","operationId":"setvEdgeList","parameters":[{"name":"action","in":"query","description":"Action Type","schema":{"type":"string"},"examples":{"Get":{"description":"Get","value":"get"},"Save":{"description":"Save","value":"save"},"Verify":{"description":"Verify","value":"verify"},"Push":{"description":"Push","value":"push"}}}],"requestBody":{"description":"Required only for save action","content":{"application/json":{"schema":{"type":"string"},"examples":{"Vedge List":{"description":"Vedge List","$ref":"#/components/examples/PostVedgeListSaveRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Vedge List Push Response":{"description":"Vedge List Push Response","$ref":"#/components/examples/PostVedgeListPushResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/view":{"get":{"tags":["Certificate Management - Device"],"summary":"Get certificate UI view","description":"Get certificate UI view","operationId":"getView","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate UI View Response":{"description":"Certificate UI View Response","$ref":"#/components/examples/GetCertificateViewResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vmanage/selfsignedcert":{"get":{"tags":["Certificate Management - Device"],"summary":"get vManage self signed cert","description":"get vManage self signed cert","operationId":"getSelfSignedCert","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Vmanage Self Signed Cert Response":{"description":"Vmanage Self Signed Cert Response","$ref":"#/components/examples/GetVmanageSelfSignedCertResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/certificate/vsmart/list":{"get":{"tags":["Certificate Management - Device"],"summary":"get vSmart list","description":"get vSmart list","operationId":"getvSmartList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Vsmart List Response":{"description":"Vsmart List Response","$ref":"#/components/examples/GetCertificateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Certificate Management - Device"],"summary":"save vSmart List(handleSendToVbond)","description":"save vSmart List(handleSendToVbond)","operationId":"setvSmartList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate Response":{"description":"Certificate Response","$ref":"#/components/examples/PostVsmartListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/certificate/{uuid}":{"delete":{"tags":["Certificate Management - Device"],"summary":"invalid device","description":"invalid device","operationId":"deleteConfiguration","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}},{"name":"replaceController","in":"query","schema":{"type":"boolean"}},{"name":"deviceId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/client/server":{"get":{"tags":["Client - UI"],"summary":"Get vManage server information","description":"Get vManage server information","operationId":"createServerInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerInfoResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/client/token":{"get":{"tags":["Client - Security"],"summary":"Get CSRF token","description":"Get CSRF token","operationId":"getCsrfToken","parameters":[{"name":"json","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTokenResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/cloudservices/accesstoken":{"get":{"tags":["System - Cloud Service"],"operationId":"getAccessTokenforDevice","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cloudservices/app/webex":{"put":{"tags":["Configuration - CloudExpress"],"description":"Day N- Update Webex App","operationId":"enableWebex_1","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"},"post":{"tags":["Configuration - CloudExpress"],"description":"Add Webex App","operationId":"enableWebex","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"},"delete":{"tags":["Configuration - CloudExpress"],"description":"deleteWebexPrefixLists","operationId":"deleteWebexPrefixLists","requestBody":{"description":"TMP-Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"}},"/cloudservices/authtoken":{"post":{"tags":["System - Cloud Service"],"description":"Get Azure token","operationId":"getAzureToken","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry state":{"description":"Telemetry state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/connect":{"get":{"tags":["System - Cloud Service"],"description":"Telemetry Opt In","operationId":"connect","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry Opt In":{"description":"Telemetry Opt In","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/credentials":{"get":{"tags":["System - Cloud Service"],"description":"Get cloud service credentials","operationId":"getCloudCredentials","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service credentials":{"description":"Cloud service credentials","value":{"clientId":"exampleClientId"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"},"post":{"tags":["System - Cloud Service"],"description":"Add cloud service credentials","operationId":"addCloudCredentials","requestBody":{"description":"Cloud service credentials","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud service credentials":{"description":"Cloud service credentials","value":{"clientId":"exampleClientId","clientsecret":"exampleClientSecret","cloudTenantId":"exampleCloudTenantId"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca,CXP-write,Cloud OnRamp-write"}},"/cloudservices/devicecode":{"post":{"tags":["System - Cloud Service"],"description":"Get Azure device code","operationId":"getDeviceCode","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry state":{"description":"Telemetry state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/m365/preferredpath":{"post":{"tags":["System - Cloud Service"],"description":"Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getO365PreferredPathFromVAnalytics","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/cloudservices/staging":{"get":{"tags":["System - Cloud Service"],"description":"Check if testbed or production","operationId":"isStaging","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Environment":{"description":"Environment","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/telemetry":{"get":{"tags":["System - Cloud Service"],"description":"Get Telemetry state","operationId":"getTelemetryState","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry state":{"description":"Telemetry state","$ref":"#/components/examples/o365_telemetry"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Settings-read,Settings-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/telemetry/optin":{"put":{"tags":["System - Cloud Service"],"description":"Telemetry Opt In","operationId":"optIn","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry Opt In":{"description":"Telemetry Opt In","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/telemetry/optout":{"delete":{"tags":["System - Cloud Service"],"description":"Telemetry Opt Out","operationId":"optOut","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Telemetry Opt Out":{"description":"Telemetry Opt Out","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/cloudservices/vanalytics/dashboardlist":{"get":{"tags":["System - Cloud Service"],"description":"Get vAnalytics Dashboard List","operationId":"getvAnalyticsDashboardList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA access token":{"description":"DCA access token","$ref":"#/components/examples/va_dashboard_list"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"vAnalytics-readvAnalytics-write"}},"/clusterManagement/clusterLocked":{"get":{"tags":["Cluster Management"],"description":"Check whether cluster is locked
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"checkIfClusterLocked","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster lock":{"description":"Cluster lock","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/clusterworkflow/version":{"get":{"tags":["Cluster Management"],"description":"List vManages in the cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getClusterWorkflowVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"clusterV2Enabled":{"description":"clusterV2Enabled","value":"True"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/configure":{"post":{"tags":["Cluster Management"],"description":"Configure vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"configureVmanage","requestBody":{"description":"vManage server config","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage server config":{"description":"vManage server config","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/connectedDevices/{vmanageIP}":{"get":{"tags":["Cluster Management"],"description":"Get connected device for vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getConnectedDevices","parameters":[{"name":"vmanageIP","in":"path","description":"vManage IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/health/details":{"get":{"tags":["Cluster Management"],"description":"Get cluster health check details
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"healthDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster health check detail":{"description":"Cluster health check detail","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/health/status":{"get":{"tags":["Cluster Management"],"description":"Get cluster health check details
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"healthStatusInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster health status info":{"description":"Cluster health status info","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/health/summary":{"get":{"tags":["Cluster Management"],"description":"Get cluster health check summary
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"healthSummary","parameters":[{"name":"isCached","in":"query","description":"Flag to enable cached result","schema":{"type":"boolean","default":false}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster health check summary":{"description":"Cluster health check summary","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/host/health/status":{"get":{"tags":["Cluster Management"],"description":"Get vManage cluster health check details
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"hostHealthStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster health status info":{"description":"vManage cluster health status info","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/iplist/{vmanageID}":{"get":{"tags":["Cluster Management"],"description":"Get configured IP addresses
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getConfiguredIPList","parameters":[{"name":"vmanageID","in":"path","description":"vManage Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vManage IP list":{"description":"vManage IP list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/isready":{"get":{"tags":["Cluster Management"],"description":"Is cluster ready
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"isClusterReady","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cluster state":{"description":"Cluster state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/list":{"get":{"tags":["Cluster Management"],"description":"List vManages in the cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"listVmanages","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vManage server":{"description":"vManage server","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/nodeProperties":{"get":{"tags":["Cluster Management"],"description":"Get properties of vManage being added to cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"nodeProperties","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster properties":{"description":"vManage cluster properties","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/remove":{"post":{"tags":["Cluster Management"],"description":"Remove vManage from cluster
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"removeVmanage","requestBody":{"description":"vManage server info","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage server info":{"description":"vManage server info","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/replicateAndRebalance":{"put":{"tags":["Cluster Management"],"description":"Initiate replication and rebalance of kafka topics
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"performReplicationAndRebalanceOfKafkaPartitions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Kafka topics rebalance status":{"description":"Kafka topics rebalance status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/setup":{"put":{"tags":["Cluster Management"],"description":"Update vManage cluster info
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editVmanage","requestBody":{"description":"vManage cluster config","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster config":{"description":"vManage cluster config","value":"{\n \"vmanageID\":\"0\",\n \"deviceIP\u201d:\u201d10.0.1.38\u201d,\n \"username\":\"admin\",\n \"password\u201d:\u201dpassword\u201d,\n \"persona\":\"COMPUTE_AND_DATA\",\n \"services\":{\n \"container-manager\":{\n \"server\":false\n }\n }\n}"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Cluster Management"],"description":"Add vManage to cluster","operationId":"addVmanage","requestBody":{"description":"vManage cluster config","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage cluster config":{"description":"vManage cluster config","value":{"deviceIP":"10.0.1.200","username":"admin","password":"password","genCSR":false,"persona":"COMPUTE_AND_DATA","services":{"container-manager":{"server":false}}}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/tenancy/mode":{"get":{"tags":["Cluster Management"],"description":"Get vManage tenancy mode
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenancyMode","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage tenancy mode":{"description":"vManage tenancy mode","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Cluster Management"],"description":"Update vManage tenancy mode","operationId":"setTenancyMode","requestBody":{"description":"Tenancy mode setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenancy mode":{"description":"Tenancy mode","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/tenantList":{"get":{"tags":["Cluster Management"],"description":"Get tenant list
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantsList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Tenant":{"description":"Tenant","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/userCreds":{"post":{"tags":["Cluster Management"],"description":"Add or update user credentials for cluster operations
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"addOrUpdateUserCredentials","requestBody":{"description":"User credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"User credential":{"description":"User credential","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/vManage/details/{vmanageIP}":{"get":{"tags":["Cluster Management"],"description":"Get vManage detail
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getVManageDetails","parameters":[{"name":"vmanageIP","in":"path","description":"vManage IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage detail":{"description":"vManage detail","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/clusterManagement/{tenantId}/connectedDevices/{vmanageIP}":{"get":{"tags":["Cluster Management"],"description":"Get connected device for vManage for a tenant
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getConnectedDevicesPerTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}},{"name":"vmanageIP","in":"path","description":"vManage IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/colocation/monitor/device/vnf":{"get":{"tags":["Colocation"],"description":"List all VNF attached with Device","operationId":"getvnfByDeviceId","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/action":{"post":{"tags":["Colocation"],"description":"To do VNF actions such as start, stop and restart","operationId":"vnfActions","parameters":[{"name":"vmName","in":"query","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","schema":{"$ref":"#/components/schemas/DeviceUuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/alarms":{"get":{"tags":["Colocation"],"description":"Get event detail of VNF","operationId":"getVNFEventsCountDetail","parameters":[{"name":"user_group","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/alarms/count":{"get":{"tags":["Colocation"],"description":"Get alarm count of VNF","operationId":"getVNFAlarmCount","parameters":[{"name":"user_group","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/events":{"get":{"tags":["Colocation"],"description":"Get event detail of VNF","operationId":"getVNFEventsDetail","parameters":[{"name":"vnfName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/colocation/monitor/vnf/interface":{"get":{"tags":["Colocation"],"description":"Get interface detail of VNF","operationId":"getVNFInterfaceDetail","parameters":[{"name":"vnfName","in":"query","required":true,"schema":{"type":"string"}},{"name":"deviceIp","in":"query","schema":{"$ref":"#/components/schemas/DeviceIP"}},{"name":"deviceClass","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/container-manager/activate/{containerName}":{"post":{"tags":["System - Container"],"description":"Activate container on remote host","operationId":"activateContainerOnRemoteHost","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"url","in":"query","description":"Container image URL","schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}},{"name":"checksum","in":"query","description":"Container image checksum","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/container-manager/deactivate/{containerName}":{"post":{"tags":["System - Container"],"description":"Deactivate container on remote host","operationId":"deActivateContainer","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/container-manager/doesValidImageExist/{containerName}":{"get":{"tags":["System - Container"],"description":"Get container image checksum","operationId":"doesValidImageExist","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Container image checksum":{"description":"Container image checksum","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin"}},"/container-manager/inspect/{containerName}":{"get":{"tags":["System - Container"],"description":"Get container inspect data","operationId":"getContainerInspectData","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Container inspect data":{"description":"Container inspect data"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/container-manager/settings/{containerName}":{"get":{"tags":["System - Container"],"description":"Get container settings","operationId":"getContainerSettings","parameters":[{"name":"containerName","in":"path","description":"Container name","required":true,"schema":{"type":"string"}},{"name":"hostIp","in":"query","description":"Container host IP","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Container settings":{"description":"Container settings","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/data/device/state/{state_data_type}":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device state data","operationId":"generateDeviceStateData","parameters":[{"name":"state_data_type","in":"path","required":true,"schema":{"type":"string"}},{"name":"startId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32","default":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDeviceStateData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/data/device/state/{state_data_type}/fields":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device state data fileds","operationId":"generateDeviceStateDataFields","parameters":[{"name":"state_data_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDeviceStateDataFields"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/data/device/state/{state_data_type}/query":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device state data fileds","operationId":"generateDeviceStateDataWithQueryString","parameters":[{"name":"state_data_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDeviceStateDataWithQueryString"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/data/device/statistics":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get statistics types","operationId":"getStatisticsType","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":["interfacestatistics","eioltestatistics","sulstatistics","qosstatistics","devicesystemstatusstatistics","bridgemacstatistics","dpistatistics","approutestatsstatistics","wlanclientinfostatistics","flowlogstatistics","urlf","fwall","vnfstatistics","umbrella","apphostingstatistics","utddaqioxstatistics","ipsalert","aggregatedappsdpistatistics","bridgeinterfacestatistics","artstatistics","trackerstatistics","cloudxstatistics","deviceevents","sleofflinereport","alarm","auditlog","deviceconfiguration","nwpi","nwpiflowraw","speedtest"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/data/device/statistics/alarm/active":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get active alarms","operationId":"getActiveAlarms","parameters":[{"name":"scrollId","in":"query","description":"SrollId","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date (example:2023-10-31T14:30:00)","schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date (example:2023-10-31T14:30:00)","schema":{"type":"string"}},{"name":"count","in":"query","description":"count","schema":{"type":"integer","format":"int64"}},{"name":"timeZone","in":"query","description":"Time zone","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Active alarms":{"description":"Active alarms","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/data/device/statistics/{state_data_type}":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get device statistics data","operationId":"generateDeviceStatisticsData","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}},{"name":"scrollId","in":"query","description":"Scroll Id","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date","schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"timeZone","in":"query","description":"Time zone","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Statistics data":{"description":"Statistics data","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/data/device/statistics/{state_data_type}/doccount":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get response count of a query","operationId":"getCountWithStateDataType","parameters":[{"name":"state_data_type","in":"path","description":"State data type(example:object)","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date (example:2023-10-31T14:30:00)","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date (example:2023-10-31T14:30:00)","required":true,"schema":{"type":"string"}},{"name":"timeZone","in":"query","description":"Time zone (example:UTC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Response count":{"description":"Response count","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/data/device/statistics/{state_data_type}/fields":{"get":{"tags":["Monitoring - Device Statistics Details"],"description":"Get statistics fields and types","operationId":"getStatDataFieldsByStateDataType","parameters":[{"name":"state_data_type","in":"path","description":"State data type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Statistics field and type":{"description":"Statistics field and type","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/dca/analytics":{"put":{"tags":["Data Collection Agent"],"description":"Update collection time of DCARest stat for vAnalytics","operationId":"createStats","requestBody":{"description":"Stats query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query":{"description":"Stats query","$ref":"#/components/examples/dca_analytics"}}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats data":{"description":"Stats data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/analytics/all":{"post":{"tags":["Data Collection Agent"],"description":"Get all statistics setting data","operationId":"getAllStatsDataDCA","requestBody":{"description":"Stats setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query":{"description":"Stats query","$ref":"#/components/examples/dca_analytics_all"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats index status":{"description":"Stats index status","$ref":"#/components/examples/dca_analytics_all-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices":{"get":{"tags":["System - Cloud Service"],"description":"Get cloud service settings","operationId":"getCloudSettings","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service setting":{"description":"Cloud service setting","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca"}},"/dca/cloudservices/accesstoken":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA access token","operationId":"getAccessToken","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA access token":{"description":"DCA access token","$ref":"#/components/examples/access_token"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Data Collection Agent"],"description":"Set DCA access token","operationId":"storeAccessToken","requestBody":{"description":"DCA access token","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA access token":{"description":"DCA access token","$ref":"#/components/examples/access_token-2"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/alarm":{"post":{"tags":["Data Collection Agent"],"description":"Generate DCA alarms","operationId":"generateAlarm","requestBody":{"description":"DCA alarm message","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA alarm message":{"description":"DCA alarm message","value":{"type":"otp_expired","message":"Cloud service OTP expired"}}}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/idtoken":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA Id token","operationId":"getIdToken","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA Id token":{"description":"DCA Id token","$ref":"#/components/examples/id_token"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Data Collection Agent"],"description":"Set DCA Id token","operationId":"storeIdToken","requestBody":{"description":"DCA Id token","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA Id token":{"description":"DCA Id token","$ref":"#/components/examples/id_token-2"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/otp":{"get":{"tags":["System - Cloud Service"],"description":"Get cloud service OTP value","operationId":"getOTP","responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service OTP value":{"description":"Cloud service OTP value","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca"},"put":{"tags":["System - Cloud Service"],"description":"Update cloud service OTP value","operationId":"updatetOTP","requestBody":{"description":"Cloud service OTP value","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service OTP value":{"description":"Cloud service OTP value","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"dca"}},"/dca/cloudservices/telemetry":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA telemetry settings","operationId":"getTelemetrySettings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA telemetry settings":{"description":"DCA telemetry settings","$ref":"#/components/examples/app_telemetry"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/cloudservices/vanalytics":{"post":{"tags":["System - Cloud Service"],"description":"Get session from DCS for vAnalytics","operationId":"getvAnalytics","requestBody":{"content":{"*/*":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Cloud service OTP value":{"description":"Cloud service OTP value","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"vAnalytics-readvAnalytics-writedca"}},"/dca/data/device/state/{state_data_type}":{"post":{"tags":["Data Collection Agent"],"description":"Get device state data","operationId":"generateDCADeviceStateData","parameters":[{"name":"state_data_type","in":"path","description":"Device state data","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","$ref":"#/components/examples/device_data_state"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device state":{"description":"Device state","$ref":"#/components/examples/device_data_state-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/data/device/statistics/{stats_data_type}":{"post":{"tags":["Data Collection Agent"],"description":"Get device statistics data","operationId":"generateDCADeviceStatisticsData","parameters":[{"name":"stats_data_type","in":"path","description":"Device statistics data","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","$ref":"#/components/examples/data_device_statistics"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device statistics":{"description":"Device statistics","$ref":"#/components/examples/data_device_statistics-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/dcatenantowners":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA tenant owners","operationId":"getDCATenantOwners","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA service owner":{"description":"DCA service owner","$ref":"#/components/examples/dca_tenant_owners"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/device":{"post":{"tags":["Data Collection Agent"],"description":"Get all devices","operationId":"listAllDevicesDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["57501bad-32a7-4f52-8f54-8547dcd7403e","07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device lists":{"description":"Device lists","$ref":"#/components/examples/device"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/device/crashlog/details":{"post":{"tags":["Data Collection Agent"],"description":"Get crash log","operationId":"getCrashLogs","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query":{"description":"Stats query","value":{"tenantId":["07917db1-bb13-40a0-a075-f81e91cd3bd4","57501bad-32a7-4f52-8f54-8547dcd7403e"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crash logs":{"description":"Crash logs","$ref":"#/components/examples/crashlog_details"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/device/crashlog/synced":{"get":{"tags":["Data Collection Agent"],"description":"Get device crash log","operationId":"getCrashLogsSynced","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crash logs":{"description":"Crash logs","$ref":"#/components/examples/crashlog_synced"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/settings/configuration/cloudservices/dca":{"get":{"tags":["Data Collection Agent"],"description":"Get DCA cloud service configuration","operationId":"getCloudServicesConfigurationDCA","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DCA cloud service configuration":{"description":"DCA cloud service configuration","$ref":"#/components/examples/dca_cloudservices_settings"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/settings/configuration/{type}/dca":{"post":{"tags":["Data Collection Agent"],"description":"Create analytics config data","operationId":"createDCAAnalyticsDataFile","parameters":[{"name":"type","in":"path","description":"Data type","required":true,"schema":{"type":"string","enum":["analytics","callHome"]}}],"requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["tenant1","tenant2"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Analytics config data":{"description":"Analytics config data","value":{"header":{"generatedOn":1717561371848},"data":{"dcs-region":"N/A","tenants":[]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/statistics/settings/status":{"post":{"tags":["Data Collection Agent"],"description":"Get statistics setting status","operationId":"getStatsDBIndexStatus","requestBody":{"description":"Stats setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query":{"description":"Stats query","$ref":"#/components/examples/statistics_settings_status"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats response":{"description":"Stats response","$ref":"#/components/examples/statistics_settings_status-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/system/device":{"post":{"tags":["Data Collection Agent"],"description":"Get device details","operationId":"getDevicesDetailsDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device details":{"description":"Device details","$ref":"#/components/examples/system_device"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/device/config/attachedconfig":{"post":{"tags":["Data Collection Agent"],"description":"Get attached config to device","operationId":"getDCAAttachedConfigToDevice","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["57501bad-32a7-4f52-8f54-8547dcd7403e","07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attached config to device":{"description":"Attached config to device","$ref":"#/components/examples/attached_config"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/definition/approute":{"post":{"tags":["Data Collection Agent"],"description":"Get template policy definitions","operationId":"getTemplatePolicyDefinitionsDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template policy definition":{"description":"Template policy definition","$ref":"#/components/examples/policy_def_approute"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/list/vpn":{"post":{"tags":["Data Collection Agent"],"description":"Get VPN details","operationId":"getVPNListsDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN":{"description":"VPN","$ref":"#/components/examples/policy_vpn_list"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/vedge":{"post":{"tags":["Data Collection Agent"],"description":"Get vEdge template list","operationId":"getVedgeTemplateListDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vEdge template":{"description":"vEdge template","$ref":"#/components/examples/vedge_policy"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/dca/template/policy/vsmart":{"post":{"tags":["Data Collection Agent"],"description":"Get vSmart template list","operationId":"getVsmartTemplateListDCA","requestBody":{"description":"Query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query string":{"description":"Query string","value":{"tenantId":["07917db1-bb13-40a0-a075-f81e91cd3bd4"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart template":{"description":"vSmart template","$ref":"#/components/examples/vsmart_policy"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device":{"get":{"tags":["Monitoring - Device Details"],"description":"List all devices","operationId":"listAllDevices","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceData"},"examples":{"Devices List":{"description":"Devices List","value":[{"deviceId":"169.254.10.1","system-ip":"169.254.10.1","host-name":"vm200","reachability":"reachable","status":"normal","personality":"vmanage","device-type":"vmanage","timezone":"UTC","device-groups":["No groups"],"lastupdated":1634627015139,"domain-id":"0","board-serial":"12345704","certificate-validity":"Valid","max-controllers":"0","uuid":"96af574a-eadd-4b6a-97bf-d5c1e98f40f2","controlConnections":"9","device-model":"vmanage","version":"20.8.999-1397","connectedVManages":["169.254.10.1"],"site-id":"200","latitude":"37.666684","longitude":-122.777023,"isDeviceGeoData":false,"platform":"x86_64","uptime-date":1634626320000,"statusOrder":4,"device-os":"next","validity":"valid","state":"green","state_description":"All daemons up","model_sku":"None","local-system-ip":"172.16.255.200","total_cpu_count":"8","testbed_mode":true,"layoutLevel":1}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/aaa/servers":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get AAA servers from device (Real Time)","operationId":"getAAAservers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"AAA servers":{"description":"AAA servers","value":{"data":[{"authen-retried-access-requests":"0","vdevice-name":"169.254.10.13","author-errors-received":"0","author-retried-access-requests":"0","connection-failures":"0","acct-messages-sent":"0","acct-errors-received":"0","author-timeout-access-requests":"0","author-messages-sent":"0","auth-port":"1812","acct-port":"1813","authen-access-accepts":"0","author-access-accepts":"0","connection-timeouts":"0","author-access-rejects":"0","authen-timeout-access-requests":"0","authen-messages-received":"0","stats-time":"2022-06-06T06:55:52+00:00","authen-errors-received":"0","author-messages-received":"0","vdevice-host-name":"vm6","vdevice-dataKey":"169.254.10.13-vm6-radius-0-10.10.10.10-1812-1813","group-name":"radius-0","authen-access-rejects":"0","lastupdated":1654498624166,"connection-aborts":"0","radius-server-ip":"10.10.10.10","authen-messages-sent":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/aaa/users":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get AAA users from device (Real Time)","operationId":"getAAAUsers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"AAA users":{"description":"AAA users","value":{"data":[{"protocol":"aaa-sess-proto-type-none","ip-addr":"0.0.0.0","vdevice-dataKey":"169.254.10.13-admin-4157","vdevice-name":"169.254.10.13","login-time":"2022-06-06T08:54:01+00:00","lastupdated":1654505707413,"aaa-uid":"4157","vdevice-host-name":"vm6","username":"admin","session-id":"4145"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/acl/matchcounter":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get ACL match counters from device (Real Time)","operationId":"getACLMatchCounterUsers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL match counters":{"description":"ACL match counters","value":{"data":[{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-100","vdevice-name":"10.0.0.121","rule-name":"100","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-101","vdevice-name":"10.0.0.121","rule-name":"101","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-102","vdevice-name":"10.0.0.121","rule-name":"102","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-103","vdevice-name":"10.0.0.121","rule-name":"103","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-104","vdevice-name":"10.0.0.121","rule-name":"104","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"},{"vdevice-dataKey":"10.0.0.121-CISCO-CWA-URL-REDIRECT-ACL-105","vdevice-name":"10.0.0.121","rule-name":"105","access-control-list-name":"CISCO-CWA-URL-REDIRECT-ACL","lastupdated":1652169932765,"vdevice-host-name":"Router","match-counter":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/action/cancel":{"post":{"tags":["Configuration - Device Actions"],"description":"Cancel tasks","operationId":"processCancelTask","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/Cancel"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/changepartition":{"get":{"tags":["Configuration - Device Actions"],"description":"Get change partition information","operationId":"generateChangePartitionInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}},"example":["172.16.255.15"]}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetChangePartitionResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process change partition operation","operationId":"processChangePartition","requestBody":{"description":"Request body for Process change partition operation","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostChangePartitionReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostChangePartitionResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/deactivate":{"get":{"tags":["Configuration - Device Actions"],"description":"Get deactivate partition information","operationId":"generateDeactivateInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}},"example":["172.16.255.15"]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDeactivateInfo"},"examples":{"Get deactivate partition information example":{"description":"Get deactivate partition information example","$ref":"#/components/examples/GetDeactivateResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"},"post":{"tags":["Configuration - Device Actions"],"description":"Process deactivate operation for smu image","operationId":"processDeactivateSmu","requestBody":{"description":"Device smu image deactivate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device deactivate request":{"description":"Device deactivate request","$ref":"#/components/examples/PostDeactivateReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/PostDeactivateResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/defaultpartition":{"post":{"tags":["Configuration - Device Actions"],"description":"Process marking default partition operation","operationId":"processDefaultPartition","requestBody":{"description":"Request body for Process marking default partition operation","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostDefaultPartitionReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/PostDefaultPartitionResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/filter/vpn":{"get":{"tags":["Configuration - Device Actions"],"description":"Get filter VPN list","operationId":"createFilterVPNList","parameters":[{"name":"site-id","in":"query","description":"site-id","schema":{"type":"string"},"example":500},{"name":"deviceId","in":"query","description":"deviceId","schema":{"type":"string"},"example":"172.16.255.14"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFilterVPNList"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/FilterVpnResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,RBAC VPN-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"}},"/device/action/firmware":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"Get list of firmware images in the repository","operationId":"getFirmwareImages","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"},"post":{"tags":["Configuration - Device Firmware Update"],"description":"Upload firmware image package","operationId":"processFirmwareImage","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware-upgrade":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Eemote firmware on device","operationId":"remoteFirmwareImageUpgrade","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostFirmwareUpgradeReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgrade"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/PostFirmwareUpgradeResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/devices":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"firmware supported devices","operationId":"getFirmwareDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/remote":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"firmware remote image package","operationId":"getFirmwareRemoteImage","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Firmware Update"],"description":"firmware remote image package","operationId":"processFirmwareRemoteImage","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostFirmwareUpgradeRemoteReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/remote/{versionId}":{"put":{"tags":["Configuration - Device Software Update"],"description":"Download software package file","operationId":"editFirmwareUpgardeRemoteImage","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"},"example":"e683117a-b38f-4980-a411-6c9c6293a9fc"}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PutFirmwareUpgradeRemoteReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/ProcessGetFirmwareRemoteImageReq"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware-upgrade/{versionId}":{"delete":{"tags":["Configuration - Device Software Update"],"description":"Download software package file","operationId":"deleteFirmwareUpgardeRemoteImage","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"},"example":"e683117a-b38f-4980-a411-6c9c6293a9fc"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/firmware/activate":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Activate firmware on device","operationId":"activateFirmwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware/devices":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"Get list of devices that support firmware upgrade","operationId":"getDevicesFWUpgrade","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"}},"/device/action/firmware/install":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Install firmware on device","operationId":"installFirmwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware/remove":{"post":{"tags":["Configuration - Device Firmware Update"],"description":"Remove firmware on device","operationId":"removeFirmwareImage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/firmware/{versionId}":{"get":{"tags":["Configuration - Device Firmware Update"],"description":"Get firmware image details for a given version","operationId":"getFirmwareImageDetails","parameters":[{"name":"versionId","in":"path","description":"Firmware image version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"},"delete":{"tags":["Configuration - Device Firmware Update"],"description":"Delete firmware image package","operationId":"deleteFirmwareImage","parameters":[{"name":"versionId","in":"path","description":"Firmware image version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Controller-write,Software Upgrade > Edge-write"}},"/device/action/image-download":{"post":{"tags":["Configuration - Device Actions"],"description":"Intitate image download on the given device.","operationId":"initiateImageDownload","requestBody":{"description":"Request body to Intitate image download on the given device","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/ImageDownload"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/ImageDownloadResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/image-remove":{"post":{"tags":["Configuration - Device Actions"],"description":"Process remove software image operation","operationId":"processRemoveSoftwareImage","requestBody":{"description":"Request body - Process remove software image operation","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/ImageRemove"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/ImageRemoveResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/install":{"get":{"tags":["Configuration - Device Actions"],"description":"Generate install info","operationId":"generateInstallInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}},"example":["172.16.255.15"]}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/InstallRespGet"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process an installation operation","operationId":"processInstall","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/Install"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/InstallRespPost"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/install/devices/{deviceType}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get list of installed devices","operationId":"generateDeviceList","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"type":"string"},"example":"vmanage"},{"name":"groupId","in":"query","description":"groupId","schema":{"type":"string"},"example":"all"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDeviceList"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetInstallDevicesResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,vmanage-http-stream,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/list":{"get":{"tags":["Configuration - Device Actions"],"description":"Get device action list","operationId":"generateDeviceActionList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateDeviceActionList"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/List"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/lxcactivate":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an activation operation","operationId":"processLxcActivate","requestBody":{"description":"Activation request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Activation Operation":{"description":"Activation Operation","$ref":"#/components/examples/LxcActivate"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/LxcActivate-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcdelete":{"post":{"tags":["Configuration - Device Actions"],"description":"Process a delete operation","operationId":"processLxcDelete","requestBody":{"description":"Delete request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Delete Operation":{"description":"Delete Operation","$ref":"#/components/examples/LxcDelete"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/LxcDelete-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcinstall":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an installation operation","operationId":"processLxcInstall","requestBody":{"description":"Installation request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Installation Operation":{"description":"Installation Operation","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcreload":{"post":{"tags":["Configuration - Device Actions"],"description":"Process a reload operation","operationId":"processLxcReload","requestBody":{"description":"Reload request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reload Operation":{"description":"Reload Operation","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcreset":{"post":{"tags":["Configuration - Device Actions"],"description":"Process a reset operation","operationId":"processLxcReset","requestBody":{"description":"Reset request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reset Operation":{"description":"Reset Operation","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/lxcupgrade":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an upgrade operation","operationId":"processLxcUpgrade","requestBody":{"description":"Upgrade request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Upgrade Operation":{"description":"Upgrade Operation","$ref":"#/components/examples/LxcUpgrade"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/LxcUpgrade-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/reboot":{"get":{"tags":["Configuration - Device Actions"],"description":"Get device reboot information","operationId":"generateRebootInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}},"example":["172.16.255.15"]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","$ref":"#/components/examples/GetRebootResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Reboot-read,Device Reboot-write,Device Reboot > Edge-read,Device Reboot > Edge-write,Device Reboot > Controller-read"},"post":{"tags":["Configuration - Device Actions"],"description":"Process a reboot operation","operationId":"processReboot","requestBody":{"description":"Device reboot request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reboot request":{"description":"Device reboot request","$ref":"#/components/examples/PostRebootReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskId"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/PostRebootResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Reboot-write,Device Reboot > Edge-write,Device Reboot > Controller-write"}},"/device/action/reboot/devices/{deviceType}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get list of rebooted devices","operationId":"generateRebootDeviceList","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"type":"string"},"example":"vedge"},{"name":"groupId","in":"query","description":"groupId","required":true,"schema":{"type":"string"},"example":"all"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRebootDeviceList"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetRebootDevicesResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Reboot-read,Device Reboot-write,Device Reboot > Edge-read,Device Reboot > Edge-write,Device Reboot > Controller-read"}},"/device/action/rediscover":{"get":{"tags":["Configuration - Device Actions"],"description":"Get rediscover operation information","operationId":"generateRediscoverInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRediscoverInfo"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetRediscoverResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read,Tools-write"},"post":{"tags":["Configuration - Device Actions"],"description":"Rediscover device","operationId":"reDiscoverDevices","requestBody":{"description":"Rediscover device request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Rediscover device request":{"description":"Rediscover device request","$ref":"#/components/examples/PostRediscoverReq"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write,Tools-write"}},"/device/action/rediscoverall":{"post":{"tags":["Configuration - Device Actions"],"description":"Rediscover all devices","operationId":"reDiscoverAllDevice","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write,Tools-write"}},"/device/action/remote-server":{"get":{"tags":["Configuration - Software Actions"],"description":"Get list of remote servers","operationId":"getRemoteServerList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Software Actions"],"description":"Add a new remote server entry.","operationId":"addRemoteServer","requestBody":{"description":"Request body for Add a new remote server entry.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostRemoteServer"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/remote-server/{id}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get remote server for the specified ID","operationId":"getRemoteServerById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Software Actions"],"description":"Update remote server for the specified ID","operationId":"updateRemoteServer","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Software Actions"],"description":"Delete remote server for the specified ID","operationId":"deleteRemoteServer","parameters":[{"name":"id","in":"path","description":"remoteServerId","required":true,"schema":{"type":"string"},"example":"f7ae1f4b-9900-424f-92ca-22d2231f55dc"}],"requestBody":{"description":"Request body for Add a new remote server entry.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/DeleteRemoteServer"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/removepartition":{"get":{"tags":["Configuration - Device Actions"],"description":"Get remove partition information","operationId":"generateRemovePartitionInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId","required":true,"schema":{"type":"string"},"example":"172.16.255.22"},{"name":"deviceId","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateRemovePartitionInfo"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetRemovePartition"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"},"post":{"tags":["Configuration - Device Actions"],"description":"Process remove partition operation","operationId":"processRemovePartition","requestBody":{"description":"Device remove partition request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device remove partition request":{"description":"Device remove partition request","$ref":"#/components/examples/PostRemovePartitionReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/PostRemovePartitionResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/security/amp/apikey/{uuid}":{"delete":{"tags":["Configuration - Device Actions"],"description":"Process amp api key deletion operation","operationId":"processDeleteAmpApiKey","parameters":[{"name":"uuid","in":"path","description":"Uuid","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"AMP API key deletion request":{"description":"AMP API key deletion request","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/security/amp/rekey":{"post":{"tags":["Configuration - Device Actions"],"description":"Process amp api re-key operation","operationId":"processAmpApiReKey","requestBody":{"description":"AMP API re-key request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"AMP API re-key request":{"description":"AMP API re-key request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/security/apikey/{uuid}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get API key from device","operationId":"testApiKey","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"API key":{"description":"API key","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/security/devices/{policyType}":{"get":{"tags":["Configuration - Device Actions"],"description":"Get list of devices by security policy type","operationId":"generateSecurityDevicesList","parameters":[{"name":"policyType","in":"path","description":"Policy type","required":true,"schema":{"type":"string","enum":["zoneBasedFW","intrusionPrevention","urlFiltering","advancedMalwareProtection","dnsSecurity","sslDecryption"]}},{"name":"groupId","in":"query","description":"Group Id","required":true,"schema":{"$ref":"#/components/schemas/GroupId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Settings-read,Security-read,Security-read,Security-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/software":{"get":{"tags":["Configuration - Software Actions"],"description":"Get software images","operationId":"findSoftwareImages","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetSoftware"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Software Actions"],"description":"Create software image URL","operationId":"createImageURL","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostSoftware"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/imageProperties/{versionId}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get Image Properties","operationId":"getImageProperties","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"},"example":"08d56e2f-10ee-452d-bd41-c375915cf7d7"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImageProperties"},"examples":{"Image properties":{"description":"Image properties","$ref":"#/components/examples/GetImageProperties"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/images":{"get":{"tags":["Configuration - Software Actions"],"description":"Get software images","operationId":"findSoftwareImagesWithFilters","parameters":[{"name":"imageType","in":"query","description":"imageType","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Image"}},"example":["software"]},{"name":"vnfType","in":"query","description":"vnfType","schema":{"type":"string"},"example":"ROUTER"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetSoftwareImages"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package":{"post":{"tags":["Configuration - Device Software Update"],"description":"Install software package","operationId":"installPkg","requestBody":{"description":"software Package File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/InstallPkg"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/imageCount":{"get":{"tags":["Configuration - Device Software Update"],"description":"Number of software image presented in vManage repository","operationId":"getUploadImagesCount","parameters":[{"name":"imageType","in":"query","description":"imageType","schema":{"type":"array","items":{"type":"string","default":"software"}},"example":["software"]}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/ImageCount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/signature/{utdsignature}":{"get":{"tags":["Configuration - Device Software Update"],"summary":"Get list of Utd images","description":"Get list of Utd images ","operationId":"generateUtdImageData","parameters":[{"name":"utdsignature","in":"path","description":"utdsignature","required":true,"schema":{"type":"string","enum":["utdsignature"]},"example":"utdsignature"},{"name":"type","in":"query","required":true,"schema":{"type":"string"},"example":"all"}],"responses":{"200":{"description":"Get list of Utd images","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageData"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/UtdImageData"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/utdsignature/{type}/mode/auto":{"post":{"tags":["Configuration - Device Software Update"],"summary":"add Utd remote image","description":"add Utd remote image ","operationId":"addUtdRemoteImage","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"custom"}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/UtdSignatureCustomAutoReq"}}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/utdsignature/{type}/mode/manual":{"post":{"tags":["Configuration - Device Software Update"],"summary":"upload Utd image","description":"upload Utd image","operationId":"uploadUtdImage","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"ips"}],"requestBody":{"description":"Utd image File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/InstallPkg"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/{fileName}":{"get":{"tags":["Configuration - Device Software Update"],"description":"Download software package file","operationId":"downloadPackageFile","parameters":[{"name":"fileName","in":"path","description":"software package file name","required":true,"schema":{"type":"string"},"example":"c8000v-universalk9.17.15.01.0.198014_V17_15_0_1.SSA.bin"},{"name":"imageType","in":"query","schema":{"type":"string","default":"software"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/FileName"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/{imageType}":{"post":{"tags":["Configuration - Device Software Update"],"description":"Install software image package","operationId":"processSoftwareImage","parameters":[{"name":"imageType","in":"path","required":true,"schema":{"type":"string"},"example":"software"}],"requestBody":{"description":"image File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/InstallPkg"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/package/{versionId}/metadata":{"get":{"tags":["Configuration - Device Software Update"],"description":"Update Package Metadata","operationId":"getImageMetadata","parameters":[{"name":"versionId","in":"path","description":"versionId","required":true,"schema":{"type":"string"},"example":"760c1198-1595-4ad2-b911-cec12e4da7b3"}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetVersionId"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Device Software Update"],"description":"Update Package Metadata","operationId":"editImageMetadata","parameters":[{"name":"versionId","in":"path","description":"versionId","required":true,"schema":{"type":"string"},"example":"760c1198-1595-4ad2-b911-cec12e4da7b3"}],"requestBody":{"description":"Request body to Update Package Metadata","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PutVersionId"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/remoteserver/{versionId}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get Image Remote Server Details","operationId":"getImageRemoteServer","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Remote Server Details":{"description":"Remote Server Details","value":{"remoteServers":[{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e03","ImageRelativePath":"/images"},{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e14","ImageRelativePath":"/images/virtualImages"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"},"put":{"tags":["Configuration - Software Actions"],"description":"Update Image Remote Server Details","operationId":"editImageRemoteServer","parameters":[{"name":"versionId","in":"path","description":"Image ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update image remote server details","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update image remote server details":{"description":"Update image remote server details","value":{"remoteServers":[{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e03","ImageRelativePath":"/images"},{"remoteServerId":"6d22e7fb-335c-4f93-a756-f2d5fa815e14","ImageRelativePath":"/images/virtualImages"}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/software/vedge/version":{"get":{"tags":["Configuration - Software Actions"],"description":"Get vEdge software version","operationId":"findVEdgeSoftwareVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindVEdgeSoftwareVersion"},"examples":{"vEdge software version":{"description":"vEdge software version","$ref":"#/components/examples/VedgeVersion"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/version":{"get":{"tags":["Configuration - Software Actions"],"description":"Get software version","operationId":"findSoftwareVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindSoftwareVersion"},"examples":{"Software version":{"description":"Software version","$ref":"#/components/examples/Version"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/vnfproperties/{versionId}":{"get":{"tags":["Configuration - Software Actions"],"description":"Get VNF Properties","operationId":"getVnfProperties","parameters":[{"name":"versionId","in":"path","required":true,"schema":{"type":"string"},"example":"c9a1bf09-1060-4c82-a9e8-745159ddfc1d"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVnfProperties"},"examples":{"VNF properties":{"description":"VNF properties","$ref":"#/components/examples/VnfProperties"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/ztp/version":{"get":{"tags":["Configuration - Software Actions"],"description":"Get ZTP software version","operationId":"findZtpSoftwareVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vEdge software version":{"description":"vEdge software version","$ref":"#/components/examples/ZtpVersion"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/software/{versionId}":{"put":{"tags":["Configuration - Software Actions"],"description":"Update software image URL","operationId":"updateImageURL","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update software image request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update software image request":{"description":"Update software image request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"},"delete":{"tags":["Configuration - Software Actions"],"description":"Delete software image URL","operationId":"deleteImageURL","parameters":[{"name":"versionId","in":"path","description":"Version","required":true,"schema":{"type":"string"},"example":"08d56e2f-10ee-452d-bd41-c375915cf7d7"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/startmonitor":{"get":{"tags":["Configuration - Device Actions"],"description":"Triggers global monitoring thread","operationId":"triggerPendingTasksMonitoring","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/status/cancel/{processId}":{"post":{"tags":["Configuration - Dashboard Status"],"description":"Bulk cancel task status","operationId":"cancelPendingTasks","parameters":[{"name":"processId","in":"path","description":"Process Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/clean":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Delete task and status vertex","operationId":"cleanStatus","parameters":[{"name":"cleanStatus","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/device/action/status/clear":{"delete":{"tags":["Configuration - Dashboard Status"],"description":"Delete status of action","operationId":"deleteStatus","parameters":[{"name":"processId","in":"query","description":"Process Id","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/mw":{"get":{"tags":["Configuration - Maintenance window flag"],"description":"Get status of maintenance window for vManage upgrade flag","operationId":"getMaintenanceWindowFlag","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get maintenance window flag":{"description":"Get maintenance window flag","value":{"mw":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Maintenance window flag"],"description":"Update maintenance window flag","operationId":"updateMaintenanceWindowFlag","requestBody":{"description":"Update maintenance window flag","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update maintenance window flag":{"description":"Update maintenance window flag","value":{"mw":true}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/tasks":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Find running tasks","operationId":"findRunningTasks","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/tasks/activeCount":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Get active task count","operationId":"getActiveTaskCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTaskStatus"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/tasks/clean":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Delete task and status vertex","operationId":"getCleanStatus","parameters":[{"name":"processId","in":"query","description":"Process Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTaskStatus"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/status/{processId}":{"get":{"tags":["Configuration - Dashboard Status"],"description":"Find status of action","operationId":"findStatus","parameters":[{"name":"processId","in":"path","description":"processId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTaskStatus"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/test/ioxconfig/{deviceIP}":{"get":{"tags":["Configuration - Device Actions"],"description":"testIoxConfig","operationId":"testIoxConfig","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/action/uniquevpnlist":{"post":{"tags":["Configuration - Device Actions"],"description":"Create unique VPN list","operationId":"createUniqueVPNList","requestBody":{"description":"Device IPs","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device IPs":{"description":"Device IPs","$ref":"#/components/examples/UniqueVpnListReq"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/UniqueVpnListResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Software Upgrade-read,Software Upgrade > Edge-read,Software Upgrade > Controller-read"}},"/device/action/vnfinstall":{"post":{"tags":["Configuration - Device Actions"],"description":"Process an installation operation","operationId":"processVnfInstall","requestBody":{"description":"Installation request payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Installation Operation":{"description":"Installation Operation","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Software Upgrade-write,Software Upgrade > Edge-write,Software Upgrade > Controller-write"}},"/device/action/vpn":{"get":{"tags":["Configuration - Device Actions"],"description":"Create VPN list","operationId":"createVPNList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVPNList"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/VpnResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/device/action/ztp/upgrade":{"get":{"tags":["Configuration - Device Actions"],"description":"Get ZTP upgrade configuration","operationId":"getZTPUpgradeConfig","responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/GetZtpUpgradeResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process ZTP upgrade configuration setting","operationId":"postprocessZTPUpgradeConfigSetting","requestBody":{"description":"Request body for ZTP upgrade configuration setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostZtpUpgradeReq"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/action/ztp/upgrade/setting":{"get":{"tags":["Configuration - Device Actions"],"description":"Get ZTP upgrade configuration setting","operationId":"getZTPUpgradeConfigSetting","responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/GetZtpUpgradeResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Actions"],"description":"Process ZTP upgrade configuration setting","operationId":"processZTPUpgradeConfigSetting","requestBody":{"description":"Request body for ZTP upgrade configuration setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostZtpUpgradeSettingReq"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/app-hosting/attached-devices":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting attached device from device","operationId":"getAppHostingAttachedDevices","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting attached device":{"description":"App hosting attached device","value":{"data":[{"vdevice-dataKey":"172.16.255.15-utd-null","attached-device-type":"Serial/Trace","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"serial3","app-name":"utd"},{"attached-device-name":"dp_1_0","vdevice-dataKey":"172.16.255.15-utd-dp_1_0","attached-device-type":"NIC","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"net2","app-name":"utd"},{"attached-device-name":"dp_1_1","vdevice-dataKey":"172.16.255.15-utd-dp_1_1","attached-device-type":"NIC","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"net3","app-name":"utd"},{"attached-device-name":"_rootfs","vdevice-dataKey":"172.16.255.15-utd-_rootfs","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","app-name":"utd"},{"attached-device-name":"ieobc_1","vdevice-dataKey":"172.16.255.15-utd-ieobc_1","attached-device-type":"NIC","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","attached-device-alias":"ieobc","app-name":"utd"},{"attached-device-name":"/opt/var","vdevice-dataKey":"172.16.255.15-utd-/opt/var","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","app-name":"utd"},{"attached-device-name":"/tmp/HTX-IOX","vdevice-dataKey":"172.16.255.15-utd-/tmp/HTX-IOX","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314427,"vdevice-host-name":"vm5","app-name":"utd"},{"attached-device-name":"/opt/var/core","vdevice-dataKey":"172.16.255.15-utd-/opt/var/core","attached-device-type":"Disk","vdevice-name":"172.16.255.15","lastupdated":1659432314428,"vdevice-host-name":"vm5","app-name":"utd"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/details":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting details from device","operationId":"getAppHostingDetails","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting details":{"description":"App hosting details","value":{"data":[{"application-name":"utd","activated-profile-name":"cloud-low","application-installed-version":"1.0.6_SV2.9.18.1_XE17.9","vdevice-name":"172.16.255.15","package-info-name":"UTD-Snort-Feature","application-owner":"ioxm","vdevice-host-name":"vm5","resource-admission-cpu":"0","resource-reservation-disk":"861","package-info-path":"/bootflash/111.tar","vdevice-dataKey":"172.16.255.15-utd","resource-reservation-cpu":"0","resource-reservation-memory":"2048","name":"utd","application-description":"Unified Threat Defense","lastupdated":1659432542156,"state":"RUNNING","application-type":"LXC"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/guest-routes":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting guest routes from device","operationId":"getAppHostingGuestRoutes","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting guest routes":{"description":"App hosting guest routes","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","app-name":"utd","vdevice-dataKey":"172.16.255.15-utd","guest-route-route":"192.168.0.1","lastupdated":"1660244459596"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/network-interfaces":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting network interface from device","operationId":"getAppHostingNetworkDevices","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting network interface":{"description":"App hosting network interface","value":{"data":[{"network-interface-ipv4-address":"0.0.0.0","vdevice-dataKey":"172.16.255.15-utd-54:0e:00:0b:0c:02","vdevice-name":"172.16.255.15","network-interface-mac-address":"54:0e:00:0b:0c:02","lastupdated":1659432268936,"network-interface-attached-interface":"eth0","vdevice-host-name":"vm5","app-name":"utd"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/network-utilization":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting network utilization from device","operationId":"getAppHostingNetworkUtils","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting network utilization":{"description":"App hosting network utilization","value":{"data":[{"network-util-alias":"net2","network-util-rx-bytes":"0","vdevice-name":"172.16.255.15","network-util-name":"dp_1_0","network-util-tx-errors":"0","vdevice-host-name":"vm5","app-name":"utd","network-util-rx-packets":"0","vdevice-dataKey":"172.16.255.15-utd-dp_1_0","network-util-tx-packets":"0","lastupdated":1659432057682,"network-util-tx-bytes":"0","network-util-rx-errors":"0"},{"network-util-alias":"net3","network-util-rx-bytes":"0","vdevice-name":"172.16.255.15","network-util-name":"dp_1_1","network-util-tx-errors":"0","vdevice-host-name":"vm5","app-name":"utd","network-util-rx-packets":"0","vdevice-dataKey":"172.16.255.15-utd-dp_1_1","network-util-tx-packets":"0","lastupdated":1659432057683,"network-util-tx-bytes":"0","network-util-rx-errors":"0"},{"network-util-alias":"ieobc","network-util-rx-bytes":"11138","vdevice-name":"172.16.255.15","network-util-name":"ieobc_1","network-util-tx-errors":"0","vdevice-host-name":"vm5","app-name":"utd","network-util-rx-packets":"189","vdevice-dataKey":"172.16.255.15-utd-ieobc_1","network-util-tx-packets":"189","lastupdated":1659432057683,"network-util-tx-bytes":"12243","network-util-rx-errors":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/processes":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting processes from device","operationId":"getAppHostingProcesses","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting processes utilization":{"description":"App hosting processes utilization","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","app-name":"utd","process-name":"process01","process-status":"Running","process-pid":"10","process-uptime":"3600","process-memory":"2048","lastupdated":1660244459596,"vdevice-dataKey":"172.16.255.15-utd"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/storage-utilization":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting storage utilization from device","operationId":"getAppHostingStorageUtils","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting storage utilization":{"description":"App hosting storage utilization","value":{"data":[{"storage-util-name":"disk","storage-util-rd-bytes":"0","storage-util-wr-requests":"0","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","app-name":"utd","storage-util-capacity":"881664","storage-util-errors":"0","vdevice-dataKey":"172.16.255.15-utd-disk","storage-util-available":"35990","lastupdated":1659432204521,"storage-util-wr-bytes":"0","storage-util-rd-requests":"0","storage-util-used":"845674"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-hosting/utilization":{"get":{"tags":["Real-Time Monitoring - App Hosting"],"description":"Get App hosting utilization from device","operationId":"getAppHostingUtilization","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App hosting utilization":{"description":"App hosting utilization","value":{"data":[{"utilization-name":"utd","memory-allocation":"0","vdevice-dataKey":"172.16.255.15-utd","actual-application-util":"0","vdevice-name":"172.16.255.15","requested-application-util":"0","name":"utd","lastupdated":1659353382195,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/app-route/sla-class":{"get":{"tags":["Real-Time Monitoring - Application-Aware Route"],"description":"Get SLA class list from device (Real Time)","operationId":"createAppRouteSlaClassList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SLA class":{"description":"SLA class","value":{"data":[{"app-probe-class":"None","loss":0,"fallback-best-tunnel":"None","jitter":0,"vdevice-dataKey":"169.254.10.10-0","vdevice-name":"169.254.10.10","latency":0,"name":"__all_tunnels__","index":0,"lastupdated":1642576726463,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/app-route/statistics":{"get":{"tags":["Real-Time Monitoring - Application-Aware Route"],"description":"Get application-aware routing statistics from device (Real Time)","operationId":"createAppRouteStatisticsList","parameters":[{"name":"remote-system-ip","in":"query","description":"Remote system IP","schema":{"type":"string"}},{"name":"local-color","in":"query","description":"Local color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"remote-color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Application-aware routing statistics":{"description":"Application-aware routing statistics","value":{"data":[{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","tx-data-pkts":"0","vdevice-name":"169.254.10.10","src-port":12346,"dst-port":"12426","remote-color":"default","remote-system-ip":"172.16.254.1","fallback-sla-class-index":"None","mean-latency":0,"total-packets":"600","loss":"0","mean-jitter":0,"average-latency":"0","index":"3","sla-class-index":"0","vdevice-host-name":"vm3","local-color":"default","app-probe-class":"None","mean-loss":0,"vdevice-dataKey":"169.254.10.10-3","proto":"ipsec","lastupdated":1642577794383,"average-jitter":"0","rx-data-pkts":"0"},{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","tx-data-pkts":"0","vdevice-name":"169.254.10.10","src-port":12346,"dst-port":"12426","remote-color":"default","remote-system-ip":"172.16.254.1","fallback-sla-class-index":"None","mean-latency":0,"total-packets":"600","loss":"0","mean-jitter":0,"average-latency":"0","index":"4","sla-class-index":"0","vdevice-host-name":"vm3","local-color":"default","app-probe-class":"None","mean-loss":0,"vdevice-dataKey":"169.254.10.10-4","proto":"ipsec","lastupdated":1642577794385,"average-jitter":"0","rx-data-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/app/log/flow-count":{"get":{"tags":["Real-Time Monitoring - App Logs"],"description":"Get App log flows count from device (Real Time)","operationId":"getAppLogFlowCount","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App log flows count":{"description":"App log flows count","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","count":"20","vdevice-dataKey":"172.16.254.1","lastupdated":1654066320000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/app/log/flows":{"get":{"tags":["Real-Time Monitoring - App Logs"],"description":"Get App log flows from device (Real Time)","operationId":"getAppLogFlows","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App log flows":{"description":"App log flows","value":{"data":[{"vdevice-name":"172.16.254.2","vdevice-host-name":"vm2","vpn-id":"0","src-ip":"10.0.5.19","dest-ip":"10.1.15.15","src-port":"23556","dest-port":"34576","dscp":"0","ip-proto":"6","tcp-cntrl-bits":"16","icmp-opcode":"0","nhop-ip":"10.1.15.15","total-pkts":"8531","total-bytes":"1200071","start-time":"Fri July 15 10:32:52 2022","time-to-expire":"59","egress-intf-name":"cpu","ingress-intf-name":"ge0/0","policy-name":"123NenokaKantri","policy-action":"accept","policy-direction":"inbound-acl","lastupdated":1657853484627,"vdevice-dataKey":"172.16.254.2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/appqoe/active-flow-id":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Active flow Id details from device","operationId":"createAppqoeActiveFlowIdDetails","parameters":[{"name":"flow-id","in":"query","description":"Flow Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Active FlowId details":{"description":"Appqoe Flow Active FlowId details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/appqoe/appqoe-hput-stats":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Hput Statistics from device","operationId":"getAppqoeHputStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Hput Statistics":{"description":"Appqoe Hput Statistics","value":{"data":[{"hs-sch-delay20us":"2569563","hs-time-node-dealloc":"10730115","uhs-callout-drain":"0","uhs-stop-cancel":"0","hs-exp-list-process":"237791","hs-curr-node-null":"0","hs-sch-delay200us":"4110","hs-sch-delay10000us":"6741","uhs-callout-unlock":"0","uhs-add":"1624643","uhs-rst-sbt-drain":"0","hs-timer-deleted":"0","hs-sch-delay300us":"1809","uhs-stop-del-cancel":"0","hs-sch-delay400us":"1541","uhs-add-fail":"0","hs-sch-delay1000000us":"0","hs-sch-delay1000us":"1069","uhs-stop-no-pending":"4","hs-timer-del-failed":"0","hs-expired-send-sig":"224059","uhs-stop-nodrain":"0","hs-sch-delay500us":"1444","hs-sch-delay30us":"198079","hs-timer-alloc":"10730124","hs-time-node-added":"10713486","uhs-stop":"4","uhs-callout-lock":"0","uhs-raw-add":"9105481","hs-ktimer-start":"17812503","hs-sch-delay600us":"1463","hs-ktimer-cb":"10475629","uhs-rst-sbt-del":"0","hs-expired-list-alloc":"237791","hs-sch-delay700us":"1417","hs-timer-cb":"10730115","uhs-callout":"1624635","uhs-raw-cb":"9105480","hs-timer-add-req":"10730124","vdevice-name":"169.254.10.12","uhs-rst-sbt-req":"1624643","hs-sch-delay40us":"27818","hs-timer-dealloc":"10730115","uhs-callout-done":"1624635","hs-time-node-deleted":"10713477","hs-sch-delay100000us":"2","uhs-callout-not-pending":"0","uhs-raw-add-failed":"0","hs-timer-del-req":"0","hs-pending-list-process":"224059","uhs-rst-sbt-add":"1624643","uhs-callout-cancel":"0","hs-sch-delay800us":"1334","hs-sch-delay10us":"7627736","hs-expired-list-dealloc":"237791","hs-min-sch-delay":"4330","uhs-callout-call":"1624635","uhs-callout-del":"0","uhs-rst-sbt-cancel":"0","vdevice-host-name":"vm5","hs-sch-delay900us":"1186","hs-time-node-alloc":"10730124","hs-time-node-exist":"0","hs-sch-delay50us":"13812","uhs-stop-drain":"0","uhs-stop-del":"0","hs-time-node-expired":"1642","vdevice-dataKey":"169.254.10.12","hs-curr-node-ts-not-valid":"0","hs-timer-added":"10493918","hs-sch-delay100us":"16505","uihs-nr-hpts-cpu":"0","hs-timer-add-expired":"236206","hs-max-sch-delay":"36715506","lastupdated":1644996827424,"hs-ktimer-stop":"17812503"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-nat-stats":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Nat Statistics from device","operationId":"getAppqoeNatStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Nat Statistics":{"description":"Appqoe Nat Statistics","value":{"data":[{"port-alloc-fail":"0","port-free-succ":"0","port-free-fail":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","alloc-fail":"0","lastupdated":1644997117219,"dup-entries":"0","vdevice-host-name":"vm5","port-alloc-succ":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-rm-resource":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Resource Manager resources from device","operationId":"getAppqoeRmResources","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Resource Manager resources":{"description":"Appqoe Resource Manager resources","value":{"data":[{"ssl-max-sess":"40000","avail-sys-mem":"2411556","dre-mem-per-sess":"0","ssl-used-sess":"0","vdevice-name":"169.254.10.12","rm-global-health-flag":"status-green","rm-tcp-sess-flag":"status-green","dre-used-sess":"0","tcp-max-sess":"40000","http-mem-per-sess":"0","vdevice-host-name":"vm5","rm-svc-mem-flag":"status-green","vdevice-dataKey":"169.254.10.12","per-used-serv-mem":"0","used-serv-mem":"0","http-max-sess":"0","tcp-used-sess":"0","ssl-mem-per-sess":"50","tcp-mem-per-sess":"64","lastupdated":1644997246553,"http-used-sess":"0","max-serv-mem":"1205778","dre-max-sess":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-rm-stats":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe RM Statistics from device","operationId":"getAppqoeRMStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe RM Statistics":{"description":"Appqoe RM Statistics","value":{"data":[{"port-alloc-fail":"0","port-free-succ":"0","port-free-fail":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","alloc-fail":"0","lastupdated":1644997491529,"dup-entries":"0","vdevice-host-name":"vm5","port-alloc-succ":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-services-status":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Services Status from device","operationId":"getAppqoeServicesStatus","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Services Status":{"description":"Appqoe Services Status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","service":"appqoe-service-tcpopt","load-percentage":"0","lastupdated":1644998907908,"vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","service":"appqoe-service-ssl","load-percentage":"0","lastupdated":1644998907908,"vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","load-status":"appqoe-service-status-red","vdevice-name":"169.254.10.12","service":"appqoe-service-dreopt","lastupdated":1644998907908,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-sppi-pipe-resource":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Sppi Pipe Stats from device","operationId":"getAppqoeSppiPipeStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Sppi Pipe Statistics":{"description":"Appqoe Sppi Pipe Statistics","value":{"data":[{"p-invalid-mtu":"0","p-disconnect":"0","p-in-use":"0","p-invalid-queue-id":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","channel-num":"0","lastupdated":1644997573992,"p-ifindex-error":"0","vdevice-host-name":"vm5","p-sock-error":"0"},{"p-invalid-mtu":"0","p-disconnect":"0","p-in-use":"0","p-invalid-queue-id":"0","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","channel-num":"1","lastupdated":1644997573993,"p-ifindex-error":"0","vdevice-host-name":"vm5","p-sock-error":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/appqoe-sppi-queue-resource":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Sppi Queue Stats from device","operationId":"getAppqoeSppiQueueStats","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Sppi Queue Statistics":{"description":"Appqoe Sppi Queue Statistics","value":{"data":[{"pkt-send-failed":"0","vdevice-name":"169.254.10.12","poll-error":"0","tpkt-version-error":"0","mmap-error":"0","truncated":"0","no-pkt-buf":"0","pkt-available":"0","invalid-ring":"0","vdevice-host-name":"vm5","in-use":"0","no-dev":"0","pkt-read-failed":"0","invalid-mode":"0","vdevice-dataKey":"169.254.10.12","nomem":"0","no-iov-buf":"0","not-init":"0","sock-error":"0","pkt":"8","channel-num":"0","lastupdated":1644998764198,"invalid-size":"0","pkt-losing":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/cluster-summary":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Cluster Summary from device","operationId":"getAppqoeClusterSummary","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Cluster Summary":{"description":"Appqoe Cluster Summary","value":{"data":[{"load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","load-percentage":"0","system-ip":"172.16.254.4","sng-name":"SNG-APPQOE","site-id":"5","vdevice-host-name":"vm5","lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.2","error-message":"-","service":"appqoe-service-tcpopt","lastupdated":1644995623537,"device-mode":"device-mode-integrated-service-node","status":"sn-status-green"},{"load-status":"appqoe-service-status-green","vdevice-name":"169.254.10.12","load-percentage":"0","system-ip":"172.16.254.4","sng-name":"SNG-APPQOE","site-id":"5","vdevice-host-name":"vm5","lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.2","error-message":"-","service":"appqoe-service-ssl","lastupdated":1644995623537,"device-mode":"device-mode-integrated-service-node","status":"sn-status-green"},{"load-status":"appqoe-service-status-red","vdevice-name":"169.254.10.12","system-ip":"172.16.254.4","sng-name":"SNG-APPQOE","site-id":"5","vdevice-host-name":"vm5","lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.2","error-message":"-","service":"appqoe-service-dreopt","lastupdated":1644995623537,"device-mode":"device-mode-integrated-service-node","status":"sn-status-green"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/error-recent":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe error recent from device","operationId":"getAppqoeErrorRecent","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Error Recent":{"description":"Appqoe Error Recent","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-res-tcp-used-sess","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-res-ssl-used-sess","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-health-yellow","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-health-green","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-tcp-sess-alloc","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-tcp-sess-free","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-ssl-sess-alloc","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-rm-ssl-sess-free","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-tcp-tot-conn","vdevice-host-name":"vm5"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","stat-current":"0","stat-60s":"0","lastupdated":1644995930359,"stat-30s":"0","label":"appqoe-stat-tcp-tot-flow-create","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/expired-flow-id":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Expired flow Id details from device","operationId":"createAppqoeFlowIdExpiredDetails","parameters":[{"name":"flow-id","in":"query","description":"Flow Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Expired flow Id details":{"description":"Appqoe Expired flow Id details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/appqoe/flow-closed-error":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe flow closed error from device","operationId":"getAppqoeFlowClosedError","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Closed Error":{"description":"Appqoe Flow Closed Error","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.2","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.3","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.4","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.5","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","flow-id":"0","vpn-id":"1","client-ip":"1.1.1.1","client-port":"80","remote-server-ip":"2.2.2.6","remote-server-port":"8080","service":"appqoe-service-ssl","tcpproxy-err-tag":"tag1","sslproxy-err-tag":"tag2","lastupdated":1655736428995}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/flow-expired":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe expired from device","operationId":"getAppqoeExpired","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Expired List":{"description":"Appqoe Flow Expired List","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/appqoe/service-controllers":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe service controllers from device","operationId":"getAppqoeServiceControllers","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Service Controllers":{"description":"Appqoe Service Controllers","value":{"data":[{"sn-lan-ip":"192.168.2.2","vdevice-dataKey":"169.254.10.12-192.168.2.1","vdevice-name":"169.254.10.12","sc-lan-ip":"192.168.2.1","system-ip":"172.16.254.4","lastupdated":1644996521181,"site-id":"5","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/status":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe status from device","operationId":"getAppqoeStatus","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Status":{"description":"Appqoe Status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-sslproxy","err-tag":"appqoe-err-ca-tp-cfg","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-yellow"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-tcpproxy","err-tag":"appqoe-err-undef","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-green"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-sc","err-tag":"appqoe-err-undef","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-green"},{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","module":"appqoe-module-rm","err-tag":"appqoe-err-undef","appqoe-status":"appqoe-status-yellow","lastupdated":1644996370984,"vdevice-host-name":"vm5","status":"appqoe-status-green"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/appqoe/vpn-id":{"get":{"tags":["Real-Time Monitoring - Appqoe"],"description":"Get Appqoe Active vpn Id details from device","operationId":"createAppqoeVpnIdList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","required":true,"schema":{"type":"string"}},{"name":"client-ip","in":"query","description":"Client Ip","schema":{"type":"string"}},{"name":"server-ip","in":"query","description":"Server Ip","schema":{"type":"string"}},{"name":"server-port","in":"query","description":"Server-Port","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Appqoe Flow Active VpnId List":{"description":"Appqoe Flow Active VpnId List","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/arp":{"get":{"tags":["Real-Time Monitoring - ARP"],"description":"Get ARP interfaces from device (Real Time)","operationId":"getARPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ARP interface":{"description":"ARP interface","value":{"data":[{"if-name":"ge0/1","idle-timer":"0:00:10:36","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"10.101.254.254","lastupdated":1642578468257,"state":"dynamic","vpn-id":"0","uptime-date":1642160280000,"vdevice-host-name":"vm3","mac":"52:54:00:7a:da:f8","uptime":"4:20:09:23"},{"if-name":"eth0","vdevice-dataKey":"169.254.10.10-512-eth0","vdevice-name":"169.254.10.10","ip":"10.0.1.3","lastupdated":1642578468257,"state":"static","vpn-id":"512","uptime-date":1642154760000,"vdevice-host-name":"vm3","mac":"00:50:56:00:01:03","uptime":"4:21:41:16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/autonomousversion":{"get":{"tags":["developers"],"summary":"Get Software version from device","description":"Get Software version from device","operationId":"getAutonomousSoftwareVersion","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string"},"example":"172.16.255.15"}],"responses":{"200":{"description":"Software version from device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwareVersion"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetAutonomousVersion"}}}}},"400":{"description":"bad input parameter"}}}},"/device/bfd/history":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get BFD session history from device (Real Time)","operationId":"createBFDHistoryList","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD session history":{"description":"BFD session history","value":{"data":[{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"default","tx-pkts":3856,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187218000,"system-ip":"172.16.254.1","index":8,"dst-port":12386,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-8-2022-01-14T19:06:58+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:58+0000","state":"down","rx-pkts":3855},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"default","tx-pkts":6,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187218000,"system-ip":"172.16.254.1","index":9,"dst-port":12386,"del":1,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-9-2022-01-14T19:06:58+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:58+0000","state":"down","rx-pkts":6},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"biz-internet","tx-pkts":0,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187219000,"system-ip":"172.16.254.1","index":6,"dst-port":12406,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-6-2022-01-14T19:06:59+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:59+0000","state":"down","rx-pkts":0},{"dst-ip":"10.101.2.2","src-ip":"10.101.3.3","color":"biz-internet","tx-pkts":6,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642187219000,"system-ip":"172.16.254.1","index":7,"dst-port":12406,"del":0,"site-id":2,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-7-2022-01-14T19:06:59+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T19:06:59+0000","state":"up","rx-pkts":6},{"dst-ip":"10.102.5.5","src-ip":"10.101.3.3","color":"default","tx-pkts":95431,"vdevice-name":"169.254.10.10","src-port":12346,"time-date":1642577832000,"system-ip":"172.16.254.4","index":8,"dst-port":12386,"del":0,"site-id":5,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-8-2022-01-19T07:37:12+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-19T07:37:12+0000","state":"down","rx-pkts":95426},{"dst-ip":"10.102.16.16","src-ip":"10.102.3.3","color":"lte","tx-pkts":0,"vdevice-name":"169.254.10.10","src-port":12366,"time-date":1642163442000,"system-ip":"172.16.254.16","index":6,"dst-port":12366,"del":0,"site-id":16,"vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-6-2022-01-14T12:30:42+0000","proto":"ipsec","lastupdated":1642581869106,"time":"2022-01-14T12:30:42+0000","state":"down","rx-pkts":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/links":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get list of BFD connections","operationId":"createBFDLinkList","parameters":[{"name":"state","in":"query","description":"Device state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD connections":{"description":"BFD connections","value":{"data":[{"linkKey":"172.16.255.14:lte - 172.16.255.16:lte","linkKeyDisplay":"172.16.255.14 (lte) - 172.16.255.16 (lte)","asystem-ip":"172.16.255.16","bhost-name":"vm4","lastupdated":"1642494861369","bsite-id":"400","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.14","ahost-name":"vm6","adeviceId":"172.16.255.16","asite-id":"600","bsystem-ip":"172.16.255.14"},{"linkKey":"172.16.255.11:lte - 172.16.255.16:lte","linkKeyDisplay":"172.16.255.11 (lte) - 172.16.255.16 (lte)","asystem-ip":"172.16.255.16","bhost-name":"vm1","lastupdated":"1642663041881","bsite-id":"100","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.11","ahost-name":"vm6","adeviceId":"172.16.255.16","asite-id":"600","bsystem-ip":"172.16.255.11"},{"linkKey":"172.16.255.16:lte - 172.16.255.21:lte","linkKeyDisplay":"172.16.255.16 (lte) - 172.16.255.21 (lte)","asystem-ip":"172.16.255.16","bhost-name":"vm11","lastupdated":"1642494861369","bsite-id":"100","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.21","ahost-name":"vm6","adeviceId":"172.16.255.16","asite-id":"600","bsystem-ip":"172.16.255.21"},{"linkKey":"172.16.255.15:lte - 172.16.255.16:lte","linkKeyDisplay":"172.16.255.15 (lte) - 172.16.255.16 (lte)","asystem-ip":"172.16.255.15","bhost-name":"vm6","lastupdated":"1642975004139","bsite-id":"600","color1":"lte","bpersonality":"vedge","state":"up","color2":"lte","apersonality":"vedge","bdeviceId":"172.16.255.16","ahost-name":"vm5","adeviceId":"172.16.255.15","asite-id":"500","bsystem-ip":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/bfd/sessions":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get list of BFD sessions from vManage (Real Time)","operationId":"createBFDSessions","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-color","in":"query","description":"Source color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"region-type","in":"query","description":"Region type","schema":{"type":"string","enum":["core","access"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD sessions":{"description":"BFD sessions","value":{"data":[{"src-ip":"10.101.3.3","dst-ip":"10.101.2.2","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.1","dst-port":12426,"site-id":2,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.1-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000},{"src-ip":"10.101.3.3","dst-ip":"10.101.4.4","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.3","dst-port":12386,"site-id":4,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.3-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000},{"src-ip":"10.101.3.3","dst-ip":"10.102.5.5","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.4","dst-port":12386,"site-id":5,"transitions":3,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:01:31:46","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.4-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642577820000},{"src-ip":"10.101.3.3","dst-ip":"10.102.6.6","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.5","dst-port":12386,"site-id":6,"transitions":2,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:01:36:07","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.5-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642577520000},{"src-ip":"10.101.3.3","dst-ip":"10.102.16.16","color":"default","vdevice-name":"169.254.10.10","src-port":12346,"system-ip":"172.16.254.16","dst-port":12386,"site-id":16,"transitions":1,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:14:04:10","detect-multiplier":"7","vdevice-dataKey":"169.254.10.10-default-172.16.254.16-default-ipsec","proto":"ipsec","lastupdated":1642583341666,"state":"up","tx-interval":1000,"uptime-date":1642532640000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/sites/detail":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get detailed BFD site details","operationId":"getBFDSiteStateDetail","parameters":[{"name":"state","in":"query","description":"State","schema":{"type":"string","enum":["siteup","sitedown","sitepartial"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD site detail: state=siteup":{"description":"BFD site detail: state=siteup","value":{"data":[{"bfdSessions":"5","site-id":"4","device-type":"vedge","uuid":"4125a7b2-65cd-43c5-a393-cba53ebcdc00","lastupdated":1648413952287,"reachability":"reachable","device-model":"vedge-cloud","version":"20.3.4-542","system-ip":"169.254.10.11","uptime-date":1646298000000,"controlConnections":"3","host-name":"vm4","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.3","board-serial":"12345709"},{"bfdSessions":"5","site-id":"16","device-type":"vedge","uuid":"CSR-aec2123c-f20b-4876-b9ac-ae1dba561fb5","lastupdated":1648416356665,"reachability":"reachable","device-model":"vedge-CSR-1000v","version":"17.03.06.0.6691","system-ip":"169.254.10.14","uptime-date":1647300780000,"controlConnections":"3","host-name":"vm16","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.16","board-serial":"1234570F"},{"bfdSessions":"5","site-id":"5","device-type":"vedge","uuid":"C8K-d721a892-1cc1-4a30-9d17-98387348e2d4","lastupdated":1648418760239,"reachability":"reachable","device-model":"vedge-C8000V","version":"17.06.03.0.3496","system-ip":"169.254.10.12","uptime-date":1646298240000,"controlConnections":"3","host-name":"vm5","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.4","board-serial":"1234570A"},{"bfdSessions":"5","site-id":"2","device-type":"vedge","uuid":"f713e867-4376-45f1-8ecf-7c5fbe2be2f8","lastupdated":1648453581214,"reachability":"reachable","device-model":"vedge-cloud","version":"20.8.0-218","system-ip":"169.254.10.9","uptime-date":1648060560000,"controlConnections":"3","host-name":"vm2","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.1","board-serial":"12345707"},{"bfdSessions":"5","site-id":"6","device-type":"vedge","uuid":"C8K-47924f4e-0029-4693-a3df-986cb132437f","lastupdated":1648413353813,"reachability":"reachable","device-model":"vedge-C8000V","version":"17.08.01.0.1034","system-ip":"169.254.10.13","uptime-date":1646298240000,"controlConnections":"3","host-name":"vm6","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.254.5","board-serial":"1234570B"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/sites/summary":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get BFD site summary","operationId":"getBFDSitesSummary","parameters":[{"name":"isCached","in":"query","description":"Flag for caching","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","description":"Filter VPN","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD site summary":{"description":"BFD site summary","value":{"data":[{"count":6,"detailsURL":"","status":"error","statusList":[{"name":"Full WAN Connectivity","status":"up","message":"6 Full WAN Connectivity","detailsURL":"/dataservice/device/bfd/sites/detail?state=siteup","count":6},{"name":"Partial WAN Connectivity","status":"warning","message":"0 Partial WAN Connectivity","detailsURL":"/dataservice/device/bfd/sites/detail?state=sitepartial","count":0},{"name":"No WAN Connectivity","status":"down","message":"0 No WAN Connectivity","detailsURL":"/dataservice/device/bfd/sites/detail?state=sitedown","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,System-read,System-write"}},"/device/bfd/state/device":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD state summary","operationId":"getDeviceBFDStateSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD state summary":{"description":"BFD state summary","value":{"data":[{"site-id":400,"color":"lte","vmanage-system-ip":"172.16.255.11","local-color":"lte","local-if-desc":"","vdevice-dataKey":"172.16.255.11-lte-172.16.255.14-lte-ipsec","tx-interval":1000,"vdevice-host-name":"vm1","transitions":0,"proto":"ipsec","lastupdated":1642663028239,"state":"up","uptime-date":1642663020000,"dst-port":12366,"system-ip":"172.16.255.14","dst-ip":"10.1.14.14","remote-if-desc":"","createTimeStamp":1642494963368,"src-port":12347,"vdevice-name":"172.16.255.11","@rid":936,"detect-multiplier":"7","src-ip":"10.0.5.11","local-remote-ifname":"ge0/2-ge0/4"},{"site-id":600,"color":"lte","vmanage-system-ip":"172.16.255.11","local-color":"lte","local-if-desc":"","vdevice-dataKey":"172.16.255.11-lte-172.16.255.16-lte-ipsec","tx-interval":1000,"vdevice-host-name":"vm1","transitions":0,"proto":"ipsec","lastupdated":1642663028239,"state":"up","uptime-date":1642663020000,"dst-port":12366,"system-ip":"172.16.255.16","dst-ip":"10.1.16.16","remote-if-desc":"","createTimeStamp":1642494971424,"src-port":12347,"vdevice-name":"172.16.255.11","@rid":947,"detect-multiplier":"7","src-ip":"10.0.5.11","local-remote-ifname":"ge0/2-GigabitEthernet1"},{"site-id":500,"color":"lte","vmanage-system-ip":"172.16.255.11","local-color":"lte","local-if-desc":"","vdevice-dataKey":"172.16.255.11-lte-172.16.255.15-lte-ipsec","tx-interval":1000,"vdevice-host-name":"vm1","transitions":0,"proto":"ipsec","lastupdated":1642663028239,"state":"up","uptime-date":1642663020000,"dst-port":12346,"system-ip":"172.16.255.15","dst-ip":"10.1.15.15","remote-if-desc":"","createTimeStamp":1642657637570,"src-port":12347,"vdevice-name":"172.16.255.11","@rid":1004,"detect-multiplier":"7","src-ip":"10.0.5.11","local-remote-ifname":"ge0/2-GigabitEthernet1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/state/device/tloc":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD state summary with tloc color","operationId":"getDeviceBFDStateSummaryTloc","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD state summary with tloc":{"description":"BFD state summary with tloc","value":{"data":[{"local-color":["lte","dia"],"color":["lte","dia"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/state/device/tlocInterfaceMap":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device tloc color to Intf Mapping Relationship","operationId":"getDeviceTlocToIntfList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device tloc to intf mapping relationships":{"description":"Device tloc to intf mapping relationships","value":{"intfList":{"private1":"GigabitEthernet1","mpls":"GigabitEthernet2"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/device/bfd/status":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD status","operationId":"getDeviceBFDStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD status":{"description":"BFD status","value":{"data":[{"count":0,"statusList":[{"status":"up","count":0,"name":"up","color":"b0e276","detailsURL":"/dataservice/device/bfd/links?state=up","detailView":"dialog","icon":"images/connection/connection-network-up.png"},{"status":"down","count":0,"name":"down","color":"fa7c7d","detailsURL":"/dataservice/device/bfd/links?state=down","detailView":"dialog","icon":"images/connection/connection-network-down.png"}],"name":"BFD","image":"images/bfd.png","detailsURL":"/dataservice/device/bfd/links","type":"bfd","detailView":"dialog"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/bfd/summary":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get BFD summary from device (Real Time)","operationId":"createBFDSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD summary":{"description":"BFD summary","value":{"data":[{"bfd-sessions-max":"22","vdevice-dataKey":"169.254.10.10","bfd-sessions-flap":"111","vdevice-name":"169.254.10.10","bfd-sessions-up":"5","lastupdated":1642641879344,"bfd-sessions-total":"5","poll-interval":"600000","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/summary/device":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get device BFD status summary","operationId":"getDeviceBFDStatusSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD status summary":{"description":"BFD status summary","value":{"header":{"generatedOn":1646894919672,"title":"DataConnections"},"data":[{"name":"DataConnection","count":3,"detailsURL":"","status":"error","statusList":[{"name":"up","message":"3up","detailsURL":"/dataservice/device/bfd/sessions?deviceId=172.16.255.11&state=up","count":3}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/bfd/synced/sessions":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get list of BFD sessions from vManage synchronously","operationId":"createSyncedBFDSession","parameters":[{"name":"system-ip","in":"query","description":"System IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"Remote color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-color","in":"query","description":"Source color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BFD sessions":{"description":"BFD sessions","value":{"data":[{"src-ip":"10.0.5.11","dst-ip":"10.1.14.14","color":"lte","vdevice-name":"172.16.255.11","src-port":12347,"createTimeStamp":1646804370042,"system-ip":"172.16.255.14","dst-port":12366,"site-id":400,"transitions":0,"vdevice-host-name":"vm1","local-color":"lte","detect-multiplier":"7","vdevice-dataKey":"172.16.255.11-lte-172.16.255.14-lte-ipsec","@rid":1050,"vmanage-system-ip":"172.16.255.11","proto":"ipsec","lastupdated":1646893777827,"tx-interval":1000,"state":"up","uptime-date":1646893680000},{"src-ip":"10.0.5.11","dst-ip":"10.1.15.15","color":"lte","vdevice-name":"172.16.255.11","src-port":12347,"createTimeStamp":1646804372038,"system-ip":"172.16.255.15","dst-port":12366,"site-id":500,"transitions":0,"vdevice-host-name":"vm1","local-color":"lte","detect-multiplier":"7","vdevice-dataKey":"172.16.255.11-lte-172.16.255.15-lte-ipsec","@rid":1057,"vmanage-system-ip":"172.16.255.11","proto":"ipsec","lastupdated":1646893777827,"tx-interval":1000,"state":"up","uptime-date":1646893680000},{"src-ip":"10.0.5.11","dst-ip":"10.1.16.16","color":"lte","vdevice-name":"172.16.255.11","src-port":12347,"createTimeStamp":1646804374521,"system-ip":"172.16.255.16","dst-port":12366,"site-id":600,"transitions":0,"vdevice-host-name":"vm1","local-color":"lte","detect-multiplier":"7","vdevice-dataKey":"172.16.255.11-lte-172.16.255.16-lte-ipsec","@rid":1060,"vmanage-system-ip":"172.16.255.11","proto":"ipsec","lastupdated":1646893777827,"tx-interval":1000,"state":"up","uptime-date":1646893680000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/tloc":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get TLOC summary from device (Real Time)","operationId":"createTLOCSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TLOC summary":{"description":"TLOC summary","value":{"data":[{"sessions-flap":90,"if-name":"ge0/1","sessions-total":5,"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","lastupdated":1642641739756,"encap":"ipsec","sessions-up":5,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/bfd/tloc/detail":{"get":{"tags":["Real-Time Monitoring - BFD"],"description":"Get detailed BFD tloc details","operationId":"getBFDTlocStateDetail","parameters":[{"name":"state","in":"query","description":"State","schema":{"type":"string","enum":["up","down"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BFD tloc detail: state=up":{"description":"BFD tloc detail: state=up","value":{"data":[{"color":"lte","site-id":"4","system-ip":"169.254.10.11"},{"color":"mpls","site-id":"16","system-ip":"169.254.10.14"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/bgp/neighbors":{"get":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP neighbors list (Real Time)","operationId":"createBGPNeighborsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"peer-addr","in":"query","description":"Peer address","schema":{"type":"string"}},{"name":"as","in":"query","description":"AS number","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BGP neighbors list":{"description":"BGP neighbors list","value":{"data":[{"vdevice-name":"169.254.10.10","afi":"ipv4-unicast","vpn-id":10,"vdevice-host-name":"vm3","peer-addr":"20.20.20.20","as":200,"vdevice-dataKey":"169.254.10.10-10-20.20.20.20","msg-rcvd":0,"outQ":0,"afi-id":0,"lastupdated":1642657118366,"msg-sent":0,"state":"active"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/bgp/routes":{"get":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP routes list (Real Time)","operationId":"createBGPRoutesList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"nexthop","in":"query","description":"Next hop","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"BGP routes list":{"description":"BGP routes list","value":{"data":[{"vdevice-name":"172.16.255.15","prefix":"10.20.24.0/24","origin":"origin-incomplete","as-path":"10007","weight":"0","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"10.20.24.17","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-10.20.24.0/24","metric":"0","local-pref":"100","lastupdated":1646989331657,"path-status":"valid"},{"vdevice-name":"172.16.255.15","prefix":"10.20.24.0/24","origin":"origin-incomplete","weight":"32768","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"0.0.0.0","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-10.20.24.0/24","metric":"0","local-pref":"100","lastupdated":1646989331694,"path-status":"bestpathvalid"},{"vdevice-name":"172.16.255.15","prefix":"172.16.255.117/32","origin":"origin-incomplete","as-path":"10007","weight":"0","vpn-id":"1","vdevice-host-name":"vm5","nexthop":"10.20.24.17","afi-safi":"vpnv4-unicast","path-id":"0","vdevice-dataKey":"172.16.255.15-1-vpnv4-unicast-172.16.255.117/32","metric":"0","local-pref":"100","lastupdated":1646989331735,"path-status":"bestpathvalid"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/bgp/summary":{"get":{"tags":["Real-Time Monitoring - BGP"],"description":"Get BGP summary (Real Time)","operationId":"createBGPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"BGP summary":{"description":"BGP summary","value":{"data":[{"local-site-of-origin":"SoO:0:3","vdevice-dataKey":"169.254.10.10-10","bgp-router-identifier":"172.16.254.2","peer-memory":"4816","vdevice-name":"169.254.10.10","rib-memory":"0","lastupdated":1642657523957,"total-peers":"1","vpn-id":10,"vdevice-host-name":"vm3","rib-entries":"0","local-as":"100"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/blockSync":{"post":{"tags":["Monitoring - Device Details"],"description":"Set collection manager block set flag","operationId":"setBlockSync","parameters":[{"name":"blockSync","in":"query","description":"Block sync flag","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/bridge/interface":{"get":{"tags":["Real-Time Monitoring - Bridge"],"description":"Get device bridge interface list (Real Time)","operationId":"getBridgeInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bridge interface":{"description":"Device bridge interface","value":{"data":[{"ifindex":"13","vdevice-name":"10.0.0.121","oper-status":"up","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/0","admin-status":"up","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/0","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"14","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/1","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/1","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"15","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/2","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/2","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"16","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/3","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/3","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"},{"ifindex":"17","vdevice-name":"10.0.0.121","oper-status":"down","vdevice-host-name":"ISR4451-X","mtu":"1500","if-name":"GigabitEthernet0/3/4","admin-status":"down","vdevice-dataKey":"10.0.0.121-1-GigabitEthernet0/3/4","vlan":"1","native-vlan":"true","lastupdated":1650883014316,"bridge-id":"1","encap-type":"vlan"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/bridge/mac":{"get":{"tags":["Real-Time Monitoring - Bridge"],"description":"Get device bridge interface MAC (Real Time)","operationId":"getBridgeInterfaceMac","parameters":[{"name":"bridge-id","in":"query","description":"Bridge ID","schema":{"type":"string"}},{"name":"if-name","in":"query","description":"Interface name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"mac-address","in":"query","description":"MAC address","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bridge interface MAC":{"description":"Device bridge interface MAC","value":{"data":[{"if-name":"Ethernet-Internal2/0/0","mac-address":"58:bc:27:6d:c3:09","vdevice-dataKey":"10.0.0.121-1-Ethernet-Internal2/0/0-58:bc:27:6d:c3:09","vlan":"1","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1","interface":"GigabitEthernet0/3/0","type":"bridge-mac-type-dynamic","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","mac-address":"a4:4c:11:9e:03:d7","vdevice-dataKey":"10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:03:d7","vlan":"1","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1","interface":"GigabitEthernet0/3/0","type":"bridge-mac-type-dynamic","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","mac-address":"a4:4c:11:9e:1d:cc","vdevice-dataKey":"10.0.0.121-1-Ethernet-Internal2/0/0-a4:4c:11:9e:1d:cc","vlan":"1","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1","type":"bridge-mac-type-static","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","vdevice-dataKey":"10.0.0.121-1002-Ethernet-Internal2/0/0-","vlan":"1002","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1002","vdevice-host-name":"ISR4451-X"},{"if-name":"Ethernet-Internal2/0/0","vdevice-dataKey":"10.0.0.121-1003-Ethernet-Internal2/0/0-","vlan":"1003","vdevice-name":"10.0.0.121","lastupdated":1650882797794,"bridge-id":"1003","vdevice-host-name":"ISR4451-X"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/bridge/table":{"get":{"tags":["Real-Time Monitoring - Bridge"],"description":"Get device bridge interface table (Real Time)","operationId":"getBridgeInterfaceTable","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device bridge interface":{"description":"Device bridge interface","value":{"data":[{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":4,"routing-interface":"Vlan1","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1","vlan":"1","tx-octets":"0","tx-packets":"0","name":"default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1002","vlan":"1002","tx-octets":"0","tx-packets":"0","name":"fddi-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1002","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1003","vlan":"1003","tx-octets":"0","tx-packets":"0","name":"token-ring-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1003","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1004","vlan":"1004","tx-octets":"0","tx-packets":"0","name":"fddinet-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1004","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1005","vlan":"1005","tx-octets":"0","tx-packets":"0","name":"trnet-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1005","flood-octets":"0","tx-routed-packets":"0","age":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cedgecflowd/app-fwd-cflowd-flows":{"get":{"tags":["Monitoring - Cedge Cflowd"],"description":"Get list of app fwd cflowd flows from device","operationId":"createAppFwdCflowdFlowsList","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"vpn-id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"src-addr","in":"query","schema":{"type":"string"}},{"name":"dst-addr","in":"query","schema":{"type":"string"}},{"name":"app","in":"query","schema":{"type":"string"}},{"name":"family","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/cedgecflowd/app-fwd-cflowd-v6-flows":{"get":{"tags":["Monitoring - Cedge Cflowd"],"description":"Get list of app fwd cflowd v6 flows from device","operationId":"createAppFwdCflowdV6FlowsList","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"vpn-id","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"src-addr","in":"query","schema":{"type":"string"}},{"name":"dst-addr","in":"query","schema":{"type":"string"}},{"name":"app","in":"query","schema":{"type":"string"}},{"name":"family","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/cellular/connection":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular connection list from device","operationId":"createCellularConnectionList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular connection list":{"description":"Cellular connection list","value":[{"lastupdated":1649242617635,"cellular-interface":"Cellular0/1/0","active-profile":"1","cellular-packet-status":"packet-session-status-active","rx-packets":"20905","rx-bytes":"10301","tx-packets":"20905","tx-bytes":"10301","ipv4-addr":"29.29.29.105","ipv4-dns-pri":"8.0.0.8","ipv4-dns-sec":"4.4.4.4","ipv6-addr":"2001:a0:c::1a","ipv6-dns-pri":"2400:da00::6666","ipv6-dns-sec":"2400:da00::6666","scope":"scope","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/hardware":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular hardware list from device","operationId":"createHardwareList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular hardware list":{"description":"Cellular hardware list","value":[{"lastupdated":1649242617635,"cellular-interface":"Cellular0/1/0","cellular-firmware-build-time":"1649242617635","cellular-firmware-version":"1.0","cellular-hardware-version":"1.0","cellular-device-model":"HMOD1","cellular-imsi":"HUID1","cellular-imei":"imei","cellular-iccid":"iccid","cellular-msisdn":"msisdn","cellular-fsn":"fsn","cellular-modem-status":"active","cellular-modem-temperature":"16c","cellular-pri-skuid":"skuid","cellular-pri-version":"2.0","cellular-carrier":"carrier","cellular-oem-pri-version":"2.0","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/modem":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular modem list from device","operationId":"createModemList","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular modem list":{"description":"Cellular modem list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","model":"model","fw-version":"1.0","fw-date":"2022-04-18","fw-time":"1649242617635","fw-pkg-ver":"1.2","fw-pkg-carrier":"carrier","fw-pkg-pri":"pri","fw-pkg-subver":"subver","hw-version":"1.5","modem-status":"active","temperature":"16c","imsi":"imsi","imei":"imei","iccid":"iccid","msisdn":"msisdn","esn":"esn","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/network":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular network list from device","operationId":"createNetworkList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular network list":{"description":"Cellular network list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","reg-status":"status","roam-status":"status","domain-status":"status","mcc":"mcc","mnc":"mnc","nw-name":"name","emm-state":"state","emm-substate":"good","emm-connstate":"good","cellid":"cellid","tac":"tac","sid":"sid","nid":"nid","bid":"bid","lac":"lac","psc":"psc","bsic":"bsic","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/profiles":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular profile list from device","operationId":"createProfileList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular profile list":{"description":"Cellular profile list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","profile-id":"123","pdn-type":"type","apn":"apn","name":"name","auth":"auth","ip-addr":"172.16.255.15","primary-dns":"8.8.8.8","secondary-dns":"4.4.4.4","user-name":"uname","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/radio":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular radio list from device","operationId":"createRadioList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular radio list":{"description":"Cellular radio list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","band":123,"bandwidth":1000.2,"tx-channel":1,"rx-channel":2,"rssi":1,"rsrp":2,"rsrp-comment":"comment","rsrq":4,"rsrq-comment":"comment","snr":3.4,"snr-comment":"comment","ecio":"ecio","sinr":"sinr","io":"io","mode":"mode","band-class":"band class","channel":"unam123e","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/sessions":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular session list from device","operationId":"createSessionsList","parameters":[{"name":"if-name","in":"query","description":"Interface name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"ipv4-dns-pri","in":"query","description":"DNS primary IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular session list":{"description":"Cellular session list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","session-id":"123","data-bearer":"bearer","dormancy-state":"state","active-profile":1,"rx-packets":18,"rx-drops":15,"rx-errors":888,"rx-overflows":444,"rx-octets":235,"tx-packets":234,"tx-drops":234,"tx-errors":123,"tx-overflows":123,"tx-octets":123,"ipv4-addr":"172.16.255.15","ipv4-mask":"255.255.255.0","ipv4-gw":"192.168.0.1","ipv4-dns-pri":"8.8.8.8","ipv4-dns-sec":"4.4.4.4","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellular/status":{"get":{"tags":["Real-Time Monitoring - Cellular"],"description":"Get cellular status list from device","operationId":"getCellularStatusList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cellular status list":{"description":"Cellular status list","value":[{"lastupdated":1649242617635,"if-name":"Cellular0/1/0","modem-status":"status","sim-status":"status","signal-strength":"12","network-status":"health","last-seen-error":"last error","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/cellularEiolte/connections":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Connection Service"],"description":"Get cellular connection info from device","operationId":"getEiolteConnectionInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular connection info":{"description":"cellular connection info","value":[{"vdevice-name":"172.16.255.111","rx-errors":0,"cellular-interface-name":"Cellular 1/0","tx-errors":0,"sec-dns-ipv4-addr":"0.0.0.0","pri-dns-ipv4-addr":"8.8.8.8","tx-ofl":0,"connectivity":"Attach and Data","ipv4-address":"192.168.3.2","rx-ofl":0,"rx-pkts":42067,"apn":"internet","ipv6-prefix-length":"0","tx-pkts":36604,"ipv4-gateway-addr":"192.168.3.1","session-status":"Connected","pri-dns-ipv6-addr":"::","sec-dns-ipv6-addr":"::","vdevice-host-name":"CellularGateway","tx-drops":0,"rx-drops":0,"vdevice-dataKey":"172.16.255.111-1-1-","profile-id":1,"modem-index":"1","tx-bytes":10145490,"lastupdated":1649249750021,"ipv6-gw-prefix-length":"0","ipv6-gw-prefix":"::","rx-bytes":8887213,"ipv6-prefix":"::"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/hardware":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Hardware Service "],"description":"Get cellular hardware info from device","operationId":"getEiolteHardwareInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular hardware info":{"description":"cellular hardware info","value":[{"ICCID":"8952530306500032705","FSN":"4H0222009903AG","host-manufacturer":"Cisco Systems, Inc.","vdevice-name":"172.16.255.111","PRI-SKU-ID":"1104567","Modem-Status":"MODEM_STATE_DNS_ACQUIRED","cellular-interface-name":"Cellular 1/0","Firmware-Version":"SWIX55C_03.07.00.00 fef145 jenkins","host-software-version":"N/A","IMEI":"351735110100118","Model-ID":"EM9190","vdevice-host-name":"CellularGateway","vdevice-dataKey":"172.16.255.111-1-","Modem-Temperature":33,"PRI-Version":"030.018_000","IMSI":"001010123456063","OEM-PRI-Version":"001.021","modem-index":"1","Host-Firmware-Version":"SWIX55C_03.07.00.00 fef145 jenkins","lastupdated":1649250029516,"Carrier":"GENERIC","host-id":"N/A","host-model":"N/A"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/ipsec/interface/counters":{"get":{"tags":["Real-Time Monitoring - Cellular AON Ipsec Interface "],"description":"Get cellular ipsec interface info from device","operationId":"getAONIpsecInterfaceCountersInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular info":{"description":"cellular info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/ipsec/interface/session":{"get":{"tags":["Real-Time Monitoring - Cellular AON Ipsec Interface "],"description":"Get cellular ipsec interface info from device","operationId":"getAONIpsecInterfaceSessionnfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular info":{"description":"cellular info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/network":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Network Service"],"description":"Get cellular network info from device","operationId":"getEiolteNetworkInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular network info":{"description":"cellular network info","value":[{"Network-Selection-Mode":"Automatic","MNC":1,"vdevice-name":"172.16.255.111","cellular-interface-name":"Cellular 1/0","MCC":1,"vdevice-host-name":"CellularGateway","MTU":1500,"System-Time":"Thu Mar 24 3:6:0 2022","PS-State":"Attached","Roaming-Status":"Home","RRC-Connection-State":"RRC Connected","vdevice-dataKey":"172.16.255.111-1-","Network":"Test PLMN 1-1","EMM-State":"Registered","TAC":1,"Cell-ID":27447297,"modem-index":"1","lastupdated":1649250149676,"Current-Service":"Packet switched","Current-Service-status":"Normal","EMM-Sub-State":"Normal-Service"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/radio":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Connection Service"],"description":"Get cellular radio info from device","operationId":"getEiolteRadioInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular radio info":{"description":"cellular radio info","value":[{"Current-ENDC-RSRQ":"-11 dB","Current-ENDC-RSRP":"-71 dBm","vdevice-name":"172.16.255.111","LTE-Bandwidth":"20 MHz","cellular-interface-name":"Cellular 1/0","Offline-Reason":"Unknown","LTE-Rx-Channel-Number":18300,"Measured-ENDC-SINR":"36.0 dB","ENDC-active-downlink-channel":"632628","Low-Power-Reason":"Unknown","ENDC-active-band":"78","SNR":"30.0 dB","ENDC-Physical-CellId":"500","LTE-Band":1,"RSRP":"-60 dBm","Radio-Status":"online","ENDC-active-uplink-channel":"632628","RSRQ":"-7 dB","LTE-Tx-Channel-Number":300,"vdevice-host-name":"CellularGateway","RSSI":"-33 dBm","vdevice-dataKey":"172.16.255.111-1-","PCI":1,"ENDC-bandwidth":"50 MHz","modem-index":"1","lastupdated":1649250251234,"RAT-Selected":"LTE"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cellularEiolte/sim":{"get":{"tags":["Real-Time Monitoring - Cellular EIOLTE Sim Service"],"description":"Get cellular sim info from device","operationId":"getEiolteSimInfo","parameters":[{"name":"deviceId","in":"query","description":"Device Ip address, example:172.16.255.111","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"cellular sim info":{"description":"cellular sim info","value":[{"active-sim":0,"vdevice-dataKey":"172.16.255.111-1-","vdevice-name":"172.16.255.111","cellular-interface-name":"Cellular 1/0","sim-status-slot-0":"Present","modem-index":"1","sim-status-slot-1":"Not Present","lastupdated":1649250373414,"vdevice-host-name":"CellularGateway"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,System-read"}},"/device/cflowd/application/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get Cflowd DPI query field JSON","operationId":"getCflowdDPIDeviceFieldJSON","parameters":[{"name":"isDeviceDashBoard","in":"query","description":"Flag whether it is device dashboard request","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI query field in JSON":{"description":"DPI query field in JSON","value":{"header":{},"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false}]},{"property":"vpn_id","name":"VPN","isRequired":true,"multiSelect":false,"dataType":"int","fieldData":{"type":"url","url":"dataservice/device/action/vpn"}},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"isHidden":true,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/collector":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd collector list from device","operationId":"createCflowdCollectorList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cflowd collector list":{"description":"Cflowd collector list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/device/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get CflowdvDPI query field JSON","operationId":"getCflowdDPIFieldJSON","parameters":[{"name":"isDeviceDashBoard","in":"query","description":"Flag whether it is device dashboard request","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI query field in JSON":{"description":"DPI query field in JSON","value":[{"name":"Event Time","dataType":"date","isRequired":true,"property":"entry_time","options":[{"enableDateFields":false,"value":"Last 24 hours","key":"last_24_hours","number":"24"},{"enableDateFields":false,"value":"Last 12 hours","key":"last_12_hours","number":"12"},{"enableDateFields":false,"value":"Last 6 hours","key":"last_6_hours","number":"6"},{"enableDateFields":false,"value":"Last 3 hours","key":"last_3_hours","number":"3"},{"enableDateFields":false,"value":"Last 1 hour","key":"last_1_hour","number":"1"},{"enableDateFields":false,"value":"Last 7 days","key":"last_168_hours","number":"168"}],"fieldData":{"type":"dateList"}},{"dataType":"string","isRequired":true,"property":"dest_ip","multiSelect":false,"name":"Destination Ip"},{"dataType":"long","isRequired":true,"property":"dest_port","multiSelect":false,"name":"Destination port"},{"name":"Device name","dataType":"string","isRequired":true,"multiSelect":false,"property":"vdevice_name","isHidden":true}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/cflowd/flows":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get list of cflowd flows from device","operationId":"createCflowCollectorList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"src-ip","in":"query","description":"Source IP","schema":{"type":"string"}},{"name":"dest-ip","in":"query","description":"Destination IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cflowd flows list":{"description":"Cflowd flows list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/flows-count":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd flow count from device","operationId":"createCflowdFlowsCountList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"src-ip","in":"query","description":"Source IP","schema":{"type":"string"}},{"name":"dest-ip","in":"query","description":"Destination IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cflowd flow count":{"description":"Cflowd flow count","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/cache-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF cache stats from device","operationId":"getFnFCacheStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF cache stats":{"description":"FnF cache stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/export-client-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF export client stats from device","operationId":"getFnFExportClientStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF export client stats":{"description":"FnF export client stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/export-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF export stats from device","operationId":"getFnFExportStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF export stats":{"description":"FnF export stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/flow-monitor":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF from device","operationId":"getFnf","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF":{"description":"FnF","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/fnf/monitor-stats":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get FnF monitor stats from device","operationId":"getFnFMonitorStats","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FnF monitor stats":{"description":"FnF monitor stats","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/statistics":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd statistics from device","operationId":"createCflowdStatistics","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cflowd statistics":{"description":"Cflowd statistics","value":[{"model_sk":"None","state_description":"All daemons up","site-id":"200","version":"20.7.999-1133","local-system-ip":"172.16.255.22","timezone":"UTC","controlConnections":"7","domain-id":"0","total_cpu_count":"2","device-groups":["No groups"],"device-type":"vmanage","uuid":"b9944bb0-b10b-427a-8fb4-5d3b51eec679","lastupdated":1639105319291,"platform":"x86_64","state":"green","host-name":"vm12","uptime-date":1638953400000,"latitude":"37.666684","system-ip":"172.16.255.22","personality":"vmanage","status":"normal","board-serial":"12345963","validity":"valid","certificate-validity":"Valid","max-controllers":"0","device-model":"vmanage","deviceId":"172.16.255.22","layoutLevel":1,"testbed_mode":true,"device-os":"next","isDeviceGeoData":false,"connectedVManages":["172.16.255.22"],"longitude":"-122.777023","reachability":"reachable","statusOrder":4}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cflowd/template":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get cflowd template from device","operationId":"createCflowdTemplate","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cflowd template":{"description":"Cflowd template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/cfm/mp/database":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp database from device","operationId":"getMpDatabase","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp database":{"description":"Mp database","value":{"data":[{"defect":"defect-none","flag":"rmep-flag-none","vdevice-dataKey":"172.16.255.11","vdevice-name":"172.16.255.11","level":"7","service":"UNINET_VERLEANDROVALLE-17_5005","domain":"UNINET","local-mep-id":"1562","lastupdated":1648692601592,"remote-mep-id":"1561","vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cfm/mp/local/mep":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp local mep from device","operationId":"getMpLocalMep","parameters":[{"name":"domain","in":"query","description":"Domain Name","schema":{"type":"string"}},{"name":"service","in":"query","description":"Service Name","schema":{"type":"string"}},{"name":"mep-id","in":"query","description":"MEP ID","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp local mep":{"description":"Mp local mep","value":{"data":[{"svc-type":"cfm-svc-bd-vlan","offload-success":"false","vdevice-name":"172.16.255.11","level":"7","offload":"false","ccm-mode":"ccm-mode-multicast","dir":"mep-direction-down","vdevice-host-name":"vm1","svc-inst":"0","mep-id":"1562","vdevice-dataKey":"172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562","vlan":"112","port":"GigabitEthernet3","evc-name":"UNINET_VERLEANDROVALLE-17_5005","service":"UNINET_VERLEANDROVALLE-17_5005","ccm-state":"ccm-enabled","domain":"UNINET","lastupdated":1648692897652,"mac-addr":"52:54:00:fb:57:42"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cfm/mp/local/mip":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp local mip from device","operationId":"getMpLocalMip","parameters":[{"name":"level","in":"query","description":"Level","schema":{"type":"number"}},{"name":"port","in":"query","description":"Port","schema":{"type":"string"}},{"name":"svc-inst","in":"query","description":"Service Instance","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp local mip":{"description":"Mp local mip","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","level":"7","port":"GigabitEthernet3","svc-inst":"0","mac-addr":"52:54:00:fb:57:42","bd-id":"1562","svc-type":"cfm-svc-bd-vlan","source-static":"Dynamic","manual":"*","vdevice-dataKey":"172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562","lastupdated":1648692897652}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cfm/mp/remotemep":{"get":{"tags":["Real-Time Monitoring - CFM"],"description":"Get mp remote mep from device","operationId":"getMpRemoteMep","parameters":[{"name":"domain","in":"query","description":"Domain Name","schema":{"type":"string"}},{"name":"service","in":"query","description":"Service Name","schema":{"type":"string"}},{"name":"local-mep-id","in":"query","description":"Local MEP ID","schema":{"type":"number"}},{"name":"remote-mep-id","in":"query","description":"Remote MEP ID","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Mp remote mep":{"description":"Mp remote mep","value":{"data":[{"svc-type":"cfm-svc-bd-vlan","vdevice-name":"172.16.255.11","level":"7","remote-mep-id":"1561","if-status":"if-status-up","vdevice-host-name":"vm1","port-status":"port-status-up","svc-inst":"0","vdevice-dataKey":"172.16.255.11-UNINET-UNINET_VERLEANDROVALLE-17_5005-1562-1561","vlan":"112","evc-name":"UNINET_VERLEANDROVALLE-17_5005","service":"UNINET_VERLEANDROVALLE-17_5005","rdi":"false","domain":"UNINET","up-time":"2022-03-31T02:24:16.459+00:00","local-mep-id":"1562","lastupdated":1648693001718,"mac-addr":"52:54:00:aa:65:ba","ingress-if":"GigabitEthernet3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/cloudx/application/detail":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress applications from device (Real Time)","operationId":"createApplicationsDetailList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress applications detail":{"description":"Cloudexpress applications detail","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"office365","app-name":"Exchange","exit-type":"local","gateway-system-ip":"10.1.15.13","interface":"GigabitEthernet1","latency":1,"loss":5,"local-color":"lte","remote-color":"lte","vanalytics-score":11,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/applications":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress applications from device (Real Time)","operationId":"createApplicationsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress applications":{"description":"Cloudexpress applications","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"amazon_aws","exit-type":"gateway","gateway-system-ip":"10.1.15.13","interface":"GigabitEthernet1","latency":1,"loss":40,"local-color":"lte","remote-color":"lte","lastupdated":660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/gatewayexits":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress gateway exits from device (Real Time)","operationId":"createGatewayExitsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress gateway exits":{"description":"Cloudexpress gateway exits","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"amazon_aws","gateway-ip":"10.1.15.13","latency":1,"loss":0,"local-color":"lte","remote-color":"lte","lastupdated":660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/loadbalance":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress load balance applications from device (Real Time)","operationId":"createLbApplicationsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress load-balance applications-lb":{"description":"Cloudexpress load-balance applications-lb","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":10,"application":"office365","interface":"GigabitEthernet1","exit-type":"local","gateway-system-ip":"10.0.1.2","latency":1,"loss":5,"local-color":"lte","remote-color":"lte","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/cloudx/localexits":{"get":{"tags":["Real-Time Monitoring - CloudExpress"],"description":"Get list of cloudexpress local exits from device (Real Time)","operationId":"createLocalExitsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudexpress local exits":{"description":"Cloudexpress local exits","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":1,"application":"office365 ","interface":"GigabitEthernet1","latency":1,"loss":43,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/compliance":{"get":{"tags":["Compliance - Device Details"],"description":"Get compliance information for devices","operationId":"getComplianceDetails","parameters":[{"name":"offset","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":25}},{"name":"deviceType","in":"query","description":"deviceType example: vedge","schema":{"type":"array","items":{"type":"string","example":"[\"vedge\"]"}}},{"name":"status","in":"query","schema":{"type":"array","example":["RED"],"items":{"type":"string","example":"[\"RED\"]"}}},{"name":"type","in":"query","schema":{"type":"array","example":["vedge"],"items":{"type":"string","example":"[\"vedge\"]"}}},{"name":"sort_by","in":"query","schema":{"type":"string"},"example":"host-name"},{"name":"order_by","in":"query","schema":{"type":"string","enum":["asc","desc"]},"example":"asc"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceComplianceApiResponse"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetCompliance"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/compliance/summary":{"get":{"tags":["Compliance - Device Details"],"description":"Get compliance summary for devices","operationId":"getComplianceSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceComplianceSummaryResponse"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GetComplianceSummary"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/config":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device running configuration","operationId":"getDeviceRunningConfig","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Device running configuration":{"description":"Device running configuration"}}},"text/xml":{"schema":{"type":"string"},"examples":{"Device running configuration":{"description":"Device running configuration"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/config/html":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device running configuration in HTML format","operationId":"getDeviceRunningConfigHTML","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"text/html":{"schema":{"type":"string"},"examples":{"Device running configuration":{"description":"Device running configuration"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/device/configuration/commit-list":{"get":{"tags":["Real-Time Monitoring - Commit List"],"description":"Get device commit list","operationId":"getDeviceConfigurationCommitList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device commit list":{"description":"Device commit list","value":{"data":[{"time-stamp":"2022-03-1006:53:10","vdevice-dataKey":"172.16.255.11-0-10032","vdevice-name":"172.16.255.11","client":"system","lastupdated":1646900329409,"sn":"0","id":"10032","user":"system-vdaemon","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:48:02","vdevice-dataKey":"172.16.255.11-1-10031","vdevice-name":"172.16.255.11","client":"netconf","lastupdated":1646900329409,"sn":"1","id":"10031","user":"vmanage-admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:47:42","vdevice-dataKey":"172.16.255.11-2-10030","vdevice-name":"172.16.255.11","client":"cli","lastupdated":1646900329409,"sn":"2","id":"10030","user":"admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:28:31","vdevice-dataKey":"172.16.255.11-3-10026","vdevice-name":"172.16.255.11","client":"system","lastupdated":1646900329409,"sn":"3","id":"10026","user":"system-vdaemon","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:23:22","vdevice-dataKey":"172.16.255.11-4-10025","vdevice-name":"172.16.255.11","client":"netconf","lastupdated":1646900329409,"sn":"4","id":"10025","user":"vmanage-admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1006:02:22","vdevice-dataKey":"172.16.255.11-5-10024","vdevice-name":"172.16.255.11","client":"netconf","lastupdated":1646900329409,"sn":"5","id":"10024","user":"vmanage-admin","vdevice-host-name":"vm1"},{"time-stamp":"2022-03-1005:56:46","vdevice-dataKey":"172.16.255.11-6-10023","vdevice-name":"172.16.255.11","client":"system","lastupdated":1646900329409,"sn":"6","id":"10023","user":"system-vdaemon","vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/control/affinity/config":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get affinity config from device (Real Time)","operationId":"getAffinityConfig","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Affinity config":{"description":"Affinity config","value":{"data":[{"vdevice-dataKey":"169.254.10.10--0","vdevice-name":"169.254.10.10","affc-ccl":"0(2)Y","affc-equil":"Yes","affc-ecl":"0(2)","affc-index":"0","lastupdated":1642746599493,"affc-interface":"ge0/1","affc-last-resort":"No","vdevice-host-name":"vm3","affc-ervc":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/affinity/status":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get affinity status from device (Real Time)","operationId":"getAffinityStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Affinity status":{"description":"Affinity status","value":{"data":[{"affs-acc":"172.16.253.129(0),172.16.255.130(0)","vdevice-dataKey":"169.254.10.10--0","vdevice-name":"169.254.10.10","affs-index":"0","lastupdated":1642746754330,"vdevice-host-name":"vm3","affs-interface":"ge0/1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/connections":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from device (Real Time)","operationId":"createRealTimeConnectionList","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"domain-id":1,"instance":0,"vdevice-name":"169.254.10.10","behind-proxy":"No","system-ip":"172.16.253.129","remote-color":"default","site-id":129,"private-port":12346,"controller-group-id":0,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:05:55:35","peer-type":"vsmart","v-org-name":"vIPtela Inc Regression","protocol":"dtls","vdevice-dataKey":"169.254.10.10-0-default-172.16.253.129-default","public-ip":"10.103.129.129","public-port":12346,"lastupdated":1642727162594,"state":"up","private-ip":"10.103.129.129","uptime-date":1642705800000},{"domain-id":1,"instance":0,"vdevice-name":"169.254.10.10","behind-proxy":"No","system-ip":"172.16.255.130","remote-color":"default","site-id":130,"private-port":12346,"controller-group-id":0,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:05:55:35","peer-type":"vsmart","v-org-name":"vIPtela Inc Regression","protocol":"dtls","vdevice-dataKey":"169.254.10.10-0-default-172.16.255.130-default","public-ip":"10.103.130.130","public-port":12346,"lastupdated":1642727162594,"state":"up","private-ip":"10.103.130.130","uptime-date":1642705800000},{"domain-id":0,"instance":0,"vdevice-name":"169.254.10.10","behind-proxy":"No","system-ip":"169.254.10.3","remote-color":"default","site-id":202,"private-port":12346,"controller-group-id":0,"vdevice-host-name":"vm3","local-color":"default","uptime":"0:05:55:35","peer-type":"vmanage","v-org-name":"vIPtela Inc Regression","protocol":"dtls","vdevice-dataKey":"169.254.10.10-0-default-169.254.10.3-default","public-ip":"10.103.202.202","public-port":12346,"lastupdated":1642727162594,"state":"up","private-ip":"10.103.202.202","uptime-date":1642705800000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/connectionshistory":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections history list from device (Real Time)","operationId":"createConnectionHistoryListRealTime","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"0.0.0.0","remote-color":"default","site-id":0,"uuid":"d7e88eac-250c-4189-bc66-747615452ad9","peer-type":"vbond","protocol":"dtls","state":"tear_down","private-ip":"10.103.135.135","local_enum-desc":"Disconnect vBond after register reply.","domain-id":0,"rep-count":0,"index":0,"private-port":12346,"vdevice-host-name":"vm3","local-color":"default","downtime":"2022-01-20T19:10:43+0000","vdevice-dataKey":"169.254.10.10-0-0-2022-01-20T19:10:43+0000","public-ip":"10.103.135.135","downtime-date":1642705843000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISCVBD"},{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"169.254.10.3","remote-color":"default","site-id":202,"uuid":"387d8bf3-5306-41fe-9090-7ee61c91d9c3","peer-type":"vmanage","protocol":"dtls","state":"tear_down","private-ip":"10.103.202.202","local_enum-desc":"TLOC Disabled.","domain-id":0,"rep-count":0,"index":1,"private-port":12346,"vdevice-host-name":"vm3","local-color":"biz-internet","downtime":"2022-01-20T19:10:24+0000","vdevice-dataKey":"169.254.10.10-0-1-2022-01-20T19:10:24+0000","public-ip":"10.103.202.202","downtime-date":1642705824000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISTLOC"},{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"172.16.255.130","remote-color":"default","site-id":130,"uuid":"fca7532b-9366-466a-a8f9-79922392917b","peer-type":"vsmart","protocol":"dtls","state":"tear_down","private-ip":"10.103.130.130","local_enum-desc":"TLOC Disabled.","domain-id":1,"rep-count":0,"index":2,"private-port":12346,"vdevice-host-name":"vm3","local-color":"biz-internet","downtime":"2022-01-20T19:10:24+0000","vdevice-dataKey":"169.254.10.10-0-2-2022-01-20T19:10:24+0000","public-ip":"10.103.130.130","downtime-date":1642705824000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISTLOC"},{"instance":0,"vdevice-name":"169.254.10.10","remote_enum-desc":"No Error.","system-ip":"169.254.10.3","remote-color":"default","site-id":202,"uuid":"387d8bf3-5306-41fe-9090-7ee61c91d9c3","peer-type":"vmanage","protocol":"dtls","state":"tear_down","private-ip":"10.103.202.202","local_enum-desc":"TLOC Disabled.","domain-id":0,"rep-count":0,"index":5,"private-port":12346,"vdevice-host-name":"vm3","local-color":"default","downtime":"2022-01-20T19:09:22+0000","vdevice-dataKey":"169.254.10.10-0-5-2022-01-20T19:09:22+0000","public-ip":"10.103.202.202","downtime-date":1642705762000,"remote_enum":"NOERR","public-port":12346,"lastupdated":1642727714927,"local_enum":"DISTLOC"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/connectionsinfo":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from device (Real Time)","operationId":"createRealTimeConnectionList_1","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"vdevice-dataKey":"172.16.255.11---","vdevice-name":"172.16.255.11","rate":"Per-Control Connection Rate: 300 pps","lastupdated":1646962973344,"vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/count":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get number of vedges and vsmart device in different control states","operationId":"getTotalCountForDeviceStates","parameters":[{"name":"isCached","in":"query","description":"Device State cached","schema":{"type":"boolean","default":false}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device state count":{"description":"Device state count","value":{"data":[{"name":"ControlStatus","count":7,"detailsURL":"","status":"error","statusList":[{"name":"Controlup","status":"up","message":"devicesup","detailsURL":"/dataservice/device/control/networksummary?state=up","count":7},{"name":"Partial","status":"warning","message":"devicesdown","detailsURL":"/dataservice/device/control/networksummary?state=partial","count":0},{"name":"Controldown","status":"error","message":"devicesdown","detailsURL":"/dataservice/device/control/networksummary?state=down","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/links":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list","operationId":"createLinkList","parameters":[{"name":"state","in":"query","description":"Device State","required":true,"schema":{"type":"string","example":"up"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"state":"up","color1":"default","color2":"default","lastupdated":"1646912547015","linkKey":"172.16.255.19:default-172.16.255.26:default","linkKeyDisplay":"172.16.255.19(default)-172.16.255.26(default)","adeviceId":"172.16.255.26","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.26","bsystem-ip":"172.16.255.19","asite-id":"--","bsite-id":"100","ahost-name":"vm16","bhost-name":"vm9","apersonality":"vbond","bpersonality":"vsmart"},{"state":"up","color1":"default","color2":"default","lastupdated":"1646912512113","linkKey":"172.16.255.20:default-172.16.255.26:default","linkKeyDisplay":"172.16.255.20(default)-172.16.255.26(default)","adeviceId":"172.16.255.26","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.26","bsystem-ip":"172.16.255.20","asite-id":"--","bsite-id":"200","ahost-name":"vm16","bhost-name":"vm10","apersonality":"vbond","bpersonality":"vsmart"},{"state":"up","color1":"default","color2":"default","lastupdated":"1646912347752","linkKey":"172.16.255.22:default-172.16.255.26:default","linkKeyDisplay":"172.16.255.22(default)-172.16.255.26(default)","adeviceId":"172.16.255.26","bdeviceId":"172.16.255.22","asystem-ip":"172.16.255.26","bsystem-ip":"172.16.255.22","asite-id":"--","bsite-id":"200","ahost-name":"vm16","bhost-name":"vm12","apersonality":"vbond","bpersonality":"vmanage"},{"state":"up","color1":"lte","color2":"default","lastupdated":"1646912547013","linkKey":"172.16.255.14:lte-172.16.255.19:default","linkKeyDisplay":"172.16.255.14(lte)-172.16.255.19(default)","adeviceId":"172.16.255.14","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.14","bsystem-ip":"172.16.255.19","asite-id":"400","bsite-id":"100","ahost-name":"vm4","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","color1":"lte","color2":"default","lastupdated":"1646912512112","linkKey":"172.16.255.14:lte-172.16.255.20:default","linkKeyDisplay":"172.16.255.14(lte)-172.16.255.20(default)","adeviceId":"172.16.255.14","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.14","bsystem-ip":"172.16.255.20","asite-id":"400","bsite-id":"200","ahost-name":"vm4","bhost-name":"vm10","apersonality":"vedge","bpersonality":"vsmart"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/localproperties":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get local properties list (Real Time)","operationId":"createLocalPropertiesListListRealTIme","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Local properties list":{"description":"Local properties list","value":{"data":[{"certificate-not-valid-before":"Jan 26 07:37:47 2022 GMT","site-id":"100","protocol":"dtls","root-ca-chain-status":"Installed","certificate-not-valid-after":"Jan 26 07:37:47 2023 GMT","dns-name":"vbond","vdevice-host-name":"vm1","port-hopped":"TRUE","device-role":"edge-router","certificate-status":"Installed","device-type":"vedge","uuid":"a555e577-d513-4768-a695-93574a15f5cc","sp-organization-name":"vIPtela Inc Regression","lastupdated":1643348428058,"region-id-set":"N/A","keygen-interval":"1:00:00:00","domain-id":"1","time-since-port-hop":"1:21:43:52","system-ip":"172.16.255.11","board-serial":"12346580","certificate-validity":"Valid","max-controllers":"0","tls-port":"0","organization-name":"vIPtela Inc Regression","vdevice-name":"172.16.255.11","vsmart-list-version":"0","number-vbond-peers":"0","vdevice-dataKey":"172.16.255.11","token":"Invalid","number-active-wan-interfaces":"1","register-interval":"0:00:00:30","retry-interval":"0:00:00:15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/networksummary":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get list of unreachable devices","operationId":"networkSummary","parameters":[{"name":"state","in":"query","description":"Device State","schema":{"type":"string","example":"up"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"list of unreachable devices":{"description":"list of unreachable devices","value":{"data":[{"device-model":"vedge-cloud","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.21","system-ip":"172.16.255.21","host-name":"vm11","site-id":"100","version":"20.9.999-1766","uuid":"2b57ef1a-5eb2-4d8d-8676-cce19b56b26b","board-serial":"12345962","bfdSessions":"3","device-type":"vedge","lastupdated":1646917368708,"reachability":"reachable","controlConnections":"3","uptime-date":1646908860000,"controlConnectionsToVsmarts":"2"},{"device-model":"vedge-cloud","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.11","system-ip":"172.16.255.11","host-name":"vm1","site-id":"100","version":"20.9.999-1766","uuid":"84d1ab4e-0cbf-4369-a290-08fafeb80f95","board-serial":"12345974","bfdSessions":"3","device-type":"vedge","lastupdated":1646967284462,"reachability":"reachable","controlConnections":"3","uptime-date":1646909100000,"controlConnectionsToVsmarts":"2"},{"device-model":"vsmart","ompPeers":"6","number-vsmart-peers":1,"local-system-ip":"172.16.255.19","system-ip":"172.16.255.19","host-name":"vm9","site-id":"100","version":"20.9.999-1766","uuid":"9abd3af9-9087-497d-8b99-8fd0a7baa3f2","board-serial":"12345967","device-type":"vsmart","lastupdated":1646967277159,"reachability":"reachable","controlConnections":"9","uptime-date":1646908920000,"controlConnectionsToVsmarts":"1"},{"device-model":"vsmart","ompPeers":"6","number-vsmart-peers":1,"local-system-ip":"172.16.255.20","system-ip":"172.16.255.20","host-name":"vm10","site-id":"200","version":"20.9.999-1766","uuid":"43ba3223-9df7-4cc9-a059-a12e5382d79d","board-serial":"12345961","device-type":"vsmart","lastupdated":1646967275863,"reachability":"reachable","controlConnections":"9","uptime-date":1646908860000,"controlConnectionsToVsmarts":"1"},{"device-model":"vedge-cloud","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.14","system-ip":"172.16.255.14","host-name":"vm4","site-id":"400","version":"20.9.999-1766","uuid":"a66335c5-451f-4b93-a752-4116d688f347","board-serial":"12345970","bfdSessions":"4","device-type":"vedge","lastupdated":1646967282559,"reachability":"reachable","controlConnections":"3","uptime-date":1646908980000,"controlConnectionsToVsmarts":"2"},{"device-model":"vedge-C8000V","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.15","system-ip":"172.16.255.15","host-name":"vm5","site-id":"500","version":"17.09.01.0.154453","uuid":"C8K-8bda7a5d-6b75-47ec-a658-b30ca54e30eb","board-serial":"12345703","bfdSessions":"4","device-type":"vedge","lastupdated":1646967275462,"reachability":"reachable","controlConnections":"3","uptime-date":1646909400000,"controlConnectionsToVsmarts":"2"},{"device-model":"vedge-C8000V","ompPeers":"2","number-vsmart-peers":2,"local-system-ip":"172.16.255.16","system-ip":"172.16.255.16","host-name":"vm6","site-id":"600","version":"17.09.01.0.154453","uuid":"C8K-46aa4ddc-7468-45c2-9144-2d60c2f553f3","board-serial":"12345702","bfdSessions":"4","device-type":"vedge","lastupdated":1646967277103,"reachability":"reachable","controlConnections":"3","uptime-date":1646909400000,"controlConnectionsToVsmarts":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/regionconnections":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from device (Real Time)","operationId":"createRealTimeRegionConnectionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Region Connections list":{"description":"Region Connections list","value":"{\t\"data\":[\t\t{\t\t\t\"instance\":0,\t\t\t\"site-id\":129,\t\t\t\"domain-id\":1,\t\t\t\"vdevice-name\":\"169.254.10.10\",\t\t\t\"vdevice-host-name\":\"vm3\",\t\t\t\"local-private-ip\":\"10.103.129.129\",\t\t\t\"local-private-port\":12346,\t\t\t\"public-ip\":\"10.103.129.129\",\t\t\t\"public-port\":12346,\t\t\t\"region-idx\":1,\t\t\t\"peer-system-ip\":\"172.16.253.129\",\t\t\t\"color\":\"default\",\t\t\t\"lastupdated\":1642727162594,\t\t}\t]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/statistics":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connection statistics from device (Real Time)","operationId":"getConnectionStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection statistics":{"description":"Connection statistics","value":{"data":[{"rx_challenge":"14","challenge_failures":"0","vdevice-name":"169.254.10.10","tx_dtls_handshake":"21","tx_register_replies":"0","rx_challenge_ack":"14","tx_octets":"24918292","rx_registers":"0","tx_dtls_handshake_failures":"7","tx_vmanage_to_peer":"0","tx_pkts":"330231","tx_blocked":"0","tx_dtls_handshake_done":"14","rx_octets":"50924456","tx_error":"0","bid_failures_needing_reset":"0","rx_error":"0","rx_dtls_handshake_done":"0","tx_challenge_ack_error":"0","rx_challenge_resp":"0","tx_challenge_error":"0","tx_challenge_resp_error":"0","tx_register_to_vmanage":"4","tx_challenge":"0","rx_connects":"0","tx_registers":"15","rx_pkts":"347847","tx_connects":"0","tx_challenge_gen_error":"0","rx_register_to_vmanage":"0","vdevice-host-name":"vm3","tx_hello":"212412","tx_challenge_ack":"0","rx_hello":"212399","tx_challenge_resp":"14","rx_dtls_handshake":"0","vdevice-dataKey":"169.254.10.10","lastupdated":1642730071268,"rx_dtls_handshake_failures":"0","rx_register_replies":"15","rx_vmanage_to_peer":"4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/status":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get local device status","operationId":"getLocalDeviceStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Local device status":{"description":"Local device status","value":{"data":[{"type":"control","name":"Control","image":"images/control.png","count":0,"detailView":"dialog","detailsURL":"/dataservice/device/control/links","statusList":[{"status":"up","icon":"images/connection/connection-network-up.png","color":"b0e276","name":"up","detailView":"dialog","detailsURL":"/dataservice/device/control/links?state=up","count":0},{"status":"down","icon":"images/connection/connection-network-down.png","color":"fa7c7d","name":"down","detailView":"dialog","detailsURL":"/dataservice/device/control/links?state=down","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/summary":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections summary from device (Real Time)","operationId":"createConnectionsSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections summary":{"description":"Connections summary","value":{"data":[{"instance":0,"vdevice-dataKey":"172.16.255.14-0","vdevice-name":"172.16.255.14","vmanage_counts":1,"lastupdated":1588603863504,"vsmart_counts":2,"vbond_counts":0,"vdevice-host-name":"vm4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/summary/device":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get device control status summary","operationId":"getDeviceControlStatusSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device control status summary":{"description":"Device control status summary","value":{"data":[{"name":"ControlConnection","count":3,"detailsURL":"","status":"error","statusList":[{"name":"up","message":"3up","detailsURL":"/dataservice/device/control/connection?deviceId=172.16.255.11&state=up","count":3}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/control/synced/connections":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get connections list from vManage","operationId":"createSyncedConnectionList","parameters":[{"name":"peer-type","in":"query","description":"Peer type","schema":{"type":"string","enum":["vedge","vsmart","vmanage","vbond"]}},{"name":"system-ip","in":"query","description":"Peer system IP","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connections list":{"description":"Connections list","value":{"data":[{"instance":0,"vdevice-name":"172.16.255.11","system-ip":"172.16.255.19","remote-color":"default","site-id":100,"controller-group-id":0,"peer-type":"vsmart","shared-region-id-set":"N/A","protocol":"dtls","@rid":1060,"state":"up","private-ip":"10.0.5.19","domain-id":1,"behind-proxy":"No","createTimeStamp":1646912557634,"private-port":12455,"vdevice-host-name":"vm1","local-color":"lte","v-org-name":"vIPtelaIncRegression","vdevice-dataKey":"172.16.255.11-0-lte-172.16.255.19-default","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.5.19","public-port":12455,"lastupdated":1646967283468,"uptime-date":1646967180000},{"instance":0,"vdevice-name":"172.16.255.11","system-ip":"172.16.255.20","remote-color":"default","site-id":200,"controller-group-id":0,"peer-type":"vsmart","shared-region-id-set":"N/A","protocol":"dtls","@rid":1063,"state":"up","private-ip":"10.0.12.20","domain-id":1,"behind-proxy":"No","createTimeStamp":1646912560801,"private-port":12456,"vdevice-host-name":"vm1","local-color":"lte","v-org-name":"vIPtelaIncRegression","vdevice-dataKey":"172.16.255.11-0-lte-172.16.255.20-default","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.12.20","public-port":12456,"lastupdated":1646967283468,"uptime-date":1646967180000},{"instance":0,"vdevice-name":"172.16.255.11","system-ip":"172.16.255.22","remote-color":"default","site-id":200,"controller-group-id":0,"peer-type":"vmanage","protocol":"dtls","@rid":1068,"state":"up","private-ip":"10.0.12.22","domain-id":0,"behind-proxy":"No","createTimeStamp":1646912562214,"private-port":12446,"vdevice-host-name":"vm1","local-color":"lte","v-org-name":"vIPtelaIncRegression","vdevice-dataKey":"172.16.255.11-0-lte-172.16.255.22-default","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.12.22","public-port":12446,"lastupdated":1646967283468,"uptime-date":1646967180000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/control/synced/localproperties":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get local properties list","operationId":"createLocalPropertiesSyncedList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Local properties list":{"description":"Local properties list","value":{"data":[{"retry-interval":"0:00:00:16","vdevice-name":"172.16.255.11","device-role":"edge-router","tls-port":"0","max-controllers":"0","system-ip":"172.16.255.11","certificate-not-valid-before":"Mar1011:16:192022GMT","site-id":"100","certificate-not-valid-after":"Mar1011:16:192023GMT","uuid":"84d1ab4e-0cbf-4369-a290-08fafeb80f95","number-active-wan-interfaces":"1","protocol":"dtls","board-serial":"12345974","vsmart-list-version":"0","@rid":1071,"certificate-status":"Installed","device-type":"vedge","port-hopped":"TRUE","organization-name":"vIPtelaIncRegression","domain-id":"1","root-ca-chain-status":"Installed","dns-name":"vbond","createTimeStamp":1646912563392,"sp-organization-name":"vIPtelaIncRegression","vdevice-host-name":"vm1","register-interval":"0:00:00:30","token":"Invalid","keygen-interval":"1:00:00:00","vdevice-dataKey":"172.16.255.11","certificate-validity":"Valid","vmanage-system-ip":"172.16.255.11","lastupdated":1646963388706,"number-vbond-peers":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/synced/waninterface":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get WAN interface list","operationId":"createWanInterfaceSyncedList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"WAN interface list":{"description":"WAN interface list","value":{"data":[{"instance":0,"low-bandwidth-link":"No","color":"lte","vdevice-name":"172.16.255.11","nat-type":"N","admin-state":"up","interface":"ge0/2","restrict-str":"no","@rid":1077,"private-ipv6":"::","private-ip":"10.0.5.11","per-wan-max-controllers":2,"num-vsmarts":2,"num-vmanages":1,"preference":"0","createTimeStamp":1646912567192,"weight":1,"index":0,"private-port":12407,"vdevice-host-name":"vm1","vbond-as-stun-server":"no","control-str":"yes","carrier":"default","last-resort":"No","vdevice-dataKey":"172.16.255.11-0-0","vmanage-connection-preference":"5","vmanage-system-ip":"172.16.255.11","public-ip":"10.0.5.11","operation-state":"up","public-port":12407,"region-id":"Default","lastupdated":1646967283812,"wan-port-hopped":"TRUE"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/validdevices":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get vmanage valid device list (Real Time)","operationId":"createValidDevicesListRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":{"data":[{"chassis-number":"00D132A6-F3D2-40BA-862B-A6D1A83EFAEA","vdevice-dataKey":"172.16.255.22-00D132A6-F3D2-40BA-862B-A6D1A83EFAEA-12346574","vdevice-name":"172.16.255.22","serial-number":"12346574","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F","vdevice-dataKey":"172.16.255.22-C8K-299C77FA-B7B2-4644-BCF1-E15BC635194F-12345703","vdevice-name":"172.16.255.22","serial-number":"12345703","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7","vdevice-dataKey":"172.16.255.22-C8K-9150A7F6-73E6-45BD-B14E-0A8F98A580F7-12345705","vdevice-name":"172.16.255.22","serial-number":"12345705","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-A9DF16AA-14C2-4B60-8D65-05957111879E","vdevice-dataKey":"172.16.255.22-C8K-A9DF16AA-14C2-4B60-8D65-05957111879E-12345967","vdevice-name":"172.16.255.22","serial-number":"12345967","lastupdated":1649645323938,"vdevice-host-name":"vm12"},{"chassis-number":"C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A","vdevice-dataKey":"172.16.255.22-C8K-D6E53254-74C7-4504-B8A7-50FBBC37073A-12345707","vdevice-name":"172.16.255.22","serial-number":"12345707","lastupdated":1649645323938,"vdevice-host-name":"vm12"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/validvmanageid":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get valid vManage from device (Real Time)","operationId":"getValidVManageIdRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage":{"description":"vManage","value":{"data":[{"chassis-number":"387d8bf3-5306-41fe-9090-7ee61c91d9c3","vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1642746085123,"vdevice-host-name":"vm3"},{"chassis-number":"59ddeeef-24ad-4bd3-9e55-f9760b640970","vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1642746085123,"vdevice-host-name":"vm3"},{"chassis-number":"c0fd955c-7e0d-4b90-9626-55684f69a899","vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1642746085123,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/validvsmarts":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get valid vSmart list from device (Real Time)","operationId":"createValidVSmartsListRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart list":{"description":"vSmart list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-12345701","vdevice-name":"169.254.10.10","serial-number":"12345701","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345702","vdevice-name":"169.254.10.10","serial-number":"12345702","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345703","vdevice-name":"169.254.10.10","serial-number":"12345703","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345704","vdevice-name":"169.254.10.10","serial-number":"12345704","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345705","vdevice-name":"169.254.10.10","serial-number":"12345705","lastupdated":1642743541771,"vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-12345706","vdevice-name":"169.254.10.10","serial-number":"12345706","lastupdated":1642743541771,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/waninterface":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get WAN interface list (Real Time)","operationId":"createWanInterfaceListList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"WAN interface list":{"description":"WAN interface list","value":{"data":[{"instance":0,"low-bandwidth-link":"No","color":"default","vdevice-name":"169.254.10.10","nat-type":"N","admin-state":"up","interface":"ge0/1","restrict-str":"no","private-ipv6":"::","private-ip":"10.101.3.3","per-wan-max-controllers":2,"num-vsmarts":2,"num-vmanages":1,"preference":"0","wan-time-since-port-hop":"0:11:14:02","spi-change":"0:00:45:59","index":0,"weight":1,"private-port":12386,"last-conn-time":"0:11:13:42","vbond-as-stun-server":"no","vdevice-host-name":"vm3","control-str":"yes","carrier":"default","vmanage-connection-preference":"5","last-resort":"No","vdevice-dataKey":"169.254.10.10-0-0","public-ip":"10.101.3.3","operation-state":"up","public-port":12386,"lastupdated":1642746267569,"last-conn-time-date":1642705800000,"wan-port-hopped":"TRUE"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/control/waninterface/color":{"get":{"tags":["Real-Time Monitoring - Device Control"],"description":"Get port hop colors","operationId":"getPortHopColor","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device port hop colors":{"description":"Device port hop colors","value":{"data":[{"color":"lte"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/counters":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device counters","operationId":"getDeviceCounters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCountersResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/crashlog":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash logs from device","operationId":"getDeviceCrashLogs","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device crash logs":{"description":"Device crash logs","value":{"data":[{"core-time":"Tue Feb 15 04:14:38 UTC 2022","vdevice-dataKey":"169.254.10.12-0","vdevice-name":"169.254.10.12","index":0,"lastupdated":1645064726542,"core-filename":"vm5_htx_19219_20220215-041430-UTC.core.gz","core-time-date":1644898478000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 04:15:24 UTC 2022","vdevice-dataKey":"169.254.10.12-1","vdevice-name":"169.254.10.12","index":1,"lastupdated":1645064726542,"core-filename":"vm5_htx_19539_20220215-041515-UTC.core.gz","core-time-date":1644898524000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 05:55:04 UTC 2022","vdevice-dataKey":"169.254.10.12-2","vdevice-name":"169.254.10.12","index":2,"lastupdated":1645064726542,"core-filename":"vm5_htx_30530_20220215-055452-UTC.core.gz","core-time-date":1644904504000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 05:55:50 UTC 2022","vdevice-dataKey":"169.254.10.12-3","vdevice-name":"169.254.10.12","index":3,"lastupdated":1645064726542,"core-filename":"vm5_htx_31380_20220215-055542-UTC.core.gz","core-time-date":1644904550000,"vdevice-host-name":"vm5"},{"core-time":"Tue Feb 15 06:21:52 UTC 2022","vdevice-dataKey":"169.254.10.12-4","vdevice-name":"169.254.10.12","index":4,"lastupdated":1645064726542,"core-filename":"vm5_htx_26426_20220215-062140-UTC.core.gz","core-time-date":1644906112000,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write,dca"}},"/device/crashlog/details":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash logs for all device","operationId":"getAllDeviceCrashLogs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device crash logs":{"description":"Device crash logs","value":{"data":[{"core-time":"MonMay908:25:21UTC2022","vdevice-name":"172.16.255.11","index":8,"lastupdated":1652085255804,"core-filename":"vm1-system-report_20220509-082507-UTC.tar.gz","core-time-date":1652084721000,"vdevice-host-name":"vm1"},{"core-time":"MonMay910:36:57UTC2022","vdevice-name":"172.16.255.15","index":7,"lastupdated":1652093038703,"core-filename":"vm5-system-report_20220509-103645-UTC.tar.gz","core-time-date":1652092617000,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write"}},"/device/crashlog/log":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash info from device","operationId":"getDeviceCrashInformation","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}},{"name":"filename","in":"query","description":"Crash file name","required":true,"schema":{"type":"string","example":"vm1-system-report_20220509-082507-UTC.tar.gz"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Device crash info":{"description":"Device crash info","value":"/bootflash/.prst_sync/reload_info\r\n/bootflash/pd_info/\r\n/bootflash/pd_info/system_report_trigger.log\r\n/bootflash/pd_info/free_mb_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_cpuinfo-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_stat-20220509-082405-UTC.log\r\n/bootflash/pd_info/topnmemuse_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/smap_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_interrupts-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_timer_list-20220509-082405-UTC.log\r\n/bootflash/pd_info/dmesg_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/df_output-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_sched_debug-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_meminfo-20220509-082405-UTC.log\r\n/bootflash/pd_info/proc_loadavg-20220509-082405-UTC.log\r\n/bootflash/pd_info/top_output-20220509-082405-UTC.log\r\n/tmp/vm1-bootuplog-20220509-082507-UTC.log\r\n/tmp/cyan/cyan.log\r\n/tmp/tdlresolve/epoch_dir/\r\n/tmp/tdlresolve/epoch_dir/active\r\n/tmp/tdlresolve/epoch_dir/rp1current\r\n/tmp/tdlresolve/epoch_dir/rp0current\r\n/tmp/tdlresolve/epoch_dir/2022_05_09_05_04_5173.epoch\r\n/tmp/fp/trace/fman_fp_image_pman_F0-0.16083_2.20220509082503.bin\r\n/tmp/fp/trace/cpp_cp_svr_pman_F0-0.17117_2.20220509082454.bin\r\n/tmp/fp/trace/cpp_sp_svr_pman_F0-0.16525_2.20220509082431.bin\r\n/tmp/fp/trace/btman_F0-0.17522_1.20220509081731.bin\r\n/tmp/fp/trace/fman_fp_F0-0.16106_1.20220509070441.bin\r\n/tmp/fp/trace/cpp_cp_F0-0.17128_0.20220509050616.bin\r\n/tmp/fp/trace/btman_pman_F0-0.17512_1.20220509050615.bin\r\n/tmp/fp/trace/cman_fp_F0-0.17317_0.20220509050615.bin\r\n/tmp/fp/trace/cman_fp_pman_F0-0.17307_1.20220509050615.bin\r\n/tmp/fp/trace/cpp_cp_svr_pman_F0-0.17117_1.20220509050614.bin\r\n/tmp/fp/trace/cpp_driver_F0-0.16917_0.20220509050613.bin\r\n/tmp/fp/trace/cpp_driver_pman_F0-0.16904_1.20220509050612.bin\r\n/tmp/fp/trace/cpp_ha_F0-0.16736_0.20220509050612.bin\r\n/tmp/fp/trace/cpp_ha_top_level_server_pman_F0-0.16727_1.20220509050612.bin\r\n/tmp/fp/trace/cpp_sp_F0-0.16538_0.20220509050611.bin\r\n/tmp/fp/trace/cpp_sp_svr_pman_F0-0.16525_1.20220509050611.bin\r\n/tmp/fp/trace/qfpxucodexcxkv_F0-0.16334_0.20220509050611.bin\r\n/tmp/fp/trace/qfp_ucode_cxkv_pman_F0-0.16321_1.20220509050610.bin\r\n/tmp/fp/trace/fman_fp_image_pman_F0-0.16083_1.20220509050609.bin\r\n/tmp/fp/trace/pvp_F0-0.15610_0.20220509050607.bin\r\n/tmp/rp/trace/flashutil_R0-0.9480_0.20220509082506.bin\r\n/tmp/rp/trace/ndbmand_R0-0.20343_2.20220509082506.bin\r\n/tmp/rp/trace/ndbmand_R0-0.20343_1.20220509082506.bin\r\n/tmp/rp/trace/dmiauthd_pman_R0-0.20704_2.20220509082441.bin\r\n/tmp/rp/trace/dmiauthd_R0-0.20711_1.20220509082440.bin\r\n/tmp/rp/trace/cxpd_pman_R0-0.26162_2.20220509082431.bin\r\n/tmp/rp/trace/cfgmgr_pman_R0-0.23017_2.20220509082431.bin\r\n/tmp/rp/trace/ftmd_pman_R0-0.26542_2.20220509082431.bin\r\n/tmp/rp/trace/dbgd_pman_R0-0.26285_12.20220509082430.bin\r\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_19.20220509082427.bin\r\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_18.20220509082427.bin\r\n/tmp/rp/trace/plogd_R0-0.6454_15.20220509082427.bin\r\n/tmp/rp/trace/nginx_pman_R0-0.23917_3.20220509082420.bin\r\n/tmp/rp/trace/nginx_pman_R0-0.23917_2.20220509082420.bin\r\n/tmp/rp/trace/ofa_pman_R0-0.6786_1.20220509082414.bin\r\n/tmp/rp/trace/sessmgrd_pman_R0-0.14700_1.20220509082413.bin\r\n/tmp/rp/trace/install_mgr_pman_R0-0.16776_1.20220509082413.bin\r\n/tmp/rp/trace/flashutil_R0-0.6969_0.20220509082357.bin\r\n/tmp/rp/trace/brelay_R0-0.5073_0.20220509082312.bin\r\n/tmp/rp/trace/droputil_R0-0.7228_41.20220509082309.bin\r\n/tmp/rp/trace/vdaemon_pman_R0-0.23139_27.20220509082256.bin\r\n/tmp/rp/trace/brelay_R0-0.32610_0.20220509082120.bin\r\n/tmp/rp/trace/flashutil_R0-0.31555_0.20220509082116.bin\r\n/tmp/rp/trace/brelay_R0-0.28844_0.20220509082045.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.28714_0.20220509082044.bin\r\n/tmp/rp/trace/plogd_R0-0.6454_14.20220509081556.bin\r\n/tmp/rp/trace/utd_R0-0.21164_0.20220509081511.bin\r\n/tmp/rp/trace/brelay_R0-0.17059_0.20220509081122.bin\r\n/tmp/rp/trace/IOSRP_R0-0.5718_7.20220509080821.bin\r\n/tmp/rp/trace/brelay_R0-0.12315_0.20220509080810.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.12179_0.20220509080808.bin\r\n/tmp/rp/trace/brelay_R0-0.9102_0.20220509080557.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.8987_0.20220509080557.bin\r\n/tmp/rp/trace/dbgd_pman_R0-0.26285_11.20220509080429.bin\r\n/tmp/rp/trace/utd_R0-0.5943_0.20220509080401.bin\r\n/tmp/rp/trace/brelay_R0-0.5873_0.20220509080400.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.5740_0.20220509080359.bin\r\n/tmp/rp/trace/brelay_R0-0.4593_0.20220509080339.bin\r\n/tmp/rp/trace/in_telnetd_R0-0.4475_0.20220509080338.bin\r\n/tmp/rp/trace/ncsshd_bp_R0-0.20977_17.20220509080331.bin\r\n/tmp/rp/trace/netconfxsubsys_R0-0.25635_0.20220509075716.bin\r\n/tmp/rp/trace/ncsshd_R0-0.25630_0.20220509075714.bin\r\n/tmp/rp/trace/ncsshd_R0-0.23604_0.20220509075527.bin\r\n/tmp/rp/trace/ncsshd_R0-0.20871_0.20220509075321.bin\r\n/tmp/rp/trace/utd_R0-0.20557_0.20220509075306.bin\r\n/tmp/rp/trace/utf_R0-0.9196_1.20220509074907.bin\r\n/tmp/rp/trace/IOSRP_R0-0.5718_6.20220509074231.bin\r\n/tmp/rp/trace/btman_R0-0.9196_1.20220509072434.bin\r\n/tmp/rp/trace/vdaemon_R0-0.23144_1.20220509070058.bin\r\n/tmp/rp/trace/fman_rp_R0-0.7340_1.20220509065929.bin\r\n/tmp/rp/trace/ttm_R0-0.26803_0.20220509050940.bin\r\n/tmp/rp/trace/ttmd_pman_R0-0.26797_1.20220509050939.bin\r\n/tmp/rp/trace/ompd_R0-0.26673_0.20220509050939.bin\r\n/tmp/rp/trace/ompd_pman_R0-0.26667_1.20220509050938.bin\r\n/tmp/rp/trace/ftmd_R0-0.26547_0.20220509050937.bin\r\n/tmp/rp/trace/ftmd_pman_R0-0.26542_1.20220509050937.bin\r\n/tmp/rp/trace/fpmd_R0-0.26411_0.20220509050937.bin\r\n/tmp/rp/trace/fpmd_pman_R0-0.26405_1.20220509050936.bin\r\n/tmp/rp/trace/dbgd_R0-0.26292_0.20220509050936.bin\r\n/tmp/rp/trace/cxpd_R0-0.26200_0.20220509050936.bin\r\n/tmp/rp/trace/cxpd_pman_R0-0.26162_1.20220509050933.bin\r\n/tmp/rp/trace/nginx_pman_R0-0.23917_1.20220509050911.bin\r\n/tmp/rp/trace/cfgmgr_R0-0.23065_0.20220509050811.bin\r\n/tmp/rp/trace/cfgmgr_pman_R0-0.23017_1.20220509050809.bin\r\n/tmp/rp/trace/linux_iosd_image_pman_R0-0.5705_2.20220509050747.bin\r\n/tmp/rp/trace/vip_confd_startup_sh_pman_R0-0.21463_0.20220509050629.bin\r\n/tmp/rp/trace/ncsshd_R0-0.21219_0.20220509050628.bin\r\n/tmp/rp/trace/ncsshd_pman_R0-0.21213_0.20220509050628.bin\r\n/tmp/rp/trace/pubd_R0-0.20002_0.20220509050628.bin\r\n/tmp/rp/trace/pvp_R0-0.5111_1.20220509050628.bin\r\n/tmp/rp/trace/ndbmand_R0-0.20343_0.20220509050627.bin\r\n/tmp/rp/trace/ncsshd_bp_pman_R0-0.20969_0.20220509050627.bin\r\n/tmp/rp/trace/dmiauthd_pman_R0-0.20704_1.20220509050626.bin\r\n/tmp/rp/trace/dmiauthd_R0-0.20711_0.20220509050626.bin\r\n/tmp/rp/trace/inter_fru_1_255-F0-0.0.20220509050626.bin\r\n/tmp/rp/trace/ndbmand_pman_R0-0.20333_0.20220509050625.bin\r\n/tmp/rp/trace/pubd_pman_R0-0.19984_0.20220509050624.bin\r\n/tmp/rp/trace/pttcd_R0-0.19704_0.20220509050624.bin\r\n/tmp/rp/trace/pttcd_pman_R0-0.19672_0.20220509050624.bin\r\n/tmp/rp/trace/periodic_sh_pman_R0-0.19258_0.20220509050621.bin\r\n/tmp/rp/trace/sort_files_by_inode_sh_pman_R0-0.18984_0.20220509050620.bin\r\n/tmp/rp/trace/cedge_tanman_sh_pman_R0-0.18381_0.20220509050619.bin\r\n/tmp/rp/trace/reflector_R0-0.7564_1.20220509050619.bin\r\n/tmp/rp/trace/cli_agent_R0-0.8908_0.20220509050618.bin\r\n/tmp/rp/trace/cmand_R0-0.8532_0.20220509050618.bin\r\n/tmp/rp/trace/dbm_R0-0.8111_0.20220509050617.bin\r\n/tmp/rp/trace/smand_R0-0.6034_1.20220509050616.bin\r\n/tmp/rp/trace/emd_R0-0.7821_0.20220509050616.bin\r\n/tmp/rp/trace/hman_R0-0.7098_0.20220509050614.bin\r\n/tmp/rp/trace/install_mgr_R0-0.16783_0.20220509050612.bin\r\n/tmp/rp/trace/install_mgr_pman_R0-0.16776_0.20220509050612.bin\r\n/tmp/rp/trace/sec_key_agent_R0-0.6957_0.20220509050610.bin\r\n/tmp/rp/trace/lman_R0-0.16040_0.20220509050609.bin\r\n/tmp/rp/trace/lman_pman_R0-0.16028_1.20220509050608.bin\r\n/tmp/rp/trace/ofa_R0-0.6790_0.20220509050608.bin\r\n/tmp/rp/trace/smd_R0-0.14706_0.20220509050607.bin\r\n/tmp/rp/trace/repm_R0-0.6188_0.20220509050606.bin\r\n/tmp/rp/trace/sdavc_proxy_R0-0.15234_0.20220509050604.bin\r\n/tmp/rp/trace/sdavc_proxy_pman_R0-0.15219_1.20220509050604.bin\r\n/tmp/rp/trace/sessmgrd_pman_R0-0.14700_0.20220509050602.bin\r\n/tmp/rp/trace/vman_R0-0.14560_0.20220509050602.bin\r\n/tmp/rp/trace/vman_pman_R0-0.14542_1.20220509050601.bin\r\n/tmp/rp/trace/psd_R0-0.5391_0.20220509050558.bin\r\n/tmp/rp/trace/selinux_smu_R0-0.13554_0.20220509050556.bin\r\n/tmp/rp/trace/kernel_ftrace_log_R0-0.13535_0.20220509050556.bin\r\n/tmp/rp/trace/btman_pman_R0-0.9189_1.20220509050455.bin\r\n/tmp/rp/trace/bhytoolsd_R0-0.6308_0.20220509050455.bin\r\n/tmp/rp/trace/cli_agent_pman_R0-0.8886_0.20220509050447.bin\r\n/tmp/rp/trace/binos_R0-0.8442_0.20220509050436.bin\r\n/tmp/rp/trace/dbm_pman_R0-0.8103_0.20220509050428.bin\r\n/tmp/rp/trace/iptbl_R0-0.8093_0.20220509050428.bin\r\n/tmp/rp/trace/emd_pman_R0-0.7817_1.20220509050424.bin\r\n/tmp/rp/trace/fman_rp_pman_R0-0.7329_1.20220509050415.bin\r\n/tmp/rp/trace/hman_pman_R0-0.7093_1.20220509050413.bin\r\n/tmp/rp/trace/keyman_pman_R0-0.6954_1.20220509050409.bin\r\n/tmp/rp/trace/ofa_pman_R0-0.6786_0.20220509050405.bin\r\n/tmp/rp/trace/oom_R0-0.6535_0.20220509050400.bin\r\n/tmp/rp/trace/plogd_pman_R0-0.6432_0.20220509050357.bin\r\n/tmp/rp/trace/repm_pman_R0-0.6181_0.20220509050352.bin\r\n/tmp/rp/trace/smand_pman_R0-0.6030_1.20220509050349.bin\r\n/tmp/rp/trace/psd_pman_R0-0.5318_1.20220509050343.bin\r\n/tmp/rp/trace/psvp_R0-0.5042_0.20220509050336.bin\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_080125.gz\r\n/harddisk/tracelogs/cyaninit_R0-0.5010_0.20220509050340.bin.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_072735.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_080738.gz\r\n/harddisk/tracelogs/dmi_ports_fetch_R0-0.19770_0.20220509050041.bin.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_075711.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_074912.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_070208.gz\r\n/harddisk/tracelogs/btman_rotate_immediate_R0-0.20030_0.20220509050102.bin.gz\r\n/harddisk/tracelogs/btman_rotate_immediate_R0-0.19856_0.20220509050042.bin.gz\r\n/harddisk/tracelogs/system_shell_R0-0.9105_0.20220509080558.bin\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_073035.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_070720.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_080023.gz\r\n/harddisk/tracelogs/cia-netconf-trace.20220509_073738.gz\r\n/harddisk/tracelogs/utf_R0-0.9196_0.20220509050620.bin.gz\r\n/tmp/maroon_stats/pman_rp_0_7093.maroon\r\n/tmp/maroon_stats/pman_rp_0_20333.maroon\r\n/tmp/maroon_stats/pman_fp_0_16083.maroon\r\n/tmp/maroon_stats/pman_fp_0_17117.maroon\r\n/tmp/maroon_stats/pman_rp_0_20704.maroon\r\n/tmp/maroon_stats/pman_rp_0_21463.maroon\r\n/tmp/maroon_stats/pman_rp_0_14542.maroon\r\n/tmp/maroon_stats/pman_rp_0_21213.maroon\r\n/tmp/maroon_stats/pman_rp_0_26162.maroon\r\n/tmp/maroon_stats/pman_fp_0_16525.maroon\r\n/tmp/maroon_stats/pman_rp_0_26667.maroon\r\n/tmp/maroon_stats/pman_fp_0_16904.maroon\r\n/tmp/maroon_stats/pman_rp_0_26542.maroon\r\n/tmp/maroon_stats/pman_rp_0_23017.maroon\r\n/tmp/maroon_stats/pman_rp_0_26405.maroon\r\n/tmp/maroon_stats/pman_rp_0_26797.maroon\r\n/tmp/maroon_stats/pman_rp_0_6432.maroon\r\n/tmp/maroon_stats/pman_rp_0_20969.maroon\r\n/tmp/maroon_stats/pman_rp_0_23917.maroon\r\n/tmp/maroon_stats/pman_fp_0_16321.maroon\r\n/tmp/maroon_stats/pman_fp_0_17307.maroon\r\n/tmp/maroon_stats/pman_fp_0_16727.maroon\r\n/tmp/maroon_stats/pman_fp_0_17512.maroon\r\n/tmp/maroon_stats/pman_rp_0_5705.maroon\r\n/tmp/maroon_stats/pman_rp_0_6030.maroon\r\n/tmp/maroon_stats/pman_rp_0_5318.maroon\r\n/tmp/maroon_stats/pman_rp_0_19984.maroon\r\n/tmp/maroon_stats/pman_rp_0_19258.maroon\r\n/tmp/maroon_stats/pman_rp_0_7329.maroon\r\n/tmp/maroon_stats/pman_rp_0_8886.maroon\r\n/tmp/maroon_stats/pman_rp_0_6954.maroon\r\n/tmp/maroon_stats/pman_rp_0_6181.maroon\r\n/tmp/maroon_stats/pman_rp_0_6786.maroon\r\n/tmp/maroon_stats/pman_rp_0_9189.maroon\r\n/tmp/maroon_stats/pman_rp_0_8103.maroon\r\n/tmp/maroon_stats/pman_rp_0_7817.maroon\r\n/tmp/maroon_stats/pman_rp_0_14700.maroon\r\n/tmp/maroon_stats/pman_rp_0_15219.maroon\r\n/tmp/maroon_stats/pman_rp_0_18381.maroon\r\n/tmp/maroon_stats/pman_rp_0_18984.maroon\r\n/tmp/maroon_stats/pman_rp_0_16028.maroon\r\n/tmp/maroon_stats/pman_rp_0_16776.maroon\r\n/tmp/maroon_stats/pman_rp_0_19672.maroon\r\n/tmp/maroon_stats/pman_rp_0_8528.maroon\r\n/tmp/maroon_stats/rotee_rp_0_13790.maroon\r\n/tmp/maroon_stats/pman_rp_0_26285.maroon\r\n/tmp/maroon_stats/ucode_pkt_PPE0_fp_0_16334.maroon\r\n/tmp/maroon_stats/keyman_rp_0_6957.maroon\r\n/tmp/maroon_stats/fpmd_rp_0_26411.maroon\r\n/tmp/maroon_stats/cxpd_rp_0_26200.maroon\r\n/tmp/maroon_stats/dbgd_rp_0_26292.maroon\r\n/tmp/maroon_stats/ompd_rp_0_26673.maroon\r\n/tmp/maroon_stats/ttmd_rp_0_26803.maroon\r\n/tmp/maroon_stats/ftmd_rp_0_26547.maroon\r\n/tmp/maroon_stats/pman_rp_0_23139.maroon\r\n/tmp/maroon_stats/cfgmgr_rp_0_23065.maroon\r\n/tmp/maroon_stats/vdaemon_rp_0_23144.maroon\r\n/tmp/maroon_stats/dmiauthd_rp_0_20711.maroon\r\n/tmp/maroon_stats/pubd_rp_0_20002.maroon\r\n/tmp/maroon_stats/ndbmand_rp_0_20343.maroon\r\n/tmp/maroon_stats/ncsshd_bp_rp_0_20977.maroon\r\n/tmp/maroon_stats/rotee_FRU_SLOT_NUM_7228.maroon\r\n/tmp/maroon_stats/install_mgr_rp_0_16783.maroon\r\n/tmp/maroon_stats/lman_rp_0_16040.maroon\r\n/tmp/maroon_stats/btman_fp_0_17522.maroon\r\n/tmp/maroon_stats/cman_fp_fp_0_17317.maroon\r\n/tmp/maroon_stats/cpp_cp_svr_fp_0_17128.maroon\r\n/tmp/maroon_stats/vman_rp_0_14560.maroon\r\n/tmp/maroon_stats/cpp_driver_fp_0_16917.maroon\r\n/tmp/maroon_stats/cpp_sp_svr_fp_0_16538.maroon\r\n/tmp/maroon_stats/cpp_ha_top_leve_fp_0_16736.maroon\r\n/tmp/maroon_stats/fman_fp_image_fp_0_16106.maroon\r\n/tmp/maroon_stats/cli_agent_rp_0_8908.maroon\r\n/tmp/maroon_stats/dbm_rp_0_8111.maroon\r\n/tmp/maroon_stats/linux_iosd-imag_rp_0_5718.maroon\r\n/tmp/maroon_stats/btman_rp_0_9196.maroon\r\n/tmp/maroon_stats/fman_rp_rp_0_7340.maroon\r\n/tmp/maroon_stats/cmand_rp_0_8532.maroon\r\n/tmp/maroon_stats/emd_rp_0_7821.maroon\r\n/tmp/maroon_stats/plogd_rp_0_6454.maroon\r\n/tmp/maroon_stats/hman_rp_0_7098.maroon\r\n/tmp/maroon_stats/repm_rp_0_6188.maroon\r\n/tmp/maroon_stats/smand_rp_0_6034.maroon\r\n/tmp/maroon_stats/psd_rp_0_5391.maroon\r\n/tmp/maroon_stats/sessmgrd_rp_0_14706.maroon\r\n/var/log/audit/audit.log"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/crashlog/synced":{"get":{"tags":["Real-Time Monitoring - Crash Log"],"description":"Get device crash logs synchronously from device","operationId":"getDeviceCrashLogsSynced","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device crash logs":{"description":"Device crash logs","value":{"data":[{"vdevice-name":"172.16.255.11","createTimeStamp":1649439701737,"index":0,"core-filename":"vm1-system-report_20220407-031603-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"ThuApr703:16:10UTC2022","vdevice-dataKey":"172.16.255.11-0","@rid":855,"vmanage-system-ip":"172.16.255.11","lastupdated":1649769370563,"core-time-date":1649301370000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651156427829,"index":1,"core-filename":"vm1-system-report_20220428-124017-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"ThuApr2812:40:32UTC2022","vdevice-dataKey":"172.16.255.11-1","@rid":1224,"vmanage-system-ip":"172.16.255.11","lastupdated":1651156427519,"core-time-date":1651149632000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651156431854,"index":2,"core-filename":"vm1-system-report_20220428-125006-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"ThuApr2812:50:11UTC2022","vdevice-dataKey":"172.16.255.11-2","@rid":1225,"vmanage-system-ip":"172.16.255.11","lastupdated":1651156427519,"core-time-date":1651150211000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651708111493,"index":4,"core-filename":"vm1_ftmd_25306_20220504-112749-UTC.core.gz","vdevice-host-name":"vm1","core-time":"WedMay411:28:57UTC2022","vdevice-dataKey":"172.16.255.11-4","@rid":1250,"vmanage-system-ip":"172.16.255.11","lastupdated":1651708111141,"core-time-date":1651663737000},{"vdevice-name":"172.16.255.11","createTimeStamp":1651505130582,"index":3,"core-filename":"vm1-system-report_20220504-040557-UTC.tar.gz","vdevice-host-name":"vm1","core-time":"WedMay404:06:43UTC2022","vdevice-dataKey":"172.16.255.11-3","@rid":1463,"vmanage-system-ip":"172.16.255.11","lastupdated":1651637687479,"core-time-date":1651637203000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read,Software Upgrade-read,Software Upgrade-write"}},"/device/csp/containers/container":{"get":{"tags":["Real-Time Monitoring - Container Lifecycle"],"description":"Get device container from device (Real Time)","operationId":"createDeviceContainersInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"device container":{"description":"device container","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"ISRV","uuid":"C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0","memory":"4096","numcpu":"4","disk_size":"4096","image-name":"example.tar.gz","container_type":"virtual","port":"22","state":"running","error":"NA","uptime":"4:20:09:2","cpu_load":"2","disk_used_mb":"2048","memory_used_kb":"8192","ip-address":"192.168.30.163","ip-address-configured":"false","netmask":"255.255.255.0","default-gw":"127.0.1.254","bridge":"ovs-data-br","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/pnic":{"get":{"tags":["Real-Time Monitoring - RBAC"],"description":"Get pnic interfaces from device","operationId":"getPnicStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PNIC interfaces":{"description":"PNIC interfaces","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"eth0","operational-speed":"1G","operational-duplex":"full-duplex","autoneg":"auto","member_of":"pc","link_state":"up","lldp":"enabled","mac_address":"d8:b1:90:ff:f5:88","vdevice-dataKey":"172.16.255.15","mtu":"900","refcnt":"110","bytes":"1469476983","packets":"17749881","errors":"0","dropped":"0","broadcast":"14159834","multicast":"2889066","tx-bytes":"198318715","tx-packets":"272603","tx-errors":"0","tx-dropped":"0","tx-broadcast":"14156964","tx-multicast":"2888574","lastupdated":1661501479353,"pkt-capture":"ICMP"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/csp/pnic/synced":{"get":{"tags":["Real-Time Monitoring - RBAC"],"description":"Get pnic stats from device","operationId":"getPNICStatsFromDevice","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PNIC stats":{"description":"PNIC stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"eth0","operational-speed":"1G","operational-duplex":"full-duplex","autoneg":"auto","member_of":"pc","link_state":"up","lldp":"enabled","mac_address":"d8:b1:90:ff:f5:88","vdevice-dataKey":"172.16.255.15","mtu":"900","refcnt":"110","bytes":"1469476983","packets":"17749881","errors":"0","dropped":"0","broadcast":"14159834","multicast":"2889066","tx-bytes":"198318715","tx-packets":"272603","tx-errors":"0","tx-dropped":"0","tx-broadcast":"14156964","tx-multicast":"2888574","lastupdated":1661501479353,"pkt-capture":"ICMP"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/csp/rbac":{"get":{"tags":["Real-Time Monitoring - RBAC"],"description":"Get RBAC interfaces from device","operationId":"getRBACInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device RBAC interface":{"description":"Device RBAC interface","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","name":"rbac_user","password":"Nbv12345","role":"network-admin","active":"true","last_5_passwords":"Nbv12345","last-login-ts":"21:43:28 UTC Mon Aug 27 2022","lastupdated":1661501479353,"vdevice-dataKey":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/csp/resources/cpu-info/allocation":{"get":{"tags":["Real-Time Monitoring - NetworkHub Resources"],"description":"Get NetworkHub CPU allocation info from device","operationId":"getAllocationInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NetworkHub CPU allocation info":{"description":"NetworkHub CPU allocation info","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","total-sockets":"1","cores-per-socket":"8","total-logical-cpus":"16","logical-cpus-used-by-system":"2","logical-cpus-used-by-vnfs":"4","logical-cpus-used-dedicated":"12","logical-cpus-used-sharable":"2","lastupdated":1661501479353,"vdevice-dataKey":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/csp/resources/cpu-info/cpus":{"get":{"tags":["Real-Time Monitoring - NetworkHub Resources"],"description":"Get NetworkHub CPU info from device","operationId":"getCPUInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NetworkHub CPU info":{"description":"NetworkHub CPU info","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","cpu-id":"7","socket-id":"0","vdevice-dataKey":"172.16.255.11","core-id":"7","system-use":false,"name":"ROUTER3","vcpus":"4","low-latency":true,"vcpu-id":"0","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/csp/resources/cpu-info/vnfs":{"get":{"tags":["Real-Time Monitoring - NetworkHub Resources"],"description":"Get NetworkHub CPU VNF info from device","operationId":"getVNFInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NetworkHub CPU VNF info":{"description":"NetworkHub CPU VNF info","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","name":"ROUTER3","vcpus":"4","low-latency":true,"vcpu-id":"0","socket-id":"0","core-id":"7","cpu-id":"7","vdevice-dataKey":"172.16.255.11","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/csp/system/native":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system native settings from device","operationId":"createDeviceSystemSettingNativeInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system native settings":{"description":"Device system native settings","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","interface":"ge0/0","ipv4_address":"192.168.2.1","vdevice-dataKey":"172.16.255.15","netmask":"255.255.255.0","mac_address":"00:05:ad:00:10:41","mtu":"1500","txqueuelen":"16","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/system/processlist":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system process list from device","operationId":"createDeviceSystemProcessList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system process list":{"description":"Device system process list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","pid":"1","cpu":"3.5","mem":"1,6","vsz":"192156","rss":"7424","start":"Wed16","time":"0:00.02","vdevice-dataKey":"172.16.255.15","cmd":"systemd","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/system/settings":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system settings from device","operationId":"createDeviceSystemSetting","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system settings":{"description":"Device system settings","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","interface":"ge0/0","ipv4_address":"192.168.30.163","ipv4_netmask":"255.255.255.0","ipv4_dhcp":"enabled","ipv4_expire":"-","global_ipv6_address":"fe80::72db:98ff:fe07:1f35","global_prefixlen":"0","link_local_ipv6_address":"fe80::72db:98ff:fe07:1f35","link_local_prefixlen":"0","ipv6_dhcp":"enabled","ipv6_slaac":"disabled","vdevice-dataKey":"172.16.255.15","ipv6_dhcp_state":"Stateful","lastupdated":"1661501479353"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/csp/system/status":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system status from device","operationId":"createDeviceSystemStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system status":{"description":"Device system status","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"wan-br","status":"OK","vdevice-dataKey":"172.16.255.15","type":"default-bridge","lastupdated":1661501479353}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/ctsPac":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec PAC information from device","operationId":"getCtsPac","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec PAC information":{"description":"TrustSec PAC information","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","pac-type":"Cisco Trustse","authority-id":"Authority ","initiator-id":"device1","vdevice-dataKey":"172.16.255.15-vm5","authority-id-info":"acs1","pac-life-time":"13:59:27 PDT Jun 5 2022","pac-refresh-time":"00:01:24","pac-opaque":"000200B000030001000400101100E046659D4275B644BF946EFA49CD00060094000301008285A14CB259CA096487096D68D5F34D000000014C09A6AA00093A808ACA80B39EB656AF0BCA91F3564DF540447A11F9ECDFA4AEC3A193769B80066832495B8C40F6B5B46B685A68411B7DF049A32F2B03F89ECF948AC4BB85CF855CA186BEF8E2A8C69A7C0BE1BDF6EC27D826896A31821A7BA523C8BD90072CB8A8D0334F004D4B627D33001B0519D41738F7EDDF3A"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/devicestatus":{"get":{"tags":["Monitoring - Device Details"],"description":"Get devices status per type","operationId":"getDeviceOnlyStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceStatusData"},"examples":{"Device Status":{"description":"Device Status","value":"[\n {\n \"type\": \"vSmart\",\n \"name\": \"vSmart\",\n \"image\": \"images/vsmart.png\",\n \"count\": 3,\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart\",\n \"statusList\": [\n {\n \"status\": \"error\",\n \"name\": \"Error\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=error\",\n \"color\": \"fa7c7d\",\n \"icon\": \"images/device/device-error.png\",\n \"count\": 0\n },\n {\n \"status\": \"warning\",\n \"name\": \"Warning\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=warning\",\n \"color\": \"f2ce60\",\n \"icon\": \"images/device/device-warning.png\",\n \"count\": 0\n },\n {\n \"status\": \"normal\",\n \"name\": \"Normal\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=normal\",\n \"color\": \"b0e276\",\n \"icon\": \"images/device/device-normal.png\",\n \"count\": 3\n },\n {\n \"status\": \"new\",\n \"name\": \"Discovered device\",\n \"detailView\": \"dialog\",\n \"detailsURL\": \"/dataservice/device?personality=vsmart&status=new\",\n \"color\": \"7c8afa\",\n \"icon\": \"images/device/device-new.png\",\n \"count\": 0\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/dhcp/client":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCP client from device (Real Time)","operationId":"getDHCPClient","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DHCP client":{"description":"DHCP client","value":{"data":[{"lease-server-addr":"10.0.1.1","state":"dhcp-client-state-bound","if-name":"GigabitEthernet1","dns-address-secondary":"0.0.0.0","subnet-mask":"255.255.255.0","client-addr":"10.0.1.5","lease-remaining":"3143","gateway-addr":"0.0.0.0","dns-address":"10.0.1.1","vdevice-dataKey":"169.254.10.12-Mgmt-intf-GigabitEthernet1","vrf-name":"Mgmt-intf","lastupdated":1643101911868,"vdevice-host-name":"vm5","vdevice-name":"169.254.10.12","lease-time":"3600"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dhcp/interface":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCP interfaces from device (Real Time)","operationId":"getDHCPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DHCP interfaces":{"description":"DHCP interfaces","value":{"data":[{"server":"10.0.1.1","vdevice-dataKey":"169.254.10.10-512-eth0","lease-time":"0:01:00:00","vdevice-name":"169.254.10.10","ifname":"eth0","acquired-ip":"10.0.1.3/24","dns":"10.0.1.1","lastupdated":1643013783968,"time-remaining":"0:00:31:25","state":"bound","vpn-id":"512","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dhcp/server":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCP server from device (Real Time)","operationId":"getDHCPServer","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DHCP server":{"description":"DHCP server","value":{"data":[{"vdevice-dataKey":"169.254.10.9-10-ge0/0-","vdevice-name":"169.254.10.9","ifname":"ge0/0","lastupdated":1655094784187,"vpn-id":"10","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dhcpv6/interface":{"get":{"tags":["Real-Time Monitoring - DHCP"],"description":"Get DHCPv6 interfaces from device","operationId":"getDHCPv6Interface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device DHCP v6 interface":{"description":"Device DHCP v6 interface","value":{"data":[{"vdevice-dataKey":"169.254.10.10-512-eth0","vdevice-name":"169.254.10.10","ifname":"eth0","lastupdated":1646099652315,"state":"init","vpn-id":"512","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dot1x/clients":{"get":{"tags":["Real-Time Monitoring - DOT1x"],"description":"Get DOT1x client from device (Real Time)","operationId":"getWLANDOT1xClients","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DOT1x client":{"description":"DOT1x client","value":{"data":[{"vdevice-name":"172.16.254.2","vdevice-host-name":"vm3","if-name":"ge0/1","mac-address":"00:50:b6:0f:1c:84","auth-state":"Authenticating","auth-method":"Radius","vlan":"12","vpn":"-","eap-method":"(PEAP)","username":"admin","session-time":"9","connected-time":"9","inactive-time":"0","session-id":"57E1B641-00000001","eapol-frames-rx":"50","eapol-frames-tx":"50","eapol-start-frames-rx":"50","eapol-logoff-frames-rx":"50","eapol-request-id-frames-tx":"50","eapol-response-id-frames-rx":"50","eapol-request-frames-tx":"50","eapol-request-frames-rx":"50","lastupdated":1657853484627,"vdevice-dataKey":"172.16.254.2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dot1x/interfaces":{"get":{"tags":["Real-Time Monitoring - DOT1x"],"description":"Get DOT1x interface from device (Real Time)","operationId":"getWLANDOT1xInterfaces","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DOT1x interface":{"description":"DOT1x interface","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","if-name":"ge0/1","oper-state":"up","host-mode":"Multi Auth","ctrl-dir":"none","mab-server":"true","mab-local":"true","wake-on-lan":"true","reauth-timeout":"600","inactivity-timeout":"3600","guest-vlan":"11","auth-fail-vlan":"12","auth-reject-vlan":"13","default-vlan":"","primary-radius-server":"192.168.48.12","secondary-radius-server":"192.168.48.11","accounting-interval":"disabled","nas-identifier":"none","nas-ipaddr":"none","num-clients":"1","lastupdated":1654066320000,"vdevice-dataKey":"172.16.254.1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dot1x/radius":{"get":{"tags":["Real-Time Monitoring - DOT1x"],"description":"Get DOT1x Radius from device (Real Time)","operationId":"getDOT1xRadius","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DOT1x Radius":{"description":"DOT1x Radius","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","if-name":"ge0/1","ip-address":"192.168.48.11","vpn":"512","is-primary":"true","auth-port":"1812","auth-is-current":"true","auth-round-trip-time":"0","auth-access-requests":"10","auth-access-retransmissions":"0","auth-access-accepts":"1","auth-access-rejects":"0","auth-access-challenges":"9","auth-malformed-access-responses":"0","auth-bad-authenticators":"0","auth-pending-requests":"0","auth-timeouts":"0","auth-unknown-types":"0","auth-packets-dropped":"0","acct-port":"1813","acct-is-current":"true","acct-round-trip-time":"0","acct-requests":"5","acct-retransmissions":"0","acct-responses":"2","acct-malformed-responses":"0","acct-bad-authenticators":"0","acct-pending-requests":"0","acct-timeouts":"3","acct-unknown-types":"0","acct-packets-dropped":"0","vdevice-dataKey":"172.16.254.1","lastupdated":1654066320000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/downloadedImages":{"get":{"tags":["Configuration - Downloaded Images"],"description":"Get images list from device","operationId":"createSoftwareList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-","vdevice-name":"169.254.10.10","lastupdated":1644801887912,"downloadedImages":"[]","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/dpi/application-mapping":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI supported application list from device","operationId":"getSupportedApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI supported application list":{"description":"DPI supported application list","value":{"data":[{"name":"an","family":"network-service","familyShort":"network_service","longname":"ActiveNetworks","appId":"861"},{"name":"bb","family":"network-management","familyShort":"network_management","longname":"Systemsandnetworkmonitoringtool","appId":"50333632"},{"name":"fc","family":"network-service","familyShort":"network_service","longname":"FibreChannel","appId":"16777349"},{"name":"il","family":"network-service","familyShort":"network_service","longname":"InternalLinkTransportProtocol","appId":"16777256"},{"name":"ns","family":"network-service","familyShort":"network_service","longname":"NetworkSystems","appId":"50332408"},{"name":"sm","family":"network-service","familyShort":"network_service","longname":"SM","appId":"16777338"},{"name":"st","family":"network-service","familyShort":"network_service","longname":"Stream","appId":"16777221"},{"name":"3pc","family":"network-service","familyShort":"network_service","longname":"ThirdPartyConnectProtocol","appId":"16777250"},{"name":"acp","family":"network-service","familyShort":"network_service","longname":"AeolonCoreProtocol","appId":"50332247"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/application/fields":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI query field from device","operationId":"getDPIDeviceFieldJSON","parameters":[{"name":"isDeviceDashBoard","in":"query","description":"Flag whether is device dashboard request","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI query field":{"description":"DPI query field","value":{"data":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"EventTime","options":[{"enableDateFields":false,"number":"24","value":"Last24hours","key":"last_24_hours"},{"enableDateFields":false,"number":"12","value":"Last12hours","key":"last_12_hours"},{"enableDateFields":false,"number":"6","value":"Last6hours","key":"last_6_hours"},{"enableDateFields":false,"number":"3","value":"Last3hours","key":"last_3_hours"},{"enableDateFields":false,"number":"1","value":"Last1hour","key":"last_1_hour"},{"enableDateFields":false,"number":"168","value":"Last7days","key":"last_168_hours"}]},{"isRequired":true,"fieldData":{"type":"url","url":"dataservice/device/action/vpn"},"dataType":"int","property":"vpn_id","name":"VPN","multiSelect":false},{"isRequired":true,"dataType":"string","property":"vdevice_name","name":"Devicename","multiSelect":false,"isHidden":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI applications from device (Real Time)","operationId":"createDPICollectorList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"family","in":"query","description":"Family","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI applications":{"description":"DPI applications","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network_service","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-management","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-service","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-management","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","application":"st","family":"network-service","expired-flows":"0","last-seen":1655736428995,"packets":"1000","octets":"100","lastupdated":1655736428995}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dpi/common/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI common application list from device","operationId":"getCommonApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI common application list":{"description":"DPI common application list","value":{"data":[{"name":"3com-amp3","familyShort":"network-service","longname":"3ComAMP3","family":"NetworkService","qosmosName":"3com-amp3","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"3com-tsmux","familyShort":"network-service","longname":"3ComTSMUX","family":"NetworkService","qosmosName":"3com-tsmux","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"3pc","familyShort":"network-service","longname":"ThirdPartyConnect","family":"NetworkService","qosmosName":"3pc","qosmosFamily":"network_service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"4chan","familyShort":"web","longname":"4CHAN","family":"Web","qosmosName":"4chan","qosmosFamily":"web","trafficClass":"transactional-data","businessRelevance":"business-irrelevant"},{"name":"58-city","familyShort":"web","longname":"58City","family":"Web","qosmosName":"58com","qosmosFamily":"web","trafficClass":"transactional-data","businessRelevance":"business-irrelevant"},{"name":"914c/g","familyShort":"terminal","longname":"TexasInstruments914Terminal","family":"Terminal","qosmosName":"914c/g","qosmosFamily":"terminal","trafficClass":"ops-admin-mgmt","businessRelevance":"business-relevant"},{"name":"9pfs","familyShort":"network-service","longname":"9P","family":"NetworkService","qosmosName":"9p","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"},{"name":"abc-news","familyShort":"web","longname":"ABCNews","family":"Web","qosmosName":"abcnews","qosmosFamily":"web","trafficClass":"transactional-data","businessRelevance":"business-irrelevant"},{"name":"acap","familyShort":"network-management","longname":"ApplicationConfigurationAccessProtocol","family":"NetworkManagement","qosmosName":"acap","qosmosFamily":"network-management","trafficClass":"ops-admin-mgmt","businessRelevance":"business-relevant"},{"name":"acas","familyShort":"network-service","longname":"ACAServices","family":"NetworkService","qosmosName":"acas","qosmosFamily":"network-service","trafficClass":"bulk-data","businessRelevance":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/device/fields":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI field from device","operationId":"getDPIFieldJSON","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI field":{"description":"DPI field","value":{"data":[{"property":"entry_time","name":"EventTime","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_24_hours","value":"Last24hours","number":"24","enableDateFields":false},{"key":"last_12_hours","value":"Last12hours","number":"12","enableDateFields":false},{"key":"last_6_hours","value":"Last6hours","number":"6","enableDateFields":false},{"key":"last_3_hours","value":"Last3hours","number":"3","enableDateFields":false},{"key":"last_1_hour","value":"Last1hour","number":"1","enableDateFields":false},{"key":"last_168_hours","value":"Last7days","number":"168","enableDateFields":false}]},{"property":"application","name":"Application","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/devicedetails/fields":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI detailed field from device","operationId":"getDPIDeviceDetailsFieldJSON","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI detailed field":{"description":"DPI detailed field","value":{"data":[{"property":"entry_time","name":"EventTime","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_24_hours","value":"Last24hours","number":"24","enableDateFields":false},{"key":"last_12_hours","value":"Last12hours","number":"12","enableDateFields":false},{"key":"last_6_hours","value":"Last6hours","number":"6","enableDateFields":false},{"key":"last_3_hours","value":"Last3hours","number":"3","enableDateFields":false},{"key":"last_1_hour","value":"Last1hour","number":"1","enableDateFields":false},{"key":"last_168_hours","value":"Last7days","number":"168","enableDateFields":false}]},{"property":"application","name":"Application","isRequired":true,"multiSelect":false,"dataType":"string"},{"property":"vdevice_name","name":"Devicename","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/flows":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI flow list from device (Real Time)","operationId":"createDPIFlowsList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"src-ip","in":"query","description":"Source IP","schema":{"type":"string"}},{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"family","in":"query","description":"Family","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI flows":{"description":"DPI flows","value":{"data":[{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.2","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.3","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.4","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.5","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995},{"vdevice-name":"172.16.255.11","vdevice-host-name":"vm1","vpn-id":"1","src-ip":"1.1.1.1","dst-ip":"2.2.2.6","src-port":"80","dst-port":"8080","proto":"ipsec","application":"st","family":"network-service","active-since":"2022-06-14T17:07:39+0000","active-since-date":1655736428995,"lastupdated":1655736428995}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dpi/qosmos-static/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI QoSMos static application list","operationId":"getQosmosStaticApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI QoSMos static application list":{"description":"DPI QoSMos static application list","value":{"data":[{"name":"9p","family":"FileServer","familyShort":"file_server","longname":"Plan9FilesystemProtocol","appId":"3430"},{"name":"ah","family":"NetworkService","familyShort":"network_service","longname":"AuthenticationHeader","appId":"720"},{"name":"dr","family":"Web","familyShort":"web","longname":"Dr.dk","appId":"2043"},{"name":"dv","family":"Web","familyShort":"web","longname":"DV.is","appId":"1861"},{"name":"hs","family":"Web","familyShort":"web","longname":"Hs.fi(HelsinginSanomat)","appId":"2097"},{"name":"il","family":"NetworkService","familyShort":"network_service","longname":"InternetLink(Transportprotocol)","appId":"637"},{"name":"ip","family":"NetworkService","familyShort":"network_service","longname":"InternetProtocol","appId":"81"},{"name":"ja","family":"Web","familyShort":"web","longname":"Ja.is","appId":"1897"},{"name":"mk","family":"Web","familyShort":"web","longname":"Mk.co.kr","appId":"1213"},{"name":"mq","family":"ApplicationService","familyShort":"application_service","longname":"IBMWebsphereMQ","appId":"312"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/dpi/qosmos/applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI QoSMos application list from device","operationId":"getQosmosApplicationList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI QoSMos application list":{"description":"DPI QoSMos application list","value":{"data":[{"name":"an","family":"network-service","familyShort":"network_service","longname":"ActiveNetworks","appId":"861"},{"name":"bna","family":"network-service","familyShort":"network_service","longname":"BNA","appId":"803"},{"name":"box","family":"web","familyShort":"web","longname":"Box","appId":"1074"},{"name":"dls","family":"network-service","familyShort":"network_service","longname":"DirectoryLocationService","appId":"1078"},{"name":"dmp","family":"audio-video","familyShort":"audio_video","longname":"CiscoDigitalMediaPlayer","appId":"1422"},{"name":"apple-location-services","family":"application-service","familyShort":"application_service","longname":"AppleLocationServices","appId":"294"},{"name":"apple-push-notification","family":"application-service","familyShort":"application_service","longname":"ApplePushNotificationService","appId":"1169"},{"name":"sixtofour-ipv6-tunneled","family":"network-service","familyShort":"network_service","longname":"SixtofourIPv6Tunneled","appId":"1223"},{"name":"internet-audio-streaming","family":"instant-messaging","familyShort":"instant_messaging","longname":"InternetAudioStreamingWebApps","appId":"1514"},{"name":"internet-video-streaming","family":"web","familyShort":"web","longname":"InternetVideoStreamingWebApps","appId":"1513"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/device/dpi/summary":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get DPI summary from device (Real Time)","operationId":"createDPISummaryRealTime","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DPI applications":{"description":"DPI applications","value":{"data":[{"flows-expired":"0","vdevice-dataKey":"169.254.10.10","flows-created":"0","vdevice-name":"169.254.10.10","current-flows":"0","peak-rate":"0","current-rate":"0","lastupdated":1643014386555,"vdevice-host-name":"vm3","status":"disable","peak-flows":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dpi/supported-applications":{"get":{"tags":["Real-Time Monitoring - DPI"],"description":"Get supported applications from device (Real Time)","operationId":"createDPIStatistics","parameters":[{"name":"application","in":"query","description":"Application","schema":{"type":"string"}},{"name":"family","in":"query","description":"Family","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DPI applications":{"description":"DPI applications","value":{"data":[{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-an","application":"an","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Active Networks","vdevice-host-name":"vm3"},{"family-long-name":"network-management","vdevice-dataKey":"169.254.10.10-bb","application":"bb","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_management","application-long-name":"Systems and network monitoring tool","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-fc","application":"fc","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Fibre Channel","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-il","application":"il","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Internal Link Transport Protocol","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-ns","application":"ns","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Network Systems","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-sm","application":"sm","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"SM","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-st","application":"st","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Stream","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-3pc","application":"3pc","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Third Party Connect Protocol","vdevice-host-name":"vm3"},{"family-long-name":"network-service","vdevice-dataKey":"169.254.10.10-acp","application":"acp","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"network_service","application-long-name":"Aeolon Core Protocol","vdevice-host-name":"vm3"},{"family-long-name":"erp","vdevice-dataKey":"169.254.10.10-adp","application":"adp","vdevice-name":"169.254.10.10","lastupdated":1643014674675,"family":"erp","application-long-name":"Automatic Data Processing","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/dre/auto-bypass-stats":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE auto-bypass statistics","operationId":"getDreAutoBypassStats","parameters":[{"name":"appqoe-dre-auto-bypass-server-ip","in":"query","description":"Server IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"appqoe-dre-auto-bypass-port","in":"query","description":"Port","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Auto-Bypass Stats":{"description":"DRE Auto-Bypass Stats","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","appqoe-dre-auto-bypass-server-ip":"10.0.0.1","appqoe-dre-auto-bypass-port":"9088","appqoe-dre-auto-bypass-state":"Monitor","appqoe-dre-auto-bypass-dre-lan-bytes":48887002724,"appqoe-dre-auto-bypass-dre-wan-bytes":49401300299,"appqoe-dre-auto-bypass-dre-comp":0,"appqoe-dre-auto-bypass-last-update":"13:41:51","appqoe-dre-auto-bypass-entry-creation-time":"03:08:53","lastupdated":1645775163290,"vdevice-dataKey":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dre/dre-stats":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE statistics","operationId":"getDreStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Stats":{"description":"DRE Stats","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","data-total-cons":325071,"data-max-cons":704,"data-active-cons":0,"data-total-orig-bytes":6743098654720,"data-total-opt-bytes":3039763103744,"data-reduction-ratio":54,"data-cache-status":"Active","data-cache-size":426322690048,"data-cache-used-percent":93,"data-cache-oldest-data":"17:13:53:40","data-data-replaced":0,"lastupdated":1645775163290,"vdevice-dataKey":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dre/dre-status":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE status","operationId":"getDreStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Status":{"description":"DRE Status","value":{"data":[{"lastupdated":1645775163290,"appqoe-dre-status-health-status":"dre-status-disabled","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dre/peer-stats":{"get":{"tags":["Real-Time Monitoring - DRE"],"description":"Get DRE peer statistics","operationId":"getDrePeerStats","parameters":[{"name":"appqoe-dre-stats-peer-system-ip","in":"query","description":"System IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"appqoe-dre-stats-peer-peer-no","in":"query","description":"Peer Number","schema":{"type":"number"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DRE Peer Stats":{"description":"DRE Peer Stats","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","appqoe-dre-stats-peer-peer-no":"0","appqoe-dre-stats-peer-system-ip":"209.165.201.1","appqoe-dre-stats-peer-hostname":"dreopt","appqoe-dre-stats-peer-active-cons":"0","appqoe-dre-stats-peer-total-cons":"3714","lastupdated":1652171693495,"vdevice-dataKey":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Template Configuration-read,Template Configuration-write"}},"/device/dualStaticRouteTracker":{"get":{"tags":["Real-Time Monitoring - Dual Static Route Tracker Service"],"description":"Get dual static route tracker info from device","operationId":"getDualStaticRouteTrackerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Dual static route tracker info":{"description":"Dual static route tracker info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/eigrp/interface":{"get":{"tags":["Real-Time Monitoring - EIGRP"],"description":"Get EIGRP interface list from device (Real Time)","operationId":"createEIGRPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"EIGRP interface list":{"description":"EIGRP interface list","value":{"data":[{"vdevice-name":"169.254.10.13","vdevice-host-name":"vm6","name":"GigabitEthernet0","passive":"GigabitEthernet0/0","hello-interval":"5","hold-timer":"15","auth-mode":"md5","lastupdated":1654586532070,"vdevice-dataKey":"169.254.10.13-eigrp-af-ipv4-0.0.0.0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/eigrp/route":{"get":{"tags":["Real-Time Monitoring - EIGRP"],"description":"Get EIGRP route from device (Real Time)","operationId":"createEIGRPRoute","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"EIGRP route":{"description":"EIGRP route","value":{"data":[{"vdevice-name":"169.254.10.13","afi":"eigrp-af-ipv4","origin":"eigrp-origin-redistributed","infosource":"0.0.0.0","omp-tag":"0","succ-metric":"0","vdevice-host-name":"vm6","nexthop":"172.16.254.2","vdevice-dataKey":"169.254.10.13-eigrp-af-ipv4-0.0.0.0","metric":"1","lastupdated":1654586532070},{"vdevice-name":"169.254.10.13","afi":"eigrp-af-ipv4","origin":"eigrp-origin-redistributed","infosource":"0.0.0.0","omp-tag":"0","succ-metric":"0","vdevice-host-name":"vm6","nexthop":"172.16.254.4","vdevice-dataKey":"169.254.10.13-eigrp-af-ipv4-0.0.0.0","metric":"1","lastupdated":1654586532070}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/eigrp/topology":{"get":{"tags":["Real-Time Monitoring - EIGRP"],"description":"Get EIGRP topology info from device (Real Time)","operationId":"createEIGRPTopology","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"EIGRP topology info":{"description":"EIGRP topology info","value":{"data":[{"vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15-0----","vdevice-name":"172.16.255.15","topo-id":"0","lastupdated":1649307997571}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/enableSDAVC/{deviceIP}/{enable}":{"post":{"tags":["Monitoring - Device Details"],"description":"Enable/Disable SDAVC on device","operationId":"enableSDAVCOnDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}},{"name":"enable","in":"path","description":"Enable/Disable flag","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/endpointTracker":{"get":{"tags":["Real-Time Monitoring - Endpoint Tracker Service"],"description":"Get endpoint tracker info from device","operationId":"getEndpointTrackerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Endpoint tracker info":{"description":"Endpoint tracker info","value":{"data":[{"record-name":"test","if-name":"GigabitEthernet1","lastupdated":1650794336441,"actual-delay":"4294967295","vdevice-dataKey":"172.16.255.15-vm5-GigabitEthernet1","state":"tracker-if-state-down","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/endpointTrackerGroup":{"get":{"tags":["Real-Time Monitoring - Endpoint Tracker Group Service"],"description":"Get endpoint tracker group info from device","operationId":"getEndpointTrackerGroupInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Endpoint tracker group info":{"description":"Endpoint tracker group info","value":{"data":[{"oper":"tracker-group-oper-and","name":"tracker1","vdevice-dataKey":"172.16.255.15-vm5-tracker3_tracker-group","elem-state":"tracker-if-state-down","lastupdated":1650866884165,"actual-delay":"4294967295","group-name":"tracker3","group-state":"tracker-if-state-down","attach-point-name":"tracker3_tracker-group","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"oper":"tracker-group-oper-and","name":"tracker2","vdevice-dataKey":"172.16.255.15-vm5-tracker3_tracker-group","elem-state":"tracker-if-state-down","lastupdated":1650866884165,"actual-delay":"4294967295","group-name":"tracker3","group-state":"tracker-if-state-down","attach-point-name":"tracker3_tracker-group","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/environmentData":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Environment Data information from device","operationId":"getEnvironmentData","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec environment data information":{"description":"TrustSec environment data information","value":{"data":[{"status":"env-download-in-progress","device-sgt":0,"last-updated-time":"1970-01-01T00:00:00+00:00","lastupdated":1652325611225,"vdevice-dataKey":"172.16.255.15-vm5","next-refresh-time":"1970-01-01T00:00:00+00:00","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15","life-time":"0","total-num-servers":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/environmentData/radiusServer":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Environment Data Radius Server list from device","operationId":"getRadiusServer","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec environment data radius server list information":{"description":"TrustSec environment data radius server list information","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","ip-addr":"0.0.0.0","port-num":"1812","is-alive":"TRUE","auto-test":"TRUE","keywrap":"-","idle-time":"3600","dead-time":"60","lastupdated":1652325611225,"vdevice-dataKey":"172.16.255.15-vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/featurelist":{"get":{"tags":["Real-Time Monitoring - Device Feature List"],"description":"Get feature lists from device (Real Time)","operationId":"getFeatureList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature lists":{"description":"Feature lists","value":{"data":[{"vdevice-dataKey":"172.16.255.11-statistics-collection-1.0","vdevice-name":"172.16.255.11","name":"statistics-collection","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-upgrade-confirm-1.0","vdevice-name":"172.16.255.11","name":"upgrade-confirm","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-vmanage-mode-2.0","vdevice-name":"172.16.255.11","name":"vmanage-mode","lastupdated":1647222469375,"version":"2.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-dpi-statistics-2.0","vdevice-name":"172.16.255.11","name":"dpi-statistics","lastupdated":1647222469375,"version":"2.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-cert-serial-hashing-1.0","vdevice-name":"172.16.255.11","name":"cert-serial-hashing","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-upgrade-1.0","vdevice-name":"172.16.255.11","name":"upgrade","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-cert-serial-version-1.0","vdevice-name":"172.16.255.11","name":"cert-serial-version","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-vbond-standalone-1.0","vdevice-name":"172.16.255.11","name":"vbond-standalone","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-tools-2.0","vdevice-name":"172.16.255.11","name":"tools","lastupdated":1647222469375,"version":"2.0","vdevice-host-name":"vm1"},{"vdevice-dataKey":"172.16.255.11-admin-tech-options-1.0","vdevice-name":"172.16.255.11","name":"admin-tech-options","lastupdated":1647222469375,"version":"1.0","vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/featurelist/synced":{"get":{"tags":["Real-Time Monitoring - Device Feature List"],"description":"Get feature lists synchronously from device","operationId":"getSyncedFeatureList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature lists":{"description":"Feature lists","value":{"data":[{"vdevice-dataKey":"172.16.255.11-statistics-collection-1.0","@rid":632,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912241600,"name":"statistics-collection","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"},{"vdevice-dataKey":"172.16.255.11-upgrade-confirm-1.0","@rid":639,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912243273,"name":"upgrade-confirm","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"},{"vdevice-dataKey":"172.16.255.11-vmanage-mode-2.0","@rid":646,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912247190,"name":"vmanage-mode","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"2.0"},{"vdevice-dataKey":"172.16.255.11-dpi-statistics-2.0","@rid":654,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912250128,"name":"dpi-statistics","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"2.0"},{"vdevice-dataKey":"172.16.255.11-cert-serial-hashing-1.0","@rid":662,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912255235,"name":"cert-serial-hashing","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"},{"vdevice-dataKey":"172.16.255.11-upgrade-1.0","@rid":669,"vdevice-name":"172.16.255.11","vmanage-system-ip":"172.16.255.11","createTimeStamp":1646912260609,"name":"upgrade","lastupdated":1646912240766,"vdevice-host-name":"vm1","version":"1.0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/all-statuses/{deviceUUID}":{"get":{"tags":["File based RealTime Data Collection - Get Data Collection status for Device UUID"],"description":"Get Data Collection status for given Device UUID","operationId":"getDataCollectionStatusForDevice","parameters":[{"name":"deviceUUID","in":"path","description":"Device UUID","required":true,"schema":{"type":"string"},"example":"C8K-5e87e5c3-0923-4364-a729-d65d40298d76"}],"responses":{"200":{"description":"All data collection statuses for given device","content":{"application/json":{"schema":{"type":"string"},"examples":{"All data collection statuses for given device":{"description":"All data collection statuses for given device","$ref":"#/components/examples/Allstatuses200"}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","$ref":"#/components/examples/Allstatuses400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","$ref":"#/components/examples/Allstatuses500"}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/download/{requestUUID}":{"get":{"tags":["File based RealTime Data Collection - Download Generated File"],"description":"Download generated file","operationId":"downloadGeneratedFile","parameters":[{"name":"requestUUID","in":"path","description":"request UUID","required":true,"schema":{"type":"string"},"example":"c04aadac-6efb-4cfd-8cbd-0fc47e00e931"}],"responses":{"200":{"description":"Generates file"},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","$ref":"#/components/examples/Download"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","$ref":"#/components/examples/Download500"}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/file-generation-status":{"post":{"tags":["File based RealTime Data Collection - Device notification - File generation status"],"description":"Device notify when file is ready and vManage has to download them","operationId":"handleFileGenerationStatusResponseFromDevice","requestBody":{"description":"File generation status notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HandleFileGenerationStatusNotificationRequest"},"examples":{"Successful file generation status payload":{"description":"Successful file generation status payload","$ref":"#/components/examples/FileGenerationSuccessReq"},"Failed file generation status payload":{"description":"Failed file generation status payload","$ref":"#/components/examples/FileGenerationFailureReq"}}}},"required":true},"responses":{"200":{"description":"File generation status accepted"},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","$ref":"#/components/examples/FileGeneration400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","$ref":"#/components/examples/FileGeneration500"}}}}}},"x-roles-required":"vmanage-http-stream,System-read,System-write"}},"/device/file-based/data-collection/initiate-file-generation":{"post":{"tags":["File based RealTime Data Collection - Initiate File Generation"],"description":"Request device to prepare realtime collection data in required file format","operationId":"initiateFileGenerationRequestToDevice","requestBody":{"description":"Initiate file generation payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateFileGenerationRequest"},"examples":{"Initiate File Generation - OMP Routes Advertised in CSV Format":{"description":"Initiate File Generation - OMP Routes Advertised in CSV Format","$ref":"#/components/examples/InitiateFilegenerationCSV"},"Initiate File Generation - OMP Routes Received in JSON Format":{"description":"Initiate File Generation - OMP Routes Received in JSON Format","$ref":"#/components/examples/InitiateFilegenerationJSON"}}}},"required":true},"responses":{"200":{"description":"Response for file generation request","content":{"application/json":{"schema":{"type":"string"},"examples":{"Data Collection information":{"description":"Data Collection information","$ref":"#/components/examples/InitiateFilegeneration200"}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","$ref":"#/components/examples/InitiateFilegeneration400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","$ref":"#/components/examples/InitiateFilegeneration500"}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/status/{requestUUID}":{"get":{"tags":["File based RealTime Data Collection - Get Data Collection status for a Request UUID"],"description":"Get Data Collection status for given Request UUID","operationId":"getDataCollectionStatusForUUID","parameters":[{"name":"requestUUID","in":"path","description":"request UUID","required":true,"schema":{"type":"string"},"example":"c04aadac-6efb-4cfd-8cbd-0fc47e00e931"}],"responses":{"200":{"description":"Data collection status for given UUID","content":{"application/json":{"schema":{"type":"string"},"examples":{"Data collection status for given UUID":{"description":"Data collection status for given UUID","$ref":"#/components/examples/Status200"}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","$ref":"#/components/examples/Status400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","$ref":"#/components/examples/Status500"}}}}}},"x-roles-required":"System-read,System-write"}},"/device/file-based/data-collection/supported-commands/{deviceUUID}":{"get":{"tags":["File based RealTime Data Collection - Get Supported Commands List for a Device UUID"],"description":"Get Supported Command list for given Device UUID","operationId":"getSupportedCommandsList","parameters":[{"name":"deviceUUID","in":"path","description":"Device UUID","required":true,"schema":{"type":"string"},"example":"C8K-5e87e5c3-0923-4364-a729-d65d40298d76"}],"responses":{"200":{"description":"Supported Command list for given Device","content":{"application/json":{"schema":{"type":"string"},"examples":{"Response for Device with Supported Commands":{"description":"Response for Device with Supported Commands","$ref":"#/components/examples/supported-commands200"},"Response for Device with No Supported Commands":{"description":"Response for Device with No Supported Commands","value":{}}}}}},"400":{"description":"Bad Request or Parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"400 - Bad Request or Parameters":{"description":"400 - Bad Request or Parameters","$ref":"#/components/examples/supported-commands400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpError"},"examples":{"500 - Internal Error":{"description":"500 - Internal Error","$ref":"#/components/examples/supported-commands500"}}}}}},"x-roles-required":"System-read,System-write"}},"/device/geofence/status":{"get":{"tags":["Real-Time Monitoring - Geo-fencing"],"description":"Get Geo-fencing Status from device","operationId":"getGeofenceStatus","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Geo-fencing Status":{"description":"Geo-fencing Status","value":{"data":[{"geofence-config-status":"Geofencing-Disabled","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","lastupdated":1645089720394,"current-location-status":"Location-Invalid","current-device-location-timestamp":"2022-02-15T06:39:22+00:00","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/alarms":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware alarm list from device","operationId":"createAlarmList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware alarm list":{"description":"Hardware alarm list","value":{"data":[{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-22-0","vdevice-name":"10.0.0.121","alarm-id":"22","alarm-description":"PowerSupply/FANModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-critical","vdevice-host-name":"Router","alarm-name":"PowerSupplyBay1"},{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-62-0","vdevice-name":"10.0.0.121","alarm-id":"62","alarm-description":"PowerOverEthernetModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"POEBay0"},{"alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-82-0","vdevice-name":"10.0.0.121","alarm-id":"82","alarm-description":"PowerOverEthernetModuleMissing","lastupdated":1652171693495,"alarm-instance":"0","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"POEBay1"},{"alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1090-1","vdevice-name":"10.0.0.121","alarm-id":"1090","alarm-description":"TransceiverMissing-LinkDown","lastupdated":1652171693495,"alarm-instance":"1","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"subslot0/0transceivercontainer0"},{"alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1100-1","vdevice-name":"10.0.0.121","alarm-id":"1100","alarm-description":"TransceiverMissing-LinkDown","lastupdated":1652171693495,"alarm-instance":"1","alarm-category":"alarm-severity-info","vdevice-host-name":"Router","alarm-name":"subslot0/0transceivercontainer1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/environment":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware environment list from device","operationId":"createEnvironmentList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware environment list":{"description":"Hardware environment list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-Interface module-0","vdevice-name":"169.254.10.10","hw-class":"PIM","hw-item":"Interface module","hw-dev-index":0,"lastupdated":1643076101789,"vdevice-host-name":"vm3","measurement":"Present: yes; Powered On: no; Fault: no","status":"Down"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/errors":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware error list from device","operationId":"createErrorAlarmList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware error list":{"description":"Hardware error list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-Interface module-0","vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","alarm-id":"22","alarm-instance":"0","alarm-name":"POEBay0","alarm-time":"2022-04-26T02:28:26+00:00","alarm-category":"alarm-severity-critical","alarm-description":"PowerSupply/FANModuleMissing","lastupdated":1652171693495}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/inventory":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware inventory list from device","operationId":"createInventoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware inventory list":{"description":"Hardware inventory list","value":{"data":[{"hw-type":"Chassis","vdevice-dataKey":"169.254.10.10-Chassis-0","vdevice-name":"169.254.10.10","hw-dev-index":0,"serial-number":"sim","part-number":"vEdge-Cloud","lastupdated":1643076350328,"version":"1.0","vdevice-host-name":"vm3","hw-description":"vEdge-Cloud"},{"hw-type":"PIM","vdevice-dataKey":"169.254.10.10-PIM-0","vdevice-name":"169.254.10.10","hw-dev-index":0,"serial-number":"None","part-number":"ge-8","lastupdated":1643076350328,"version":"None","vdevice-host-name":"vm3","hw-description":"Max 8 x 1GE VM ports"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/status/summary":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware status summary from device","operationId":"createStatusSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware status summary":{"description":"Hardware status summary","value":{"data":[{"vdevice-name":"10.0.0.121","createTimeStamp":1611557599955,"current-reading":"1015","vdevice-host-name":"Router","sensor-name":"voltage","vdevice-dataKey":"10.0.0.121-V:Vcore-A-R0","@rid":927,"vmanage-system-ip":"10.0.0.121","sensor-units":"millivolts","name":"V:Vcore-A","lastupdated":1652152463462,"location":"R0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557593593,"current-reading":"31","vdevice-host-name":"Router","sensor-name":"temperature","vdevice-dataKey":"10.0.0.121-Temp:Temp1-P0","@rid":1731,"vmanage-system-ip":"10.0.0.121","sensor-units":"celsius","name":"Temp:Temp1","lastupdated":1651807463843,"location":"P0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557593651,"current-reading":"25","vdevice-host-name":"Router","sensor-name":"temperature","vdevice-dataKey":"10.0.0.121-Temp:Temp2-P0","@rid":1760,"vmanage-system-ip":"10.0.0.121","sensor-units":"celsius","name":"Temp:Temp2","lastupdated":1652152463462,"location":"P0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557599821,"current-reading":"1508","vdevice-host-name":"Router","sensor-name":"voltage","vdevice-dataKey":"10.0.0.121-V:1.5v-A-R0","@rid":1881,"vmanage-system-ip":"10.0.0.121","sensor-units":"millivolts","name":"V:1.5v-A","lastupdated":1652152463462,"location":"R0","state":"Normal"},{"vdevice-name":"10.0.0.121","createTimeStamp":1611557593684,"current-reading":"28","vdevice-host-name":"Router","sensor-name":"temperature","vdevice-dataKey":"10.0.0.121-Temp:Temp3-P0","@rid":2044,"vmanage-system-ip":"10.0.0.121","sensor-units":"celsius","name":"Temp:Temp3","lastupdated":1651999921808,"location":"P0","state":"Normal"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/synced/alarms":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware alarm list synchronously from device","operationId":"createSyncedAlarmList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware alarm list":{"description":"Hardware alarm list","value":{"data":[{"vdevice-name":"10.0.0.121","alarm-id":"22","alarm-description":"PowerSupply/FANModuleMissing","createTimeStamp":1650884158338,"alarm-instance":"0","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-22-0","@rid":3034,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-critical","alarm-name":"PowerSupplyBay1"},{"vdevice-name":"10.0.0.121","alarm-id":"62","alarm-description":"PowerOverEthernetModuleMissing","createTimeStamp":1650884158392,"alarm-instance":"0","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-62-0","@rid":3035,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"POEBay0"},{"vdevice-name":"10.0.0.121","alarm-id":"82","alarm-description":"PowerOverEthernetModuleMissing","createTimeStamp":1650884158434,"alarm-instance":"0","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:28:26+00:00","vdevice-dataKey":"10.0.0.121-82-0","@rid":3036,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"POEBay1"},{"vdevice-name":"10.0.0.121","alarm-id":"1090","alarm-description":"TransceiverMissing-LinkDown","createTimeStamp":1650884158484,"alarm-instance":"1","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1090-1","@rid":3037,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"subslot0/0transceivercontainer0"},{"vdevice-name":"10.0.0.121","alarm-id":"1100","alarm-description":"TransceiverMissing-LinkDown","createTimeStamp":1650884158543,"alarm-instance":"1","vdevice-host-name":"Router","alarm-time":"2022-04-26T02:29:44+00:00","vdevice-dataKey":"10.0.0.121-1100-1","@rid":3042,"vmanage-system-ip":"10.0.0.121","lastupdated":1650941679362,"alarm-category":"alarm-severity-info","alarm-name":"subslot0/0transceivercontainer1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/synced/environment":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware environment list synchronously from device","operationId":"createSyncedEnvironmentList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware environment list":{"description":"Hardware environment list","value":{"data":[{"vdevice-name":"172.16.255.11","hw-dev-index":0,"createTimeStamp":1647316012518,"vdevice-host-name":"vm1","measurement":"Present:yes;PoweredOn:no;Fault:no","vdevice-dataKey":"172.16.255.11-Interfacemodule-0","@rid":1156,"hw-item":"Interfacemodule","hw-class":"PIM","vmanage-system-ip":"172.16.255.11","lastupdated":1647316012314,"status":"Down"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/synced/inventory":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware inventory list synchronously from device","operationId":"createSyncedInventoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware inventory list":{"description":"Hardware inventory list","value":{"data":[{"vdevice-name":"172.16.255.11","serial-number":"sim","hw-dev-index":0,"createTimeStamp":1647316018898,"version":"1.0","vdevice-host-name":"vm1","hw-description":"vEdge-Cloud","hw-type":"Chassis","vdevice-dataKey":"172.16.255.11-Chassis-0","@rid":1163,"vmanage-system-ip":"172.16.255.11","part-number":"vEdge-Cloud","lastupdated":1647316017498},{"vdevice-name":"172.16.255.11","serial-number":"None","hw-dev-index":0,"createTimeStamp":1647316036497,"version":"None","vdevice-host-name":"vm1","hw-description":"Max8x1GEVMports","hw-type":"PIM","vdevice-dataKey":"172.16.255.11-PIM-0","@rid":1169,"vmanage-system-ip":"172.16.255.11","part-number":"ge-8","lastupdated":1647316017498}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/system":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware system data list from device","operationId":"createSystemList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware system data list":{"description":"Hardware system data list","value":[{"last-reboot-reason":"reload","software-version":"Cisco IOS Software [Cupertino], Virtual XE Software (X86_64_LINUX_IOSD-UNIVERSALK9-M), Experimental Version 17.8.20211216:090342 [BLD_POLARIS_DEV_LATEST_20211216_061759:/nobackup/mcpre/s2c-build-ws 101]\nCopyright (c) 1986-2021 by Cisco Systems, Inc.\nCompiled Thu 16-Dec-21 01:03 by mcpre","lastupdated":1643186341301,"vdevice-dataKey":"172.16.255.15-2022-01-26T08:40:53.165+00:00-2022-01-26T08:37:03+00:00","boot-time":"2022-01-26T08:37:03+00:00","rommon-version":"IOS-XE ROMMON","current-time":"2022-01-26T08:40:53.165+00:00","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardware/threshold":{"get":{"tags":["Real-Time Monitoring - Hardware"],"description":"Get hardware temperature list from device","operationId":"createTempThresholdList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Hardware temperature list":{"description":"Hardware temperature list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","hw-sensor-type":"Board","hw-dev-index":"0","fan-speed-normal":"64","yellow-alarm-normal":"65","yellow-alarm-bad-fan":"60","red-alarm-normal":"80","red-alarm-bad-fan":"75","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9-Interface module-0"},{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","hw-sensor-type":"CPU Junction","hw-dev-index":"1","fan-speed-normal":"64","yellow-alarm-normal":"65","yellow-alarm-bad-fan":"60","red-alarm-normal":"80","red-alarm-bad-fan":"75","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9-Interface module-1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/hardwarehealth/detail":{"get":{"tags":["Monitoring - Device Details"],"description":"Get hardware health details for device","operationId":"getHardwareHealthDetails","parameters":[{"name":"deviceId","in":"query","description":"Device Id","schema":{"type":"string"}},{"name":"state","in":"query","description":"Device state","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHardwareHealthDetail"}},"examples":{"Device hardware health details":{"description":"Device hardware health details","value":{"data":[{"bfdSessions":"3","memUsageDisplay":"52.0","site-id":"100","device-type":"vedge","version":"20.7.999-1133","hardwareState":"normal","uptime-date":1635324240000,"uuid":"63e8518c-e76f-4d5f-a4c7-28ffb669526b","lastupdated":1635371851165,"reachability":"reachable","device-model":"vedge-cloud","host-name":"vm11","local-system-ip":"172.16.255.21","cpuLoadDisplay":"39.27","controlConnections":"3","board-serial":"12346568","number-vsmart-peers":2,"system-ip":"172.16.255.21","ompPeers":"2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/hardwarehealth/summary":{"get":{"tags":["Monitoring - Device Details"],"description":"Get hardware health summary for device","operationId":"getHardwareHealthSummary","parameters":[{"name":"isCached","in":"query","description":"Status cached","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","description":"VPN Id","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device hardware health":{"description":"Device hardware health","value":{"data":[{"count":5,"status":"error","statusList":[{"status":"up","count":5,"message":"5 {normal=5, warning=0, error=0}","name":"normal","detailsURL":"/dataservice/device/hardwarehealth/detail?state=normal"},{"status":"warning","count":0,"message":"0 {normal=5, warning=0, error=0}","name":"warning","detailsURL":"/dataservice/device/hardwarehealth/detail?state=warning"},{"status":"down","count":0,"message":"0 {normal=5, warning=0, error=0}","name":"error","detailsURL":"/dataservice/device/hardwarehealth/detail?state=error"}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/history":{"get":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getStatDataRawData_20","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getStatsRawData_20","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/device/history/aggregation":{"get":{"tags":["Configuration - Device Config History"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_22","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Configuration - Device Config History"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_23","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/device/history/config":{"get":{"tags":["Configuration - Device Config History"],"description":"Get device config history","operationId":"getLastThousandConfigList","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","description":"Query filter","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config history":{"description":"Device config history","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Config Group-read,Policy Group-read"}},"/device/history/config/diff/list":{"get":{"tags":["Configuration - Device Config History"],"description":"Get diff of two configs","operationId":"getConfigDiff","parameters":[{"name":"config_id1","in":"query","description":"Config Id one","required":true,"schema":{"type":"string"}},{"name":"config_id2","in":"query","description":"Config Id two","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Config Group-read,Policy Group-read"}},"/device/history/config/{config_id}":{"get":{"tags":["Configuration - Device Config History"],"description":"Get device config","operationId":"getDeviceConfig","parameters":[{"name":"config_id","in":"path","description":"Config Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Config Group-read,Policy Group-read"}},"/device/history/csv":{"get":{"tags":["Configuration - Device Config History"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_20","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/device/history/doccount":{"get":{"tags":["Configuration - Device Config History"],"description":"Get response count of a query","operationId":"getCount_20","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Device Config History"],"description":"Get response count of a query","operationId":"getCountPost_20","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/history/fields":{"get":{"tags":["Configuration - Device Config History"],"description":"Get fields and type","operationId":"getStatDataFields_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/history/page":{"get":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_18","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Configuration - Device Config History"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_18","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/history/query/fields":{"get":{"tags":["Configuration - Device Config History"],"description":"Get query fields","operationId":"getStatQueryFields_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/igmp/groups":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP neighbor list from device","operationId":"createIGMPGroupsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IGMP neighbor":{"description":"IGMP neighbor","value":{"data":[{"if-name":"ge0/0","v1-members-present":"false","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","lastupdated":1643076514019,"state":"members-present","vpn-id":"10","event":"init-event","vdevice-host-name":"vm3","group":"225.225.0.1","uptime":"0:06:38:43"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/igmp/interface":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP interface list from device","operationId":"createIGMPInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IGMP interface":{"description":"IGMP interface","value":{"data":[{"vdevice-name":"169.254.10.10","if-addr":"100.100.3.101/24","vpn-id":"10","vdevice-host-name":"vm3","querier":"true","querier-ip":"100.100.3.101","if-name":"ge0/0","vdevice-dataKey":"169.254.10.10-10-ge0/0","group-count":1,"query-interval":"0:00:00:51","lastupdated":1643076670382,"state":"querier","event":"init-event"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/igmp/statistics":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP statistics list from device","operationId":"createIGMPStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IGMP statistics":{"description":"IGMP statistics","value":{"data":[{"rx_group_query":0,"vdevice-name":"169.254.10.10","tx_group_query":0,"vpn-id":"10","rx_v2_report":0,"rx_unknown":0,"vdevice-host-name":"vm3","rx_v1_report":0,"rx_leave":0,"tx_general_query":194,"vdevice-dataKey":"169.254.10.10","rx_general_query":0,"tx_error":0,"lastupdated":1643076824172,"rx_error":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/igmp/summary":{"get":{"tags":["Real-Time Monitoring - IGMP"],"description":"Get IGMP summary from device","operationId":"createIGMPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IGMP summary":{"description":"IGMP summary","value":{"data":[{"last-member-query-response-time":"3","querier-timeout":"255","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","query-interval":"125","query-response-time":"10","lastupdated":1643076984762,"version":"2","last-member-query-count":"2","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/interface":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces","operationId":"getDeviceInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":18,"if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":13,"ifname":"ge0/1","rx-pps":14,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":2,"allow-service":"dhcp dns icmp https","if-tracker-status":"NA","num-flaps":"0","rx-packets":6544375,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":48131,"tx-drops":2,"uptime":"4:20:14:13","ipv6-address":"-","secondary":"false","ip-address":"10.101.3.3/16","hwaddr":"52:54:00:a1:4f:47","speed-mbps":"1000","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","tx-octets":1238809794,"tx-packets":6404951,"rx-octets":1209186254,"rx-kbps":19,"lastupdated":1643077714908,"port-type":"transport","uptime-date":1642659240000,"encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/1","rx-pps":0,"af-type":"ipv6","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ipv6-admin-status":"Up","ifindex":2,"allow-service":"dhcp dns icmp https","if-tracker-status":"NA","num-flaps":"0","rx-packets":3644,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"uptime":"4:20:14:13","ipv6-address":"-","hwaddr":"52:54:00:a1:4f:47","speed-mbps":"1000","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","tx-octets":9140,"tx-packets":128,"rx-octets":405455,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"transport","uptime-date":1642659240000,"encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/2","rx-pps":0,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Down","ifindex":3,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:39:5a:01","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/2","rx-pps":0,"af-type":"ipv6","shaping-rate":0,"if-oper-status":"Down","ipv6-admin-status":"Up","ifindex":3,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:39:5a:01","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"},{"vdevice-name":"169.254.10.10","rx-errors":0,"tx-kbps":0,"if-admin-status":"Down","tcp-mss-adjust":"1416","tx-errors":0,"tx-pps":0,"ifname":"ge0/3","rx-pps":0,"af-type":"ipv4","shaping-rate":0,"if-oper-status":"Down","ifindex":4,"if-tracker-status":"NA","num-flaps":"0","rx-packets":0,"vpn-id":"0","vdevice-host-name":"vm3","mtu":"1500","rx-drops":0,"tx-drops":0,"ipv6-address":"-","hwaddr":"52:54:00:2d:a0:f5","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","tx-octets":0,"tx-packets":0,"rx-octets":0,"rx-kbps":0,"lastupdated":1643077714908,"port-type":"service","encap-type":"null"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/arp_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface ARP statistics","operationId":"getDeviceInterfaceARPStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ARP statistics":{"description":"ARP statistics","value":{"data":[{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"45746","rx-arp-requests":"296","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"12281","ip-address":"-","tx-arp-replies":"304","tx-no-arp-drops":"2","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","rx-arp-replies":"12281","ifname":"ge0/1","tx-arp-request-fail":"0","af-type":"ipv4","lastupdated":1643077098782,"arp-add-fails":"1"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"1","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","rx-arp-replies":"0","ifname":"ge0/1","tx-arp-request-fail":"0","af-type":"ipv6","lastupdated":1643077098782,"arp-add-fails":"0"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"0","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","rx-arp-replies":"0","ifname":"ge0/2","tx-arp-request-fail":"0","af-type":"ipv4","lastupdated":1643077098782,"arp-add-fails":"0"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"0","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","rx-arp-replies":"0","ifname":"ge0/2","tx-arp-request-fail":"0","af-type":"ipv6","lastupdated":1643077098782,"arp-add-fails":"0"},{"tx-arp-rate-limit-drops":"0","rx-arp-rate-limit-drops":"0","vdevice-name":"169.254.10.10","rx-arp-non-local-drops":"0","rx-arp-requests":"0","vpn-id":"0","vdevice-host-name":"vm3","rx-arp-reply-drops":"0","ipv6-address":"-","tx-arp-requests":"0","ip-address":"-","tx-arp-replies":"0","tx-no-arp-drops":"0","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","rx-arp-replies":"0","ifname":"ge0/3","tx-arp-request-fail":"0","af-type":"ipv4","lastupdated":1643077098782,"arp-add-fails":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/error_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface error stats","operationId":"getDeviceInterfaceErrorStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Error stats":{"description":"Error stats","value":{"data":[{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"2078","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"2","ifname":"ge0/1","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv4","arp-add-fails":"1","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"46027","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/1","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv6","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/2","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv4","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/2","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv6","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"},{"tx-icmp-policer-drops":"0","rx-arp-rate-limit-drops":"0","tx-icmp-mirrored-drops":"0","vdevice-name":"169.254.10.10","cpu-policer-drops":"0","interface-disabled":"0","rx-arp-reply-drops":"0","tx-no-arp-drops":"0","ifname":"ge0/3","split-horizon-drops":"0","tx-arp-request-fail":"0","af-type":"ipv4","arp-add-fails":"0","rx-policer-remark":"0","mirror-drops":"0","tx-arp-rate-limit-drops":"0","rx-ip-ttl-expired":"0","rx-arp-non-local-drops":"0","vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-","rx-policer-drops":"0","bad-label":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","route-lookup-fail":"0","lastupdated":1643079662907,"rx-non-ip-drops":"0","filter-drops":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/ipv6Stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface IPv6 stats","operationId":"getDeviceInterfaceIpv6Stats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface IPv6 stats":{"description":"Interface IPv6 stats","value":{"data":[{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet1","lastupdated":1645602691945,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet2","lastupdated":1645602691945,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet3","lastupdated":1645602691946,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet4","lastupdated":1645602691946,"out-error-pkts":"0"},{"in-forwarded-pkts":"0","vdevice-name":"169.254.10.12","out-pkts":"0","in-forwarded-octets":"0","in-discarded-pkts":"0","out-forwarded-octets":"0","in-error-pkts":"0","vdevice-host-name":"vm5","in-pkts":"0","out-forwarded-pkts":"0","out-octets":"0","out-discarded-pkts":"0","in-octets":"0","vdevice-dataKey":"169.254.10.12-","name":"GigabitEthernet5","lastupdated":1645602691946,"out-error-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/pkt_size":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface packet size","operationId":"getDeviceInterfacePktSizes","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface packet size":{"description":"Interface packet size","value":{"data":[{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/1","num-flaps":"0","af-type":"ipv4","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/1","num-flaps":"0","af-type":"ipv6","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/2","num-flaps":"0","af-type":"ipv4","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/2","num-flaps":"0","af-type":"ipv6","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/3-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/3","num-flaps":"0","af-type":"ipv4","lastupdated":1643080426479,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/port_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface port stats","operationId":"getDeviceInterfacePortStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface port stats":{"description":"Interface port stats","value":{"data":[{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/1","af-type":"ipv4","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/1","af-type":"ipv6","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","vdevice-name":"169.254.10.10","ifname":"ge0/2","af-type":"ipv4","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"},{"ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","vdevice-name":"169.254.10.10","ifname":"ge0/2","af-type":"ipv6","lastupdated":1643080839352,"vpn-id":"0","vdevice-host-name":"vm3","ipv6-address":"-"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/qosStats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface QOS stats","operationId":"getDeviceInterfaceQosStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface QOS stats":{"description":"Interface QOS stats","value":{"data":[{"drop-bytes":"0","vdevice-name":"169.254.10.13","early-drop-bytes":"0","early-drop-pkts":"0","classified-bytes":"771","vdevice-host-name":"vm6","has-child":"false","vdevice-dataKey":"169.254.10.13-GigabitEthernet2-vpn10_qos_policy-Queue0","classified-pkts":"3","classifier-entry-name":"Queue0","policy-name":"vpn10_qos_policy","output-bytes":"771","name":"GigabitEthernet2","lastupdated":1654656462183,"drop-pkts":"0","output-pkts":"3"},{"drop-bytes":"0","vdevice-name":"169.254.10.13","early-drop-bytes":"0","early-drop-pkts":"0","classified-bytes":"0","vdevice-host-name":"vm6","has-child":"false","vdevice-dataKey":"169.254.10.13-GigabitEthernet2-vpn10_qos_policy-class-default","classified-pkts":"0","classifier-entry-name":"class-default","output-bytes":"0","policy-name":"vpn10_qos_policy","name":"GigabitEthernet2","lastupdated":1654656462183,"drop-pkts":"0","output-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/queue_stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface queue stats","operationId":"getDeviceInterfaceQueueStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface queue stats":{"description":"Interface queue stats","value":{"data":[{"qnum":"0","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","vpn-id":"0","queued-bytes":"0","tail-drop-bytes":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-0","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","af-type":"ipv4","tx-bytes":"0","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"2","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-2","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"3","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-3","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"4","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-4","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"},{"qnum":"5","max-depth":"0","queued-packets":"0","vdevice-name":"169.254.10.10","avg-queue":"0","red-drop-packets":"0","queued-bytes":"0","tail-drop-bytes":"0","vpn-id":"0","vdevice-host-name":"vm3","red-drop-bytes":"0","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4-5","ifname":"ge0/1","tx-packets":"0","queue-pps":"0","tx-bytes":"0","af-type":"ipv4","lastupdated":1643081385319,"queue-depth":"0","queue-drop-pps":"0","tail-drop-packets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/serial":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get serial interface","operationId":"getDeviceSerialInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","ifname":"eth0","crc-type":"32","loopback":"Green","keepalive":"3","timeslot":"10","vdevice-dataKey":"172.16.255.15","subrate":"100000","lastupdated":"1661309393233"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/stats":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get interface stats","operationId":"getDeviceInterfaceStats","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface stats":{"description":"Interface stats","value":{"data":[{"vdevice-name":"169.254.10.10","rx-packets":"6634251","rx-errors":"0","tx-kbps":"18","tx-errors":"0","tx-pps":"13","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"48776","tx-drops":"2","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv4","ifname":"ge0/1","rx-pps":"13","tx-octets":"1255701145","tx-packets":"6493413","af-type":"ipv4","rx-octets":"1225652937","rx-kbps":"19","lastupdated":1643083561267},{"vdevice-name":"169.254.10.10","rx-packets":"3694","rx-errors":"0","tx-kbps":"0","tx-errors":"0","tx-pps":"0","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"0","tx-drops":"0","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/1-ipv6","ifname":"ge0/1","rx-pps":"0","tx-octets":"9280","tx-packets":"130","af-type":"ipv6","rx-octets":"411008","rx-kbps":"0","lastupdated":1643083561267},{"vdevice-name":"169.254.10.10","rx-packets":"0","rx-errors":"0","tx-kbps":"0","tx-errors":"0","tx-pps":"0","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"0","tx-drops":"0","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv4","ifname":"ge0/2","rx-pps":"0","tx-octets":"0","tx-packets":"0","af-type":"ipv4","rx-octets":"0","rx-kbps":"0","lastupdated":1643083561267},{"vdevice-name":"169.254.10.10","rx-packets":"0","rx-errors":"0","tx-kbps":"0","tx-errors":"0","tx-pps":"0","vpn-id":"0","dot1x-rx-pkts":"0","vdevice-host-name":"vm3","rx-drops":"0","tx-drops":"0","ipv6-address":"-","dot1x-tx-pkts":"0","ip-address":"-","vdevice-dataKey":"169.254.10.10-0-ge0/2-ipv6","ifname":"ge0/2","rx-pps":"0","tx-octets":"0","tx-packets":"0","af-type":"ipv6","rx-octets":"0","rx-kbps":"0","lastupdated":1643083561267}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/synced":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces synchronously","operationId":"getSyncedDeviceInterface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"af-type","in":"query","description":"AF Type","schema":{"type":"string","enum":["ipv4","ipv6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"vdevice-name":"172.16.255.11","if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","@rid":855,"ifname":"ge0/1","af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":2,"if-tracker-status":"NA","createTimeStamp":1647315879734,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","secondary":"false","ip-address":"10.0.26.11/24","hwaddr":"52:54:00:db:d9:1b","speed-mbps":"1000","vdevice-dataKey":"172.16.255.11-0-ge0/1-ipv4","vmanage-system-ip":"172.16.255.11","lastupdated":1647315879722,"port-type":"service","encap-type":"null"},{"vdevice-name":"172.16.255.11","if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","@rid":869,"ifname":"ge0/2","af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":3,"allow-service":"dhcpdnsicmphttps","if-tracker-status":"NA","createTimeStamp":1647315880679,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","secondary":"false","ip-address":"10.0.5.11/24","hwaddr":"52:54:00:5b:92:ab","speed-mbps":"1000","vdevice-dataKey":"172.16.255.11-0-ge0/2-ipv4","vmanage-system-ip":"172.16.255.11","lastupdated":1647315879722,"port-type":"transport","encap-type":"null"},{"ifindex":4,"vdevice-name":"172.16.255.11","if-tracker-status":"NA","if-admin-status":"Down","createTimeStamp":1647315881312,"tcp-mss-adjust":"1416","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","hwaddr":"52:54:00:36:5b:37","ip-address":"-","vdevice-dataKey":"172.16.255.11-0-ge0/3-ipv4","@rid":883,"ifname":"ge0/3","vmanage-system-ip":"172.16.255.11","af-type":"ipv4","lastupdated":1647315879722,"shaping-rate":0,"port-type":"service","if-oper-status":"Down","encap-type":"null"},{"vdevice-name":"172.16.255.11","if-admin-status":"Up","duplex":"full","tcp-mss-adjust":"1416","@rid":897,"ifname":"ge0/4","af-type":"ipv4","shaping-rate":0,"if-oper-status":"Up","auto-neg":"false","ifindex":5,"if-tracker-status":"NA","createTimeStamp":1647315882880,"secondary-address":"","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","secondary":"false","ip-address":"10.0.7.11/24","hwaddr":"52:54:00:67:74:f1","speed-mbps":"1000","vdevice-dataKey":"172.16.255.11-0-ge0/4-ipv4","vmanage-system-ip":"172.16.255.11","lastupdated":1647315879722,"port-type":"service","encap-type":"null"},{"ifindex":6,"vdevice-name":"172.16.255.11","if-tracker-status":"NA","if-admin-status":"Down","createTimeStamp":1647315883461,"tcp-mss-adjust":"1416","vpn-id":"0","vdevice-host-name":"vm1","mtu":"1500","ipv6-address":"-","hwaddr":"52:54:00:0f:c2:a7","ip-address":"-","vdevice-dataKey":"172.16.255.11-0-ge0/5-ipv4","@rid":908,"ifname":"ge0/5","vmanage-system-ip":"172.16.255.11","af-type":"ipv4","lastupdated":1647315879722,"shaping-rate":0,"port-type":"service","if-oper-status":"Down","encap-type":"null"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/interface/trustsec":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get policy filter memory usage from device","operationId":"trustsec","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy filter memory usage":{"description":"Policy filter memory usage","value":{"data":[{"mode":"cts-ndac-mode-manual","if-name":"GigabitEthernet2","sgt-propagate":"cts-sgt-propagate-enabled","vdevice-dataKey":"169.254.10.13-vm6-GigabitEthernet2","vdevice-name":"169.254.10.13","trusted":"cts-manual-untrusted","lastupdated":1654654895429,"peer-sgt":0,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/interface/vpn":{"get":{"tags":["Real-Time Monitoring - Interface"],"description":"Get device interfaces per VPN","operationId":"generateDeviceInterfaceVPN","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device interface":{"description":"Device interface","value":{"data":[{"index":0,"vpnId":"0","ifname":"ge0/1"},{"index":1,"vpnId":"0","ifname":"ge0/2"},{"index":2,"vpnId":"0","ifname":"ge0/3"},{"index":3,"vpnId":"0","ifname":"ge0/4"},{"index":4,"vpnId":"0","ifname":"ge0/5"},{"index":5,"vpnId":"0","ifname":"ge0/6"},{"index":6,"vpnId":"0","ifname":"ge0/7"},{"index":7,"vpnId":"0","ifname":"system"},{"index":8,"vpnId":"1","ifname":"ge0/0"},{"index":9,"vpnId":"512","ifname":"eth0"},{"index":10,"vpnId":"65528","ifname":"loopback65528"},{"index":11,"vpnId":"65530","ifname":"loopback65530"},{"index":12,"vpnId":"65530","ifname":"loopback65531"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/ip/fib":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get FIB list from device (Real Time)","operationId":"createFibList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"address-family","in":"query","description":"Address family","schema":{"type":"string","enum":["IPv4","IPv6"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"tloc","in":"query","description":"tloc IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FIB list":{"description":"FIB list","value":{"data":[{"nexthop-address":"10.0.5.13","vdevice-dataKey":"172.16.255.21-0-0.0.0.0/0","vdevice-name":"172.16.255.21","prefix":"0.0.0.0/0","lastupdated":1649641392351,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.5.0/24","vdevice-name":"172.16.255.21","prefix":"10.0.5.0/24","lastupdated":1649641392351,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.5.21/32","vdevice-name":"172.16.255.21","prefix":"10.0.5.21/32","lastupdated":1649641392351,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.100.0/24","vdevice-name":"172.16.255.21","prefix":"10.0.100.0/24","lastupdated":1649641392351,"out-ifname":"ge0/7","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-10.0.100.21/32","vdevice-name":"172.16.255.21","prefix":"10.0.100.21/32","lastupdated":1649641392351,"out-ifname":"ge0/7","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-100.0.0.0/24","vdevice-name":"172.16.255.21","prefix":"100.0.0.0/24","lastupdated":1649641392351,"out-ifname":"ge0/6","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"vdevice-dataKey":"172.16.255.21-0-100.0.0.11/32","vdevice-name":"172.16.255.21","prefix":"100.0.0.11/32","lastupdated":1649641392351,"out-ifname":"ge0/6","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"},{"nexthop-address":"100.0.0.1","vdevice-dataKey":"172.16.255.21-0-100.2.0.0/24","vdevice-name":"172.16.255.21","prefix":"100.2.0.0/24","lastupdated":1649641392351,"out-ifname":"ge0/6","vpn-id":0,"vdevice-host-name":"vm11","address-family":"ipv4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/ipRoutes":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get ietf routing list from device","operationId":"createIetfRoutingList","parameters":[{"name":"routing-instance-name","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"address-family","in":"query","description":"Address family","schema":{"type":"string"}},{"name":"outgoing-interface","in":"query","description":"Outgoing Interface","schema":{"type":"string"}},{"name":"source-protocol","in":"query","description":"Source Protocol","schema":{"type":"string"}},{"name":"next-hop-address","in":"query","description":"Next Hop Address","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ietf routing list":{"description":"ietf routing list","value":{"data":[{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"0.0.0.0/0","route-source-protocol":"static","next-hop-next-hop-address":"10.102.254.254","routing-instance-name":"default","protocol-name":"0","route-route-preference":"1","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","route-metric":"0","lastupdated":1645080304580},{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"10.101.0.0/16","route-source-protocol":"direct","next-hop-next-hop-address":"0.0.0.0","routing-instance-name":"default","protocol-name":"0","route-route-preference":"0","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","next-hop-outgoing-interface":"GigabitEthernet3","route-metric":"0","lastupdated":1645080304580},{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"10.101.5.5/32","route-source-protocol":"direct","next-hop-next-hop-address":"0.0.0.0","routing-instance-name":"default","protocol-name":"0","route-route-preference":"0","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","next-hop-outgoing-interface":"GigabitEthernet3","route-metric":"0","lastupdated":1645080304580},{"protocol-type":"direct","vdevice-name":"169.254.10.12","route-destination-prefix":"10.102.0.0/16","route-source-protocol":"direct","next-hop-next-hop-address":"0.0.0.0","routing-instance-name":"default","protocol-name":"0","route-route-preference":"0","vdevice-host-name":"vm5","rib-default-rib":"false","rib-address-family":"ipv4","vdevice-dataKey":"169.254.10.12--","router-id":"0.0.0.0","next-hop-outgoing-interface":"GigabitEthernet5","route-metric":"0","lastupdated":1645080304580}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/mfiboil":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get IP MFIB OIL list from device (Real Time)","operationId":"createIPMfibOilList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP MFIB OIL list":{"description":"IP MFIB OIL list","value":{"data":[{"vdevice-dataKey":"169.254.10.11-10-","vdevice-name":"169.254.10.11","lastupdated":1654849997281,"source":"0.0.0.0","vpn-id":10,"vdevice-host-name":"vm4","group":"224.0.1.39"},{"vdevice-dataKey":"169.254.10.11-10-","vdevice-name":"169.254.10.11","lastupdated":1654849997281,"source":"0.0.0.0","vpn-id":10,"vdevice-host-name":"vm4","group":"224.0.1.40"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/mfibstats":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get IP MFIB statistics list from device (Real Time)","operationId":"createIPMfibStatsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP MFIB statistics list":{"description":"IP MFIB statistics list","value":{"data":[{"tx-octet-rate":0,"tx-pkts":0,"vdevice-name":"169.254.10.11","rx-octet-rate":0,"rx-packet-rate":0,"source":"0.0.0.0","rpf-failure":0,"vpn-id":10,"vdevice-host-name":"vm4","tx-packet-rate":0,"tx-policy-drop":0,"avg_replication":"0.00","vdevice-dataKey":"169.254.10.11-10-","rx-policy-drop":0,"tx-octets":0,"rx-octets":0,"tx-to-pim-pkts":0,"lastupdated":1654850155929,"tx-invalid-oil-failure":0,"rx-pkts":"0","group":"224.0.1.39"},{"tx-octet-rate":0,"tx-pkts":0,"vdevice-name":"169.254.10.11","rx-octet-rate":0,"rx-packet-rate":0,"source":"0.0.0.0","rpf-failure":0,"vpn-id":10,"vdevice-host-name":"vm4","tx-packet-rate":0,"tx-policy-drop":0,"avg_replication":"0.00","vdevice-dataKey":"169.254.10.11-10-","rx-policy-drop":0,"tx-octets":0,"rx-octets":0,"tx-to-pim-pkts":0,"lastupdated":1654850155929,"tx-invalid-oil-failure":0,"rx-pkts":"0","group":"224.0.1.40"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/mfibsummary":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get IP MFIB summary list from device (Real Time)","operationId":"createIPMfibSummaryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP MFIB summary list":{"description":"IP MFIB summary list","value":{"data":[{"upstream-tunnel":"0.0.0.0","vdevice-dataKey":"169.254.10.11-10-224.0.1.39","vdevice-name":"169.254.10.11","upstream-if":"---","lastupdated":1654850209775,"source":"0.0.0.0","vpn-id":10,"num-tunnel-oils":"0","vdevice-host-name":"vm4","group":"224.0.1.39","num-service-oils":"0"},{"upstream-tunnel":"0.0.0.0","vdevice-dataKey":"169.254.10.11-10-224.0.1.40","vdevice-name":"169.254.10.11","upstream-if":"---","lastupdated":1654850209775,"source":"0.0.0.0","vpn-id":10,"num-tunnel-oils":"0","vdevice-host-name":"vm4","group":"224.0.1.40","num-service-oils":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/filter":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT filter list from device","operationId":"createNatFilterList","parameters":[{"name":"nat-vpn-id","in":"query","description":"NAT VPN Id","schema":{"type":"string"}},{"name":"nat-ifname","in":"query","description":"NAT interface name","schema":{"type":"string"}},{"name":"private-source-address","in":"query","description":"Private source address","schema":{"type":"string"}},{"name":"proto","in":"query","description":"Protocol","schema":{"type":"string","enum":["icm","tcp","udp"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT filter list":{"description":"NAT filter list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","nat-vpn-id":"0","nat-ifname":"ge0/0","private-vpn-id":"0","proto":"icmp","private-source-address":"10.1.15.15","private-dest-address":"10.1.14.14","private-source-port":"4697","public-source-address":"10.1.15.15","public-dest-address":"10.1.14.14","public-source-port":"64931","public-dest-port":"64931","filter-state":"established","idle-timeout":"0:00:00:41","idle-timeout-date":"-","outbound-packets":"1","outbound-octets":"98","inbound-packets":"1","inbound-octets":"98","lastupdated":1657853484627,"vdevice-dataKey":"172.16.254.1-10-224.0.1.40"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/interface":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT interface list from device (Real Time)","operationId":"createNatInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT interface list":{"description":"NAT interface list","value":{"data":[{"fib-filter-count":0,"vdevice-name":"169.254.10.9","lastupdated":1654525771150,"vpn-id":0,"vdevice-dataKey":"169.254.10.9-0","mapping-type":"endpoint-independent","filter-count":0,"vdevice-host-name":"vm2","ifname":"ipsec10","filter-type":"address-port-restricted"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/interfacestatistics":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT interface statistics list from device","operationId":"createNatInterfaceStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT interface statistics list":{"description":"NAT interface statistics list","value":[{"out2in-drops":0,"in2out-drops":0,"vdevice-dataKey":"172.16.255.15-0-0","vdevice-host-name":"vm5","initialized":9223372036854776000,"entry-timeouts":0,"pool-stats-drop":"0","limit-entry-add-fail":"0","outsides":0,"packets-punted":"0","lastupdated":1645079319277,"mapping-stats-drop":"0","misses":0,"interrupt-switched":0,"frag-pak-count":"0","statics":0,"flows":0,"entries":"0","vdevice-name":"172.16.255.15","hits":0,"portlist-req-fail":"0","ipalias-add-fail":0,"insides":0,"statics-sorted":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat/translation":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT translation list from device (Real Time)","operationId":"createNatTranslationList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT translation list":{"description":"NAT translation list","value":{"data":[{"inside-local-addr":"10.1.15.15","outside-local-port":"50","vdevice-name":"172.16.255.15","inside-global-port":"50","flags":"0","outside-global-port":"50","vdevice-host-name":"vm5","vrfid":"0","protocol":"1","outside-local-addr":"10.1.16.16","vdevice-dataKey":"172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-50","outside-global-addr":"10.1.16.16","inside-local-port":"50","lastupdated":1651038839092,"application-type":"0","inside-global-addr":"10.1.15.15"},{"inside-local-addr":"10.1.15.15","outside-local-port":"51","vdevice-name":"172.16.255.15","inside-global-port":"51","flags":"0","outside-global-port":"51","vdevice-host-name":"vm5","vrfid":"0","protocol":"1","outside-local-addr":"10.1.16.16","vdevice-dataKey":"172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-51","outside-global-addr":"10.1.16.16","inside-local-port":"51","lastupdated":1651038839092,"application-type":"0","inside-global-addr":"10.1.15.15"},{"inside-local-addr":"10.1.15.15","outside-local-port":"49","vdevice-name":"172.16.255.15","inside-global-port":"49","flags":"0","outside-global-port":"49","vdevice-host-name":"vm5","vrfid":"0","protocol":"1","outside-local-addr":"10.1.16.16","vdevice-dataKey":"172.16.255.15-10.1.15.15-10.1.16.16-10.1.15.15-10.1.16.16-49","outside-global-addr":"10.1.16.16","inside-local-port":"49","lastupdated":1651038839092,"application-type":"0","inside-global-addr":"10.1.15.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/nat64/translation":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get NAT64 interface list from device","operationId":"createNat64TranslationList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NAT64 interface list":{"description":"NAT64 interface list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vrf-name":"1","protocol":"icmp","orig-ipv6-src-addr":"2001:DB8:3001::9","orig-ipv6-dst-addr":"2800:1503:2000:1:1::0a01:7102","orig-src-port":2654,"orig-dst-port":2654,"translated-src-addr":"10.1.113.2","translated-dst-addr":"50.50.50.50","translated-src-port":"2654","translated-dst-port":"2654","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/routetable":{"get":{"tags":["Real-Time Monitoring - IP"],"description":"Get route table list from device (Real Time)","operationId":"createRouteTableList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"address-family","in":"query","description":"Address family","schema":{"type":"string","enum":["IPv4","IPv6"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"protocol","in":"query","description":"IP protocol","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Route table list":{"description":"Route table list","value":{"data":[{"rstatus":"F S","protocol":"static","vdevice-dataKey":"169.254.10.10-0-0.0.0.0/0","vdevice-name":"169.254.10.10","prefix":"0.0.0.0/0","lastupdated":1643160579908,"nexthop-addr":"10.101.254.254","vpn-id":0,"nexthop-type":"ipv4","vdevice-host-name":"vm3","address-family":"ipv4","nexthop-ifname":"ge0/1"},{"color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.5.0/24","ip":"172.16.254.4","encap":"ipsec","vpn-id":10,"nexthop-label":"1047","nexthop-type":"ipv4-indirect","vdevice-host-name":"vm3","rstatus":"F S","protocol":"omp","vdevice-dataKey":"169.254.10.10-10-10.0.5.0/24","lastupdated":1643160579908,"address-family":"ipv4"},{"rstatus":"F S","protocol":"connected","vdevice-dataKey":"169.254.10.10-512-fcff::/120","vdevice-name":"169.254.10.10","prefix":"fcff::/120","lastupdated":1643160579908,"vpn-id":512,"nexthop-type":"ipv6","vdevice-host-name":"vm3","address-family":"ipv6","nexthop-ifname":"loop0.2"},{"rstatus":"F S","protocol":"connected","vdevice-dataKey":"169.254.10.10-65528-192.168.0.0/24","vdevice-name":"169.254.10.10","prefix":"192.168.0.0/24","lastupdated":1643160579908,"vpn-id":65528,"nexthop-type":"ipv4","vdevice-host-name":"vm3","address-family":"ipv4","nexthop-ifname":"loopback65528"},{"rstatus":"F S","protocol":"connected","vdevice-dataKey":"169.254.10.10-65530-192.168.0.0/24","vdevice-name":"169.254.10.10","prefix":"192.168.0.0/24","lastupdated":1643160579908,"vpn-id":65530,"nexthop-type":"ipv4","vdevice-host-name":"vm3","address-family":"ipv4","nexthop-ifname":"loopback65530"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/v4fib":{"get":{"tags":["Real-Time Monitoring - IPv4 FIB"],"description":"Get IPv4 FIB list from device (Real Time)","operationId":"createIPv4FibList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"tloc","in":"query","description":"tloc IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FIB list":{"description":"FIB list","value":{"data":[{"path-id":1,"vdevice-dataKey":"169.254.10.10-512-10.0.1.0/24","vdevice-name":"169.254.10.10","prefix":"10.0.1.0/24","lastupdated":1643096072514,"out-ifname":"eth0","vpn-id":512,"vdevice-host-name":"vm3"},{"path-id":1,"vdevice-dataKey":"169.254.10.10-512-10.0.1.3/32","vdevice-name":"169.254.10.10","prefix":"10.0.1.3/32","lastupdated":1643096072514,"out-ifname":"eth0","vpn-id":512,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ip/v6fib":{"get":{"tags":["Real-Time Monitoring - IPv6 FIB"],"description":"Get IPv6 FIB list from device (Real Time)","operationId":"createIPv6FibList","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"prefix","in":"query","description":"IP prefix","schema":{"type":"string"}},{"name":"tloc","in":"query","description":"tloc IP","schema":{"type":"string"}},{"name":"color","in":"query","description":"tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"FIB list":{"description":"FIB list","value":{"data":[{"path-id":1,"vdevice-dataKey":"169.254.10.10-0-fe80::3274:7d86:eb7f:4a3c/128","vdevice-name":"169.254.10.10","prefix":"fe80::3274:7d86:eb7f:4a3c/128","lastupdated":1643096311251,"out-ifname":"vmanage_system","vpn-id":0,"vdevice-host-name":"vm3"},{"path-id":1,"vdevice-dataKey":"169.254.10.10-0-fe80::40b8:4592:c183:592c/128","vdevice-name":"169.254.10.10","prefix":"fe80::40b8:4592:c183:592c/128","lastupdated":1643096311251,"out-ifname":"system","vpn-id":0,"vdevice-host-name":"vm3"},{"path-id":1,"vdevice-dataKey":"169.254.10.10-0-fe80::5054:ff:fea1:4f47/128","vdevice-name":"169.254.10.10","prefix":"fe80::5054:ff:fea1:4f47/128","lastupdated":1643096311251,"out-ifname":"ge0/1","vpn-id":0,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/ipsec/identity":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get Crypto IPSEC identity entry from device","operationId":"createCryptoIpsecIdentity","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crypto IPSEC identity entry":{"description":"Crypto IPSEC identity entry","value":{"data":[{"vdevice-name":"169.254.10.12","local-ident-addr":"10.102.5.5","local-endpt-addr":"10.102.5.5","remote-ident-protocol":"0","interface":"Tunnel5","vpn-id":"0","vdevice-host-name":"vm5","local-ident-mask":"255.255.255.255","local-ident-protocol":"0","vdevice-dataKey":"169.254.10.12","plaintext-mtu":"1438","lastupdated":1644890148156,"remote-ident-addr":"10.101.3.3","remote-endpt-addr":"10.101.3.3","remote-ident-mask":"255.255.255.255","dh-group":"crypto-dh-grouptype-none"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ike/inbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec IKE inbound connection list from device","operationId":"createIkeInboundList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec IKE local inbound connection list":{"description":"IPsec IKE local inbound connection list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","source-ip":"2.2.2.2","source-port":"4500","dest-ip":"3.3.3.3","dest-port":"4500","new-spi":"257","old-spi":"256","cipher-suite":"aes256-cbc-sha1","new-key-hash":"****01be","old-key-hash":"****a0df","ext-seq":"11","lastupdated":"1654066322656","vdevice-dataKey":"169.254.10.9-10-ipsec1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ike/outbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec IKE outbound connection list from device","operationId":"createIkeOutboundList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec IKE outbound connection list":{"description":"IPsec IKE outbound connection list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","source-ip":"2.2.2.2","source-port":"4500","dest-ip":"3.3.3.3","dest-port":"4500","spi":"257","cipher-suite":"aes256-cbc-sha1","keyhash":"****55b5","tunnel-mtu":"1418","ext-seq":"11","lastupdated":"1654066322656","vdevice-dataKey":"169.254.10.9-10-ipsec1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ike/sessions":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec IKE sessions from device","operationId":"createIkeSessions","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec IKE sessions":{"description":"IPsec IKE sessions","value":{"data":[{"dest-ip":"3.3.3.3","source-port":4500,"vdevice-name":"169.254.10.9","vpn-id":"10","version":"1","vdevice-host-name":"vm2","uptime":"0:00:00:00","if-name":"ipsec1","dest-port":4500,"vdevice-dataKey":"169.254.10.9-10-ipsec1","cipher-suite":"aes256-cbc-sha1","lastupdated":1654066322656,"source-ip":"2.2.2.2","state":"INTF_CREATED","uptime-date":1654066320000,"dh-group":"16 (MODP-4096)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ikev1":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get Crypto IKEv1 SA entry from device","operationId":"createCryptov1LocalSAList","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crypto IKEv1 SA entry":{"description":"Crypto IKEv1 SA entry","value":{"data":[{"init-spi":"NzA4MjczNjM1RTYwOUE0MQ==","remote-ip-addr":"10.1.16.16","vdevice-name":"172.16.255.15","sa-status":"crypto-sa-status-active","lifetime":84025,"vdevice-host-name":"vm5","local-ip-addr":"10.1.15.15","my-auth-method":"crypto-ikev2-auth-psk","ivrf":"none","local-port":500,"peer-auth-method":"crypto-ikev2-auth-psk","vdevice-dataKey":"172.16.255.15","fvrf":"none","resp-spi":"MDkzRDYwQ0YwQzUxMDcxMg==","encr-alg":"crypto-encr-alg-aes-cbc","remote-port":500,"hash-algo":"crypto-hash-alg-auth-hmac-sha256","lastupdated":1657094847813,"sa-id":"1002","dh-group":"crypto-dh-grouptype-group16"},{"init-spi":"NTlCQjQyNzVEOURCMEExNg==","remote-ip-addr":"10.1.16.16","vdevice-name":"172.16.255.15","sa-status":"crypto-sa-status-active","lifetime":84026,"vdevice-host-name":"vm5","local-ip-addr":"10.1.15.15","my-auth-method":"crypto-ikev2-auth-psk","ivrf":"none","local-port":500,"peer-auth-method":"crypto-ikev2-auth-psk","vdevice-dataKey":"172.16.255.15","fvrf":"none","resp-spi":"RTlFMUZEN0VCQUZGNDNGQQ==","encr-alg":"crypto-encr-alg-aes-cbc","remote-port":500,"hash-algo":"crypto-hash-alg-auth-hmac-sha256","lastupdated":1657094847813,"sa-id":"1003","dh-group":"crypto-dh-grouptype-group16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/ikev2":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get Crypto IKEv2 SA entry from device","operationId":"createCryptov2LocalSAList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Crypto IKEv2 SA entry":{"description":"Crypto IKEv2 SA entry","value":{"data":[{"init-spi":"MkVENzFDRUMxODUyNDVDNA==","remote-ip-addr":"10.1.16.16","vdevice-name":"172.16.255.15","sa-status":"crypto-sa-status-active","lifetime":86400,"vdevice-host-name":"vm5","local-ip-addr":"10.1.15.15","my-auth-method":"crypto-ikev2-auth-psk","ivrf":"1","local-port":500,"peer-auth-method":"crypto-ikev2-auth-psk","vdevice-dataKey":"172.16.255.15","fvrf":"none","resp-spi":"MzY1RjFGMUMxODgxNTY5Qg==","encr-alg":"crypto-encr-alg-aes-cbc","remote-port":500,"hash-algo":"crypto-hash-alg-auth-hmac-sha512","lastupdated":1657274365619,"sa-id":"1","dh-group":"crypto-dh-grouptype-group24"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/inbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec inbound connection list from device (Real Time)","operationId":"createInBoundList","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec inbound connection list":{"description":"IPsec inbound connection list","value":{"data":[{"dest-ip":"10.101.3.3","source-port":12386,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.1","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.101.2.2","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.3","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.101.4.4","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.4","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.102.5.5","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.5","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.102.6.6","remote-tloc-color":"default","local-tloc-color":"default"},{"dest-ip":"10.101.3.3","source-port":12406,"vdevice-name":"169.254.10.10","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.16","negotiated-encryption-algo":"AES-GCM-256","dest-port":12406,"vdevice-dataKey":"169.254.10.10-172.16.254.2","local-tloc-address":"172.16.254.2","lastupdated":1643163071849,"source-ip":"10.102.16.16","remote-tloc-color":"default","local-tloc-color":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/localsa":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec local SA list from device","operationId":"createLocalSAList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec local SA list":{"description":"IPsec local SA list","value":{"data":[{"tloc-color":"default","vdevice-dataKey":"169.254.10.10-172.16.254.2","vdevice-name":"169.254.10.10","port":12406,"tloc-address":"172.16.254.2","ipv6":"::","ip":"10.101.3.3","lastupdated":1643166514716,"encrypt-key-hash":"*****386b","spi":"286","auth-key-hash":"*****386b","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/outbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPsec outbound connection list from device (Real Time)","operationId":"createOutBoundList","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IPsec outbound connection list":{"description":"IPsec outbound connection list","value":{"data":[{"dest-ip":"10.101.2.2","integrity-used":"ip-udp-esp","source-port":12426,"vdevice-name":"169.254.10.10","spi":262,"auth-key-hash":"*****2450","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.1","dest-port":12386,"vdevice-dataKey":"169.254.10.10-10.101.3.3","tunnel-mtu":1441,"lastupdated":1643334538276,"source-ip":"10.101.3.3","remote-tloc-color":"default","encrypt-key-hash":"*****2450"},{"dest-ip":"10.101.4.4","integrity-used":"ip-udp-esp","source-port":12426,"vdevice-name":"169.254.10.10","spi":289,"auth-key-hash":"*****3b7e","vdevice-host-name":"vm3","remote-tloc-address":"172.16.254.3","dest-port":12366,"vdevice-dataKey":"169.254.10.10-10.101.3.3","tunnel-mtu":1441,"lastupdated":1643334538276,"source-ip":"10.101.3.3","remote-tloc-color":"default","encrypt-key-hash":"*****3b7e"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/pwk/inbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPSEC pairwise key inbound entry from device","operationId":"createIPsecPWKInboundConnections","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPSEC pairwise key inbound entry":{"description":"IPSEC pairwise key inbound entry","value":{"data":[{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.1","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066644,"remote-tloc-color":"lte","source-ip":"10.102.2.2","local-tloc-color":"default","sa-index":"7","remote-tloc-index":"32775"},{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.1","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066644,"remote-tloc-color":"3g","source-ip":"10.101.2.2","local-tloc-color":"default","sa-index":"19","remote-tloc-index":"32781"},{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.2","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066644,"remote-tloc-color":"lte","source-ip":"10.102.3.3","local-tloc-color":"default","sa-index":"11","remote-tloc-index":"32777"},{"dest-ip":"10.101.5.5","local-tloc-index":"32770","source-port":"12366","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","is-ah-auth":"true","pwk-spi":"0","vdevice-host-name":"vm5","pkey-id":"0","ss-hash":" ","remote-tloc-address":"172.16.254.2","dest-port":"12346","vdevice-dataKey":"169.254.10.12","d-key-hash":" ","local-tloc-address":"172.16.254.4","lastupdated":1645154066645,"remote-tloc-color":"3g","source-ip":"10.101.3.3","local-tloc-color":"default","sa-index":"9","remote-tloc-index":"32776"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/pwk/localsa":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPSEC pairwise key local SA entry from device","operationId":"createIPsecPWKLocalSA","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPSEC pairwise key local SA entry":{"description":"IPSEC pairwise key local SA entry","value":{"data":[{"tloc-color":"default","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32770","ip":"10.101.5.5","spi":"262","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"9"},{"tloc-color":"default","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32770","ip":"10.101.5.5","spi":"263","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"11"},{"tloc-color":"3g","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32771","ip":"10.102.5.5","spi":"262","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"10"},{"tloc-color":"3g","pkey-hash":" ","vdevice-name":"169.254.10.12","nonce-hash":" ","tloc-address":"172.16.254.4","tloc-index":"32771","ip":"10.102.5.5","spi":"263","vdevice-host-name":"vm5","pkey-id":"0","vdevice-dataKey":"169.254.10.12","port":"12346","lastupdated":1645153823323,"sa-index":"12"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipsec/pwk/outbound":{"get":{"tags":["Real-Time Monitoring - IPsec"],"description":"Get IPSEC pairwise key outbound entry from device","operationId":"createIPsecPWKOutboundConnections","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPSEC pairwise key outbound entry":{"description":"IPSEC pairwise key outbound entry","value":{"data":[{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"a600","local-tloc-color":"lte","dest-ip":"10.0.5.11","source-ip":"10.1.15.15","remote-tloc-index":"32772","lastupdated":1645156239932,"sa-index":"183","remote-tloc-address":"172.16.255.11","tloc-index":"32772","dest-port":"12367","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"},{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"b13e","local-tloc-color":"lte","dest-ip":"10.0.5.21","source-ip":"10.1.15.15","remote-tloc-index":"32771","lastupdated":1645156239933,"sa-index":"182","remote-tloc-address":"172.16.255.21","tloc-index":"32771","dest-port":"12377","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"},{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"59f1","local-tloc-color":"lte","dest-ip":"10.1.14.14","source-ip":"10.1.15.15","remote-tloc-index":"32774","lastupdated":1645156239933,"sa-index":"184","remote-tloc-address":"172.16.255.14","tloc-index":"32774","dest-port":"12366","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"},{"pkey-id":"0","vdevice-dataKey":"172.16.255.15","nonce-hash":" ","pkey-hash":" ","vdevice-host-name":"vm5","e-key-hash":"61b6","local-tloc-color":"lte","dest-ip":"10.1.16.16","source-ip":"10.1.15.15","remote-tloc-index":"32773","lastupdated":1645156239933,"sa-index":"181","remote-tloc-address":"172.16.255.16","tloc-index":"32773","dest-port":"12366","source-port":"12346","local-tloc-index":"32770","vdevice-name":"172.16.255.15","remote-tloc-color":"lte","ss-hash":" ","spi":"302","local-tloc-address":"172.16.255.15","is-ah-auth":"true","pwk-spi":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/ipv6/nd6":{"get":{"tags":["Real-Time Monitoring - Device"],"description":"Get ipv6 data from device","operationId":"getIpv6Data","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IP v6 data":{"description":"IP v6 data","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vrf-name":"8","if-name":"Et0/0","ip":"FE80::A8BB:CCFF:FE01:F500","mac-address":"AA:BB:CC:01:F5:00","state":"REACHABLE","idle-timer":"8850","uptime":"01:34:16","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/keyvalue":{"get":{"tags":["Monitoring - Device Details"],"description":"Get vEdge inventory as key value (key as systemIp value as hostName)","operationId":"getDeviceListAsKeyValue","parameters":[{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vEdge inventory":{"description":"vEdge inventory","value":{"header":{"generatedOn":1635297986225},"data":[{"key":"172.16.255.128","value":"vm128 (172.16.255.128)"},{"key":"172.16.253.129","value":"vm129 (172.16.253.129)"},{"key":"172.16.255.130","value":"vm130 (172.16.255.130)"},{"key":"172.16.253.131","value":"vm131 (172.16.253.131)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/lacp/info":{"get":{"tags":["Real-Time Monitoring - Lacp"],"description":"Get device lacp port channel info list (Real Time)","operationId":"getLacpInterfaceList","parameters":[{"name":"channel-group","in":"query","description":"Channel-group","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device lacp info":{"description":"Device lacp info","value":{"data":[{"ayer-type":"l3-etherchannel","vdevice-name":"10.0.0.121","channel-group":"1","vdevice-host-name":"ISR4451-X","total-no-of-links-bundled":2,"total-no-of-links-standby":0,"total-no-of-links-down":0,"vdevice-dataKey":"10.0.0.121-1","total-no-of-links":2,"port-channel-up":"true","lastupdated":1650883014316,"total-no-of-links-suspended":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/lacp/members":{"get":{"tags":["Real-Time Monitoring - Lacp"],"description":"Get device lacp port channel interface table (Real Time)","operationId":"getLacpMembers","parameters":[{"name":"channel-group","in":"query","description":"Channel-group","schema":{"type":"string"}},{"name":"ifName","in":"query","description":"Interface Name","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device lacp port channel interface":{"description":"Device lacp port channel interface","value":{"data":[{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":4,"routing-interface":"Vlan1","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1","vlan":"1","tx-octets":"0","tx-packets":"0","name":"default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1002","vlan":"1002","tx-octets":"0","tx-packets":"0","name":"fddi-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1002","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1003","vlan":"1003","tx-octets":"0","tx-packets":"0","name":"token-ring-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1003","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1004","vlan":"1004","tx-octets":"0","tx-packets":"0","name":"fddinet-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1004","flood-octets":"0","tx-routed-packets":"0","age":0},{"flood-packets":"0","max-macs":1024,"move":0,"vdevice-name":"10.0.0.121","learn":0,"age-time":300,"rx-packets":"0","rx-routed-packets":"0","num-macs":0,"routing-interface":"null","vdevice-host-name":"ISR4451-X","vdevice-dataKey":"10.0.0.121-1005","vlan":"1005","tx-octets":"0","tx-packets":"0","name":"trnet-default","rx-octets":"0","lastupdated":1650882963285,"bridge-id":"1005","flood-octets":"0","tx-routed-packets":"0","age":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/license/evaluation":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license evaluation info from device","operationId":"getLicenseEvalInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License evaluation info":{"description":"License evaluation info","value":{"data":[{"vdevice-dataKey":"169.254.10.14","vdevice-name":"169.254.10.14","lastupdated":1646031617468,"eval-expired":"false","eval-in-use":"false","time-left":"0","vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/pak":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license pak info from device","operationId":"getLicensePAKInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License pak info":{"description":"License pak info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","singleton_id":10,"store":"Primary License Storage","storeindex":0,"version":"1.0","feature_name":"test_subscr","type":"Evaluation","state":"Active, Not in Use, EULA accepted","count":"Non-Counted","priority":"Low","lastupdated":660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/privacy":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license privacy info from device","operationId":"getLicensePrivacyInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License privacy info":{"description":"License privacy info","value":{"data":[{},{"lastupdated":1646030987293,"hostname":"false","vdevice-dataKey":"169.254.10.14","vdevice-name":"169.254.10.14","version":"false","vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/registration":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license registration info from device","operationId":"getLicenseRegInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License info":{"description":"License info","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","always-enabled":"true","lastupdated":1645754331129,"vdevice-host-name":"vm5","smart-enabled":"false"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/udi":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license UDI info from device","operationId":"getLicenseUDIInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License UDI info":{"description":"License UDI info","value":{"data":[{"mac-address":"00:00:00:00:00:00","vdevice-dataKey":"169.254.10.14","vdevice-name":"169.254.10.14","lastupdated":1646030100474,"pid":"CSR1000V","sn":"9PBHZUBMD18","vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/license/usage":{"get":{"tags":["Real-Time Monitoring - License Info"],"description":"Get license usage info from device","operationId":"getLicenseUsageInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"License usage info":{"description":"License usage info","value":{"data":[{"vdevice-name":"172.16.254.4","vdevice-host-name":"vm5","entitlement-tag":"WAN_License","short-name":"-","license-name":"WAN_License","description":"-","count":"8","enforcement-mode":"Blocking","post-paid":"false","subscription-id":"968BA1CF-C146-4ADF-A300-308DCF718EEE","lastupdated":1646031617468,"vdevice-dataKey":"172.16.254.4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/logging":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get logging from device (Real Time)","operationId":"getLoggingFromDevice","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Logging":{"description":"Logging","value":{"data":[{"disk_priority":"info","disk_filerotate":10,"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","host_priority":"emerg","lastupdated":1643178776334,"disk_status":"enabled","disk_filename":"vsyslog","disk_filesize":10,"host_status":"disabled","host_vpn_id":0,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/models":{"get":{"tags":["Monitoring - Device Details"],"description":"Get all device models supported by the vManage","operationId":"listAllDeviceModels","parameters":[{"name":"list","in":"query","required":true,"schema":{"type":"string","default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceModelsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/models/{uuid}":{"get":{"tags":["Monitoring - Device Details"],"description":"Get device model for the device","operationId":"getDeviceModels","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device model":{"description":"Device model","value":{"name":"vedge-cloud","displayName":"vEdge Cloud","deviceType":"vedge","isCliSupported":true,"templateSupported":true,"deviceClass":"viptela-router","cpuCountAttribute":{"enable":true,"attributeField":"linux_cpu_count"},"onboardCert":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/monitor":{"get":{"tags":["Monitoring - Device Details"],"description":"Get all monitoring details of the devices","operationId":"listAllMonitorDetailsDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitor device details":{"description":"Monitor device details","value":{"header":{"generatedOn":1635227574211,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-MonitorDeviceDetails"},"columns":[{"title":"Status","property":"status","display":"icon","iconProperty":"status-icon","colorProperty":"status-color","hideable":false,"dataType":"string"},{"title":"Device Type","property":"device-type","display":"keyvalue","keyvalueProperty":"device-type","keyvalue":[{"key":"vsmart","value":"vSmart"},{"key":"vbond","value":"vBond"},{"key":"vmanage","value":"vManage"},{"key":"vedge","value":"WAN Edge"}],"dataType":"string"}],"fields":[{"property":"status","dataType":"string","display":"icon"},{"property":"host-name","dataType":"string","display":"iconAndText"}]},"data":[{"device-model":"vmanage","device-type":"vmanage","system-ip":"169.254.10.1","host-name":"vm200","site-id":"200","layoutLevel":1,"status":"normal"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/multicast/replicator":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get replicator list from device","operationId":"createReplicatorList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Replicator list":{"description":"Replicator list","value":{"data":[{"vdevice-dataKey":"169.254.10.9","vdevice-name":"169.254.10.9","replicator-status":"UP","replicator-address":"172.16.254.1","lastupdated":1655109179818,"vpn-id":"10","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/multicast/rpf":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get RPF list from device","operationId":"createRpfList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"RPF list":{"description":"RPF list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","rpf-address":"10.20.25.18","rpf-status":"resolved","nexthop-count":"1","nbr-addr":"-","rpf-if-name":"ge0/4","rpf-tunnel":"-","vdevice-dataKey":"172.16.254.1","lastupdated":1644997246553}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/multicast/topology":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get topology list from device","operationId":"createTopologyList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topology list":{"description":"Topology list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","group":"225.0.0.0","source":"0.0.0.0","join-type":"(*,G)","rp-address":"58.0.1.100","replicator":"172.16.255.14","upstream-neighbor":"172.16.255.14","upstream-state":"joined","upstream-interface":"172.16.255.14","up-time":"0:01:26:52","up-time-date":"18 07 2022 16:26:52 A z","expires":"0:00:00:31","expires-date":"20 07 2022 16:26:52 A z","oif-tunnel":"-","vdevice-dataKey":"172.16.254.1","lastupdated":1644997246553},{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","group":"225.0.0.9","source":"56.0.1.100","join-type":"(*,G)","rp-address":"-","replicator":"-","upstream-neighbor":"56.0.1.100","upstream-state":"joined","upstream-interface":"ge0/0","up-time":"0:16:26:52","up-time-date":"18 07 2022 16:26:52 A z","expires":"0:16:26:52","expires-date":"20 07 2022 16:26:52 A z","oif-tunnel":"172.16.255.14","vdevice-dataKey":"172.16.254.1","lastupdated":1644997246553}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/multicast/tunnel":{"get":{"tags":["Real-Time Monitoring - Multicast"],"description":"Get PIM tunnel from device","operationId":"createPimTunnelList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PIM tunnel":{"description":"PIM tunnel","value":{"data":[{"tunnel-status":"UP","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","replicator":"no","lastupdated":1643179140806,"vpn-id":"10","vdevice-host-name":"vm3","tunnel-address":"172.16.254.1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ndv6":{"get":{"tags":["Real-Time Monitoring - IPv6 Neighbours"],"description":"Get IPv6 Neighbors from device (Real Time)","operationId":"getIpv6Interface","parameters":[{"name":"vpn-id","in":"query","description":"VPN Id","schema":{"type":"string","enum":["0","512"]}},{"name":"if-name","in":"query","description":"Interface name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"mac","in":"query","description":"Mac address","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IPv6 Neighbors":{"description":"IPv6 Neighbors","value":{"data":[{"if-name":"ge0/1","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"fe80::5054:ff:fea1:4f47","lastupdated":1643172402186,"state":"static","vpn-id":"0","uptime-date":1642659240000,"vdevice-host-name":"vm3","mac":"52:54:00:a1:4f:47","uptime":"5:22:32:19"},{"if-name":"ge0/1","idle-timer":"0:00:00:00","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"fe80::5054:ff:fecf:dad8","lastupdated":1643172402186,"state":"dynamic","vpn-id":"0","uptime-date":1643048160000,"vdevice-host-name":"vm3","mac":"52:54:00:cf:da:d8","uptime":"1:10:30:01"},{"if-name":"ge0/1","idle-timer":"0:00:00:00","vdevice-dataKey":"169.254.10.10-0-ge0/1","vdevice-name":"169.254.10.10","ip":"fe80::fc54:ff:fea1:4f47","lastupdated":1643172402186,"state":"dynamic","vpn-id":"0","uptime-date":1642670640000,"vdevice-host-name":"vm3","mac":"fe:54:00:a1:4f:47","uptime":"5:19:21:53"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/nms/running":{"get":{"tags":["Real-Time Monitoring - NMS"],"description":"Get nms running state from device","operationId":"getRunning","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Nms running":{"description":"Nms running","value":{"data":[{"vdevice-host-name":"vm12","vdevice-dataKey":"172.16.255.22-true","running":"true","vdevice-name":"172.16.255.22","lastupdated":1642648535452}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/ntp/associations":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get NTP peer associations list from device (Real Time)","operationId":"createAssociationsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"NTP peer associations list":{"description":"NTP peer associations list","value":{"data":[{"count":1,"status":"8011","idx":1,"last_event":"mobilize","vdevice-name":"172.16.255.11","associd":"51657","auth":"none","reachability":"no","lastupdated":1647428253985,"conf":"yes","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11-1-51657","condition":"reject"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/ntp/peer":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get NTP peer list from device (Real Time)","operationId":"createPeerList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"NTP peer associations list":{"description":"NTP peer associations list","value":{"data":[{"index":1,"remote":"10.10.10.10","reach":"0","when":"-","lastupdated":1647576150422,"st":"16","delay":"0.000","vdevice-dataKey":"172.16.255.11-1","offset":"+0.000","vdevice-host-name":"vm1","jitter":"0.000","poll":"512","type":"u","refid":".INIT.","vdevice-name":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/ntp/status":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get NTP status list from device (Real Time)","operationId":"createNTPStatusList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"NTP peer associations list":{"description":"NTP peer associations list","value":{"data":[{"sys-poll":"3","stratum":"16","lastupdated":1647483667971,"root-delay":"0.0","vdevice-dataKey":"172.16.255.15-3","reftime":"1970-01-01T00:00:00+00:00","offset":"0.0","kod-type":"ntp-ref-init","root-disp":"38.5","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/omp/cloudx":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get CloudExpress routes received list","operationId":"createOMPCloudXRecv","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudExpress routes received list":{"description":"CloudExpress routes received list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","originator":"172.16.255.14","app-id":"1","app-name":"salesforce","to-peer":"172.16.255.19","from-peer":"172.16.255.20","status":"C,I,R","latency":"0","loss":"0","vdevice-dataKey":"172.16.254.1","lastupdated":1658131633272}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/links":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP connection list","operationId":"createOMPLinkList","parameters":[{"name":"state","in":"query","description":"Connection state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OMP connection list":{"description":"OMP connection list","value":{"data":[{"state":"up","lastupdated":"1646804216515","linkKey":"172.16.255.16-172.16.255.20","adeviceId":"172.16.255.16","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.16","bsystem-ip":"172.16.255.20","asite-id":"600","bsite-id":"200","ahost-name":"vm6","bhost-name":"vm10","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804204258","linkKey":"172.16.255.16-172.16.255.19","adeviceId":"172.16.255.16","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.16","bsystem-ip":"172.16.255.19","asite-id":"600","bsite-id":"100","ahost-name":"vm6","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804204257","linkKey":"172.16.255.15-172.16.255.19","adeviceId":"172.16.255.15","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.15","bsystem-ip":"172.16.255.19","asite-id":"500","bsite-id":"100","ahost-name":"vm5","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804216515","linkKey":"172.16.255.15-172.16.255.20","adeviceId":"172.16.255.15","bdeviceId":"172.16.255.20","asystem-ip":"172.16.255.15","bsystem-ip":"172.16.255.20","asite-id":"500","bsite-id":"200","ahost-name":"vm5","bhost-name":"vm10","apersonality":"vedge","bpersonality":"vsmart"},{"state":"up","lastupdated":"1646804204257","linkKey":"172.16.255.14-172.16.255.19","adeviceId":"172.16.255.14","bdeviceId":"172.16.255.19","asystem-ip":"172.16.255.14","bsystem-ip":"172.16.255.19","asite-id":"400","bsite-id":"100","ahost-name":"vm4","bhost-name":"vm9","apersonality":"vedge","bpersonality":"vsmart"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/omp/mcastautodiscoveradvt":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast autodiscover advertised list","operationId":"createOMPMcastAutoDiscoverAdvt","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast autodiscover advertised list":{"description":"OMP multicast autodiscover advertised list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","lastupdated":1643180905996,"source-originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.253.129"},{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","lastupdated":1643180905996,"source-originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/mcastautodiscoverrecv":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast autodiscover received list","operationId":"createOMPMcastAutoDiscoverRecv","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast autodiscover received list":{"description":"OMP multicast autodiscover received list","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","from-peer":"172.16.253.129","lastupdated":1643181632850,"source-originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C I R"},{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","from-peer":"172.16.255.130","lastupdated":1643181632851,"source-originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C I R"},{"vdevice-dataKey":"169.254.10.10-ipv4-10","vdevice-name":"169.254.10.10","from-peer":"0.0.0.0","lastupdated":1643181632852,"source-originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C Red R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/mcastroutesadvt":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast routes advertised list","operationId":"createOMPMcastRoutesAdvt","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast routes advertised list":{"description":"OMP multicast routes advertised list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","address-family":"ipv4","vpn-id":"1","source-originator":"172.16.255.14","destination":"172.16.255.16","group":"225.0.0.1","source":"0.0.0.0","rp":"10.20.25.18","to-peer":"172.16.255.20","vdevice-dataKey":"172.16.254.1-ipv4-10","lastupdated":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/mcastroutesrecv":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP multicast routes received list","operationId":"createOMPMcastRoutesRecv","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP multicast routes received list":{"description":"OMP multicast routes received list","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","address-family":"ipv4","vpn-id":"1","source-originator":"172.16.255.14","destination":"172.16.255.16","group":"225.0.0.1","source":"0.0.0.0","from-peer":"172.16.255.19","status":"C,I,R","vdevice-dataKey":"172.16.254.1-ipv4-10","lastupdated":1658131633272}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/peers":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP session list (Real Time)","operationId":"createOMPSessionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OP session list":{"description":"OP session list","value":{"data":[{"domain-id":1,"vdevice-name":"169.254.10.10","refresh":"supported","site-id":129,"type":"vsmart","vdevice-host-name":"vm3","up-time-date":1643135160000,"vdevice-dataKey":"169.254.10.10-172.16.253.129-vsmart","peer":"172.16.253.129","up-time":"0:12:57:30","legit":"yes","lastupdated":1643181828115,"state":"up"},{"domain-id":1,"vdevice-name":"169.254.10.10","refresh":"supported","site-id":130,"type":"vsmart","vdevice-host-name":"vm3","up-time-date":1643135160000,"vdevice-dataKey":"169.254.10.10-172.16.255.130-vsmart","peer":"172.16.255.130","up-time":"0:12:57:30","legit":"yes","lastupdated":1643181828115,"state":"up"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/routes/advertised":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP advertised routes list (Real Time)","operationId":"createAdvertisedRoutesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP advertised routes list":{"description":"OMP advertised routes list","value":{"data":[{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.3.0/24","ip":"172.16.254.2","label":"1069","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","path-id":"65","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643179668956,"to-peer":"172.16.253.129"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.3.0/24","ip":"172.16.254.2","label":"1069","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","path-id":"65","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643179668956,"to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/routes/advertised/ompIpv6":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP advertised routes list (Real Time)","operationId":"createAdvertisedRoutesListIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP advertised routes list":{"description":"OMP advertised routes list","value":{"data":[{"color":"lte","vdevice-name":"172.16.255.16","prefix":"2001:a14:19::/64","ip":"172.16.255.16","advertise-id":"70","label":"1003","encap":"ipsec","site-id":"600","originator":"172.16.255.16","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","path-id":"70","protocol":"connected","vdevice-dataKey":"172.16.255.16-1","metric":"0","lastupdated":1653905306196,"to-peer":"172.16.255.19"},{"color":"lte","vdevice-name":"172.16.255.16","prefix":"2001:a14:19::/64","ip":"172.16.255.16","advertise-id":"70","label":"1003","encap":"ipsec","site-id":"600","originator":"172.16.255.16","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","path-id":"70","protocol":"connected","vdevice-dataKey":"172.16.255.16-1","metric":"0","lastupdated":1653905306196,"to-peer":"172.16.255.20"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/omp/routes/received":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP received routes list (Real Time)","operationId":"createReceivedRoutesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP received routes list":{"description":"OMP received routes list","value":{"data":[{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.5.0/24","ip":"172.16.254.4","from-peer":"172.16.253.129","label":"1047","encap":"ipsec","site-id":"5","originator":"172.16.254.4","vpn-id":"10","vdevice-host-name":"vm3","path-id":"42","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C I R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.5.0/24","ip":"172.16.254.4","from-peer":"172.16.255.130","label":"1047","encap":"ipsec","site-id":"5","originator":"172.16.254.4","vpn-id":"10","vdevice-host-name":"vm3","path-id":"42","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.16.0/24","ip":"172.16.254.16","from-peer":"172.16.253.129","label":"1014","encap":"ipsec","site-id":"16","originator":"172.16.254.16","vpn-id":"10","vdevice-host-name":"vm3","path-id":"38","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C I R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"10.0.16.0/24","ip":"172.16.254.16","from-peer":"172.16.255.130","label":"1014","encap":"ipsec","site-id":"16","originator":"172.16.254.16","vpn-id":"10","vdevice-host-name":"vm3","path-id":"38","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.2.0/24","ip":"172.16.254.1","from-peer":"172.16.253.129","label":"1018","encap":"ipsec","site-id":"2","originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","path-id":"29","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C I R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.2.0/24","ip":"172.16.254.1","from-peer":"172.16.255.130","label":"1018","encap":"ipsec","site-id":"2","originator":"172.16.254.1","vpn-id":"10","vdevice-host-name":"vm3","path-id":"29","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041519,"attribute-type":"installed","status":"C R"},{"overlay-id":"1","color":"default","vdevice-name":"169.254.10.10","prefix":"100.100.3.0/24","ip":"172.16.254.2","from-peer":"0.0.0.0","label":"1069","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","path-id":"65","protocol":"connected","vdevice-dataKey":"169.254.10.10-10","metric":"0","lastupdated":1643182041520,"attribute-type":"installed","status":"C Red R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/routes/received/ompIpv6":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP received routes list (Real Time)","operationId":"createReceivedRoutesListIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP received routes list":{"description":"OMP received routes list","value":{"data":[{"path-id":"830","vdevice-dataKey":"172.16.255.16-1","vdevice-name":"172.16.255.16","prefix":"2001:a14:18::/64","from-peer":"172.16.255.19","lastupdated":1653904719952,"label":"1003","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","status":"C I R"},{"path-id":"861","vdevice-dataKey":"172.16.255.16-1","vdevice-name":"172.16.255.16","prefix":"2001:a14:18::/64","from-peer":"172.16.255.20","lastupdated":1653904719952,"label":"1003","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","status":"C R"},{"path-id":"70","vdevice-dataKey":"172.16.255.16-1","vdevice-name":"172.16.255.16","prefix":"2001:a14:19::/64","from-peer":"0.0.0.0","lastupdated":1653904719952,"label":"1003","vpn-id":"1","vdevice-host-name":"vm6","tenant-id":"0","status":"C Red R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/omp/services":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP services list","operationId":"createOMPServices","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OMP services list":{"description":"OMP services list","value":{"data":[{"path-id":"65","vdevice-dataKey":"169.254.10.10-10-VPN-172.16.254.2","vdevice-name":"169.254.10.10","service":"VPN","from-peer":"0.0.0.0","lastupdated":1643250832867,"originator":"172.16.254.2","label":"1077","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","status":"C Red R"},{"vdevice-dataKey":"169.254.10.10-10-VPN-172.16.254.2","vdevice-name":"169.254.10.10","service":"VPN","lastupdated":1643250832868,"originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.253.129"},{"vdevice-dataKey":"169.254.10.10-10-VPN-172.16.254.2","vdevice-name":"169.254.10.10","service":"VPN","lastupdated":1643250832869,"originator":"172.16.254.2","vpn-id":"10","vdevice-host-name":"vm3","address-family":"ipv4","to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/status":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get device OMP status","operationId":"getDeviceOMPStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device OMP status":{"description":"Device OMP status","value":{"data":[{"type":"omp","name":"OMP","image":"images/omp.png","count":0,"detailView":"dialog","detailsURL":"/dataservice/device/omp/links","statusList":[{"status":"up","icon":"images/connection/connection-network-up.png","color":"b0e276","name":"up","detailView":"dialog","detailsURL":"/dataservice/device/omp/links?state=up","count":0},{"status":"down","icon":"images/connection/connection-network-down.png","color":"fa7c7d","name":"down","detailView":"dialog","detailsURL":"/dataservice/device/omp/links?state=down","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/omp/summary":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OMP summary","operationId":"createOMPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OMP summary":{"description":"OMP summary","value":{"data":[{"tlocs-sent":4,"policy-sent":0,"mcast-routes-sent":0,"packets-sent":81579,"vdevice-name":"169.254.10.10","inform-sent":14,"packets-received":81956,"routes-received":18,"tlocs-received":22,"mcast-routes-installed":0,"update-sent":84,"devicetype":"vedge","mcast-routes-received":0,"hello-received":81472,"alert-sent":0,"update-received":468,"vsmart-peers":2,"operstate":"UP","policy-received":0,"handshake-received":2,"handshake-sent":2,"alert-received":0,"services-sent":4,"vdevice-host-name":"vm3","inform-received":14,"vdevice-dataKey":"169.254.10.10--","tlocs-installed":10,"services-installed":0,"ompuptime":"9:11:16:34","services-received":2,"lastupdated":1645494228477,"routes-sent":4,"hello-sent":81479,"routes-installed":8,"adminstate":"UP"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/synced/peers":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get OP session list","operationId":"createSyncedOMPSessionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OP session list":{"description":"OP session list","value":{"data":[{"domain-id":1,"vdevice-name":"172.16.255.11","createTimeStamp":1646804055895,"refresh":"supported","site-id":100,"type":"vsmart","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11-172.16.255.19-vsmart","@rid":568,"vmanage-system-ip":"172.16.255.11","peer":"172.16.255.19","legit":"yes","lastupdated":1646804055844,"region-id":"None","state":"up"},{"domain-id":1,"vdevice-name":"172.16.255.11","createTimeStamp":1646804061584,"refresh":"supported","site-id":200,"type":"vsmart","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11-172.16.255.20-vsmart","@rid":574,"vmanage-system-ip":"172.16.255.11","peer":"172.16.255.20","legit":"yes","lastupdated":1646804055844,"region-id":"None","state":"up"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/tlocs/advertised":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get advertised TLOCs list (Real Time)","operationId":"createAdvertisedTlocsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Advertised TLOCs list":{"description":"Advertised TLOCs list","value":{"data":[{"color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.2","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","weight":"1","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vdevice-host-name":"vm3","tloc-public-ip":"10.101.3.3","tloc-public-port":"12406","tloc-private-ip":"10.101.3.3","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.2","tloc-private-port":"12406","tloc-spi":"286","lastupdated":1643179953349,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4","to-peer":"172.16.253.129"},{"color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.2","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","weight":"1","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vdevice-host-name":"vm3","tloc-public-ip":"10.101.3.3","tloc-public-port":"12406","tloc-private-ip":"10.101.3.3","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.2","tloc-private-port":"12406","tloc-spi":"286","lastupdated":1643179953351,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4","to-peer":"172.16.255.130"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/omp/tlocs/received":{"get":{"tags":["Real-Time Monitoring - OMP"],"description":"Get received TLOCs list (Real Time)","operationId":"createReceivedTlocsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Received TLOCs list":{"description":"Received TLOCs list","value":{"data":[{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.1","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.253.129","weight":"1","encap":"ipsec","site-id":"2","originator":"172.16.254.1","vdevice-host-name":"vm3","tloc-public-ip":"10.101.2.2","tloc-public-port":"12386","tloc-private-ip":"10.101.2.2","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.1","tloc-private-port":"12386","tloc-spi":"263","lastupdated":1643185163270,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.2","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"0.0.0.0","weight":"1","encap":"ipsec","site-id":"3","originator":"172.16.254.2","vdevice-host-name":"vm3","tloc-public-ip":"10.101.3.3","tloc-public-port":"12406","tloc-private-ip":"10.101.3.3","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.2","tloc-private-port":"12406","tloc-spi":"287","lastupdated":1643185163276,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.3","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.255.130","weight":"1","encap":"ipsec","site-id":"4","originator":"172.16.254.3","vdevice-host-name":"vm3","tloc-public-ip":"10.101.4.4","tloc-public-port":"12406","tloc-private-ip":"10.101.4.4","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.3","tloc-private-port":"12406","tloc-spi":"284","lastupdated":1643185163281,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.4","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.255.130","weight":"1","encap":"ipsec","site-id":"5","originator":"172.16.254.4","vdevice-host-name":"vm3","tloc-public-ip":"10.102.5.5","tloc-public-port":"12406","tloc-private-ip":"10.102.5.5","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.4","tloc-private-port":"12406","tloc-spi":"288","lastupdated":1643185163286,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.5","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.253.129","weight":"1","encap":"ipsec","site-id":"6","originator":"172.16.254.5","vdevice-host-name":"vm3","tloc-public-ip":"10.102.6.6","tloc-public-port":"12406","tloc-private-ip":"10.102.6.6","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.5","tloc-private-port":"12406","tloc-spi":"292","lastupdated":1643185163290,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"},{"bfd-status":"up","color":"default","vdevice-name":"169.254.10.10","ip":"172.16.254.16","tloc-auth-type":"sha1-hmac ah-sha1-hmac","preference":"0","from-peer":"172.16.253.129","weight":"1","encap":"ipsec","site-id":"16","originator":"172.16.254.16","vdevice-host-name":"vm3","tloc-public-ip":"10.102.16.16","tloc-public-port":"12406","tloc-private-ip":"10.102.16.16","vdevice-dataKey":"169.254.10.10-ipv4-172.16.254.16","tloc-private-port":"12406","tloc-spi":"287","lastupdated":1643185163295,"tloc-encrypt-type":"aes256","tloc-proto":"0","address-family":"ipv4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write,Policy-read,Policy-write"}},"/device/ondemand/local":{"get":{"tags":["Real-Time Monitoring - Show On Demand Local"],"description":"Get on-demand local (Real Time)","operationId":"getOnDemandLocal","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"On Demand Local list":{"description":"On Demand Local list","value":{"data":[{"status":"-","site-id":"5","on-demand":"no","lastupdated":1642667823842,"idle-timeout-expiry":"10","vdevice-dataKey":"169.254.10.12-","vdevice-host-name":"vm5","vdevice-name":"169.254.10.12","system-ip":"172.16.254.4"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ondemand/remote":{"get":{"tags":["Real-Time Monitoring - Show On Demand Remote"],"description":"Get on-demand remote (Real Time)","operationId":"getOnDemandRemote","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"On Demand Remote list":{"description":"On Demand Remote list","value":{"data":[{"status":"-","site-id":"3","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.2"},{"status":"-","site-id":"4","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.3"},{"status":"-","site-id":"5","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.4"},{"status":"-","site-id":"6","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.5"},{"status":"-","site-id":"16","on-demand":"no","lastupdated":1642745561447,"idle-timeout-expiry":"-","vdevice-dataKey":"169.254.10.9-","vdevice-host-name":"vm2","vdevice-name":"169.254.10.9","system-ip":"172.16.254.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/orchestrator/connections":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get connection list from device","operationId":"createConnectionListFromDevice","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection list":{"description":"Connection list","value":{"data":[{"peer-region-id-set":"N/A","domain-id":1,"site-id":100,"local-color":"default","uptime":"1:23:51:47","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.19","state":"up","private-port":12355,"public-port":12355,"public-ip":"10.0.5.19","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.5.19","vdevice-name":"172.16.255.26","system-ip":"172.16.255.19"},{"peer-region-id-set":"N/A","domain-id":1,"site-id":100,"local-color":"default","uptime":"1:23:51:46","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.19","state":"up","private-port":12455,"public-port":12455,"public-ip":"10.0.5.19","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.5.19","vdevice-name":"172.16.255.26","system-ip":"172.16.255.19"},{"peer-region-id-set":"N/A","domain-id":1,"site-id":200,"local-color":"default","uptime":"1:23:51:47","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.20","state":"up","private-port":12356,"public-port":12356,"public-ip":"10.0.12.20","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.12.20","vdevice-name":"172.16.255.26","system-ip":"172.16.255.20"},{"peer-region-id-set":"N/A","domain-id":1,"site-id":200,"local-color":"default","uptime":"1:23:51:46","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vsmart-172.16.255.20","state":"up","private-port":12456,"public-port":12456,"public-ip":"10.0.12.20","uptime-date":1649589180000,"peer-type":"vsmart","vdevice-host-name":"vm16","private-ip":"10.0.12.20","vdevice-name":"172.16.255.26","system-ip":"172.16.255.20"},{"domain-id":0,"site-id":200,"local-color":"default","uptime":"1:23:51:45","lastupdated":1649761493102,"vdevice-dataKey":"172.16.255.26-vmanage-172.16.255.22","state":"up","private-port":12346,"public-port":12346,"public-ip":"10.0.12.22","uptime-date":1649589180000,"peer-type":"vmanage","vdevice-host-name":"vm16","private-ip":"10.0.12.22","vdevice-name":"172.16.255.26","system-ip":"172.16.255.22"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/connectionshistory":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get connection history list from device","operationId":"createConnectionHistoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection history list":{"description":"Connection history list","value":{"data":[{"remote-color":"default","index":0,"site-id":500,"public-port":12386,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"default","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-0-2022-04-10T12:23:23+0000","state":"up","domain-id":1,"private-port":12386,"public-ip":"10.1.15.15","downtime":"2022-04-10T12:23:23+0000","vdevice-host-name":"vm16","private-ip":"10.1.15.15","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"},{"remote-color":"default","index":1,"site-id":100,"public-port":12386,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"default","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-1-2022-04-10T11:48:32+0000","state":"up","domain-id":1,"private-port":12386,"public-ip":"10.0.5.11","downtime":"2022-04-10T11:48:32+0000","vdevice-host-name":"vm16","private-ip":"10.0.5.11","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"},{"remote-color":"default","index":2,"site-id":0,"public-port":12387,"peer-type":"unknown","local_enum":"DHSTMO","rep-count":0,"local-color":"default","remote_enum":"NOERR","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-2-2022-04-10T11:48:21+0000","state":"connect","domain-id":0,"private-port":0,"public-ip":"10.0.5.11","downtime":"2022-04-10T11:48:21+0000","vdevice-host-name":"vm16","private-ip":"::","remote_enum-desc":"NoError.","local_enum-desc":"DTLSHandShakeTimeout.","vdevice-name":"172.16.255.26"},{"remote-color":"lte","index":3,"site-id":600,"public-port":12366,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"lte","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-3-2022-04-10T11:13:44+0000","state":"up","domain-id":1,"private-port":12366,"public-ip":"10.1.16.16","downtime":"2022-04-10T11:13:44+0000","vdevice-host-name":"vm16","private-ip":"10.1.16.16","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"},{"remote-color":"lte","index":4,"site-id":100,"public-port":12377,"peer-type":"vedge","local_enum":"RXTRDWN","rep-count":0,"local-color":"lte","remote_enum":"DISCVBD","lastupdated":1649764706061,"vdevice-dataKey":"172.16.255.26-4-2022-04-10T11:13:41+0000","state":"up","domain-id":1,"private-port":12377,"public-ip":"10.0.5.21","downtime":"2022-04-10T11:13:41+0000","vdevice-host-name":"vm16","private-ip":"10.0.5.21","remote_enum-desc":"DisconnectvBondafterregisterreply.","local_enum-desc":"ReceivedTeardown.","vdevice-name":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/localproperties":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get local properties list from device","operationId":"createLocalPropertiesListList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Local properties list":{"description":"Local properties list","value":{"data":[{"certificate-not-valid-before":"Apr1010:34:032022GMT","certificate-status":"Installed","protocol":"dtls","uuid":"0a3c20df-82d6-43d4-b27f-a67864d35950","root-ca-chain-status":"Installed","certificate-not-valid-after":"Apr1010:34:032023GMT","sp-organization-name":"vIPtelaIncRegression","lastupdated":1649766458903,"certificate-validity":"Valid","vdevice-dataKey":"172.16.255.26","vedge-list-version":"0","number-active-wan-interfaces":"1","system-ip":"172.16.255.26","organization-name":"vIPtelaIncRegression","vdevice-host-name":"vm16","device-type":"vbond","vdevice-name":"172.16.255.26","vsmart-list-version":"0","board-serial":"12346571"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/proxymapping":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get reverse proxy mapping from vbond","operationId":"createReverseProxyMappingList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reverse proxy mapping":{"description":"Reverse proxy mapping","value":{"data":[{"vdevice-name":"172.16.255.26","vdevice-host-name":"vm16","uuid":"1b852227-4a15-48be-8637-3e995b934578","private-ip":"10.0.12.19","private-port":"23456","proxy-ip":"10.0.37.19","proxy-port":"23456","lastupdated":1658198416779,"vdevice-dataKey":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write"}},"/device/orchestrator/statistics":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get statistics from device","operationId":"getStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Statistics":{"description":"Statistics","value":{"data":[{"tx_challenge_ack":13,"tx_registers":0,"rx_pkts":168816,"tx_error":0,"vdevice-dataKey":"172.16.255.26","tx_challenge":15,"rx_challenge_ack":0,"tx_dtls_handshake_done":0,"vdevice-host-name":"vm16","tx_dtls_handshake_failures":0,"tx_challenge_gen_error":0,"rx_connects":0,"rx_octets":42608317,"rx_registers":64644,"lastupdated":1649768154244,"rx_challenge_resp":15,"tx_register_replies":64644,"tx_challenge_ack_error":0,"rx_challenge":0,"tx_dtls_handshake":0,"rx_dtls_handshake_done":15,"rx_dtls_handshake_failures":0,"rx_error":0,"challenge_failures":2,"tx_challenge_resp_error":0,"vdevice-name":"172.16.255.26","tx_blocked":0,"tx_connects":64671,"tx_octets":63147501,"tx_challenge_error":0,"rx_register_replies":0,"tx_challenge_resp":0,"tx_pkts":242150,"rx_dtls_handshake":70}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/summary":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get connection summary from device","operationId":"createConnectionSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connection summary":{"description":"Connection summary","value":{"data":[{"protocol":"dtls","listening_port":12346,"listening_ip":"0.0.0.0","vsmart_counts":4,"vmanage_counts":2,"lastupdated":1649816906161,"instance":0,"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-0","listening_ipv6":"::","vedge_counts":0,"vdevice-name":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/validvedges":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get valid device list from device","operationId":"createValidDevicesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Valid device list":{"description":"Valid device list","value":{"data":[{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-1BFB0237-AFCA-4583-BF0C-BECD124565D6-12346572","serial-number":"12346572","validity":"valid","lastupdated":1649818236214,"chassis-number":"1BFB0237-AFCA-4583-BF0C-BECD124565D6","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-33418D3F-286E-4256-A7CB-7BF3A70E1ED8-12346570","serial-number":"12346570","validity":"valid","lastupdated":1649818236214,"chassis-number":"33418D3F-286E-4256-A7CB-7BF3A70E1ED8","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-4D0318BF-472E-4114-B72D-A5E99C5AFAD7-12346580","serial-number":"12346580","validity":"valid","lastupdated":1649818236214,"chassis-number":"4D0318BF-472E-4114-B72D-A5E99C5AFAD7","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-ADC329CC-701C-42D6-84C6-245F09C25583-12346578","serial-number":"12346578","validity":"valid","lastupdated":1649818236214,"chassis-number":"ADC329CC-701C-42D6-84C6-245F09C25583","vdevice-name":"172.16.255.26"},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E-12346575","serial-number":"12346575","validity":"valid","lastupdated":1649818236214,"chassis-number":"C685BD5F-6C3F-46C8-B58A-D59F2F1A6E2E","vdevice-name":"172.16.255.26"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/validvmanageid":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get valid vManage Id from device","operationId":"getValidVManageId","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Valid vManage Id":{"description":"Valid vManage Id","value":{"data":[{"chassis-number":"a52d3492-755a-4a02-9a3d-8bdf2dc1d241","vdevice-dataKey":"172.16.255.26-","vdevice-name":"172.16.255.26","lastupdated":1649823209136,"vdevice-host-name":"vm16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/orchestrator/validvsmarts":{"get":{"tags":["Real-Time Monitoring - Orchestrator"],"description":"Get valid vSmart list from device","operationId":"createValidVSmartsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Valid vSmart list":{"description":"Valid vSmart list","value":{"data":[{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-12346567","serial-number":"12346567","vdevice-name":"172.16.255.26","lastupdated":1649824251432},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-12346569","serial-number":"12346569","vdevice-name":"172.16.255.26","lastupdated":1649824251432},{"vdevice-host-name":"vm16","vdevice-dataKey":"172.16.255.26-12346573","serial-number":"12346573","vdevice-name":"172.16.255.26","lastupdated":1649824251432}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Security-read,Security-write"}},"/device/ospf/database":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF database list from device (Real Time)","operationId":"createOSPFDatabaseList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF database list":{"description":"OSPF database list","value":{"data":[{"area":0,"link-id":"172.16.255.11","data":"10.2.2.11","vdevice-name":"172.16.255.11","link-count":"1","vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.11","lsa-type":"router","router-link-id":"10.2.2.12","router-link-type":"transit","sequence":"2147483652","vdevice-dataKey":"172.16.255.11-1-0","checksum":"50110","lastupdated":1646791144576,"tos-metric":"10","age":"153"},{"area":0,"link-id":"172.16.255.12","data":"10.2.2.12","vdevice-name":"172.16.255.11","link-count":"2","vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.12","lsa-type":"router","router-link-id":"10.2.2.12","router-link-type":"transit","sequence":"2147483655","vdevice-dataKey":"172.16.255.11-1-0","checksum":"52821","lastupdated":1646791144576,"tos-metric":"10","age":"153"},{"area":0,"link-id":"172.16.255.21","data":"10.2.3.21","vdevice-name":"172.16.255.11","link-count":"1","vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.21","lsa-type":"router","router-link-id":"10.2.3.21","router-link-type":"transit","sequence":"2147483651","vdevice-dataKey":"172.16.255.11-1-0","checksum":"8760","lastupdated":1646791144576,"tos-metric":"10","age":"154"},{"area":0,"sequence":"2147483649","link-id":"10.2.2.12","vdevice-dataKey":"172.16.255.11-1-0","vdevice-name":"172.16.255.11","checksum":"63980","lastupdated":1646791144576,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.12","age":"154","lsa-type":"network"},{"area":0,"sequence":"2147483649","link-id":"10.2.3.21","vdevice-dataKey":"172.16.255.11-1-0","vdevice-name":"172.16.255.11","checksum":"59106","lastupdated":1646791144576,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.21","age":"155","lsa-type":"network"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/databaseexternal":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF external database list from device (Real Time)","operationId":"createOSPFDatabaseExternal","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF external database list":{"description":"OSPF external database list","value":{"data":[{"link-id":"10.20.25.0","options-flags":"EDN","vdevice-name":"172.16.255.11","prefix":"10.20.25.0/24","metric-type":"type2","length":36,"flags":11,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.11","forwarding-addr":"0.0.0.0","sequence":2147483650,"vdevice-dataKey":"172.16.255.11-1-10.20.25.0","metric":"16777214","checksum":62048,"options":130,"lastupdated":1646791949860,"tag":0,"age":958},{"link-id":"10.20.25.0","options-flags":"EDN","vdevice-name":"172.16.255.11","prefix":"10.20.25.0/24","metric-type":"type2","length":36,"flags":6,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.21","forwarding-addr":"0.0.0.0","sequence":2147483650,"vdevice-dataKey":"172.16.255.11-1-10.20.25.0","metric":"16777214","checksum":46738,"options":130,"lastupdated":1646791949860,"tag":0,"age":959},{"link-id":"172.16.255.112","options-flags":"E","vdevice-name":"172.16.255.11","prefix":"172.16.255.112/32","metric-type":"type2","length":36,"flags":6,"vpn-id":1,"vdevice-host-name":"vm1","adv-router":"172.16.255.12","forwarding-addr":"0.0.0.0","sequence":2147483651,"vdevice-dataKey":"172.16.255.11-1-172.16.255.112","metric":"20","checksum":58083,"options":2,"lastupdated":1646791949860,"tag":0,"age":958}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/databasesummary":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF database summary list from device (Real Time)","operationId":"createOSPFDatabaseSummaryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF database summary list":{"description":"OSPF database summary list","value":{"data":[{"vdevice-dataKey":"172.16.255.11-1-0","router-lsa":3,"total-lsa":5,"vdevice-name":"172.16.255.11","summary-lsa":0,"nssa-lsa":0,"network-lsa":2,"lastupdated":1646792331519,"area-id":0,"vpn-id":1,"asbr-summary-lsa":0,"vdevice-host-name":"vm1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/interface":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF interface list from device (Real Time)","operationId":"createOSPFInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF interface list":{"description":"OSPF interface list","value":{"data":[{"lastupdated":1646026461327,"vdevice-dataKey":"169.254.10.14-0-1--","vdevice-name":"169.254.10.14","router-id":"0","vdevice-host-name":"vm16","instance-id":"1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/neighbor":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF neighbor list from device (Real Time)","operationId":"createOSPFNeighbors","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF neighbor list":{"description":"OSPF neighbor list","value":{"data":[{"lastupdated":1646027273671,"vdevice-dataKey":"169.254.10.14-0-1---","vdevice-name":"169.254.10.14","router-id":"0","vdevice-host-name":"vm16","instance-id":"1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/process":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF process list from device (Real Time)","operationId":"createOSPFProcess","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF process list":{"description":"OSPF process list","value":{"data":[{"ls-ack-sent":"5","summary-lsa-checksum":"0","vdevice-name":"172.16.255.11","spf-max-holdtime":"10000","spf-holdtime":"1000","number-areas":"1","rfc1583-compatible":"true","lsa-count":"5","external-lsa-checksum":"166869","router-id":"172.16.255.11","hello-received":"172","ignore-down-bit":"false","area-id":"0","dbd-received":"2","network-lsa-checksum":"123086","summary-lsa-count":"0","router-lsa-count":"3","router-lsa-checksum":"111691","spf-delay":"200","spf-hold-multiplier":"1","external-lsa-count":"3","ls-ack-received":"5","asbr-lsa-count":"0","vpn-id":"1","vdevice-host-name":"vm1","spf-last-exec-time":"1663","backbone-area":"true","network-lsa-count":"2","ls-req-sent":"1","asbr-lsa-checksum":"0","dbd-sent":"3","vdevice-dataKey":"172.16.255.11-1-","lsa-refresh-interval":"10","ls-upd-received":"12","nssa-lsa-count":"0","ls-req-received":"1","num-full-adj-routers":"1","spf-exec-count":"3","lastupdated":1646792665279,"ls-upd-sent":"8","nssa-lsa-checksum":"0","hello-sent":"172","num-interfaces":"1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/routes":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF route list from device (Real Time)","operationId":"createOSPFRoutesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF route list":{"description":"OSPF route list","value":{"data":[{"cost":"10","dest-type":"router","vdevice-name":"172.16.255.11","prefix":"172.16.255.12/32","flags":"2","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-router-172.16.255.12/32-0","route-type":"router","lastupdated":1646793742274,"area-id":"0","next-hop":"10.2.2.12","path-type":"intra-area"},{"cost":"20","dest-type":"router","vdevice-name":"172.16.255.11","prefix":"172.16.255.21/32","flags":"2","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-router-172.16.255.21/32-0","route-type":"router","lastupdated":1646793742276,"area-id":"0","next-hop":"10.2.2.12","path-type":"intra-area"},{"cost":"10","dest-type":"network","vdevice-name":"172.16.255.11","prefix":"10.2.2.0/24","flags":"0","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-network-10.2.2.0/24-0","route-type":"network","lastupdated":1646793742276,"area-id":"0","next-hop":"0.0.0.0","path-type":"intra-area"},{"cost":"20","dest-type":"network","vdevice-name":"172.16.255.11","prefix":"10.2.3.0/24","flags":"0","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-network-10.2.3.0/24-0","route-type":"network","lastupdated":1646793742276,"area-id":"0","next-hop":"10.2.2.12","path-type":"intra-area"},{"dest-type":"network","vdevice-name":"172.16.255.11","prefix":"172.16.255.112/32","flags":"78","info-id":"0","vpn-id":"1","vdevice-host-name":"vm1","type2-cost":"20","if-name":"ge0/0","vdevice-dataKey":"172.16.255.11-1-external-172.16.255.112/32-0","route-type":"external","lastupdated":1646793742276,"tag":"0","next-hop":"10.2.2.12","path-type":"external2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/v3interface":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF v3 interface list from device (Real Time)","operationId":"createOSPFv3Interface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF v3 interface list":{"description":"OSPF v3 interface list","value":{"data":[{"router-id":"90.90.90.90","af":"ospfv3-address-family-ipv4","area-id":"300","lastupdated":1649681917917,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300-","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"router-id":"100.100.5.101","af":"ospfv3-address-family-ipv6","area-id":"300","lastupdated":1649681917917,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300-","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ospf/v3neighbor":{"get":{"tags":["Real-Time Monitoring - OSPF"],"description":"Get OSPF v3 neighbor list from device (Real Time)","operationId":"createOSPFv3Neighbors","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"OSPF v3 neighbor list":{"description":"OSPF v3 neighbor list","value":{"data":[{"router-id":"90.90.90.90","af":"ospfv3-address-family-ipv4","area-id":"300","lastupdated":1649682289885,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv4--90.90.90.90-300--","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"router-id":"100.100.5.101","af":"ospfv3-address-family-ipv6","area-id":"300","lastupdated":1649682289885,"vpn-id":"10","vdevice-dataKey":"172.16.255.15-10-ospfv3-address-family-ipv6--100.100.5.101-300--","process-id":"10","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/interface":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM interface list from device","operationId":"createPIMInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM interface list":{"description":"PIM interface list","value":{"data":[{"if-name":"ge0/0","dr-address":"100.100.3.101","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","if-addr":"100.100.3.101/24","neighbor-count":0,"hello-interval":30,"lastupdated":1643258686605,"join-prune-interval":60,"vpn-id":"10","priority":1,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/neighbor":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM neighbor list from device","operationId":"createPIMNeighborList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM neighbor list":{"description":"PIM neighbor list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","if-name":"ge0/0.1","nbr-addr":"10.0.9.11","up-time":"0:12:12:12","up-time-date":"0:12:12:12 2022/07/19","expires":"0:23:01:44","expires-date":"0:23:01:44 2022/07/19","priority":"1","hold-time":"105","dr-address":"10.0.9.14","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/rp-mapping":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM Rp-mapping list from device","operationId":"createPIMRpMappingList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM Rp-mapping list":{"description":"PIM Rp-mapping list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","type":"Auto-RP","group":"225.0.0.0/24","rp-address":"225.0.0.0/24","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"},{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"2","type":"Auto-RP","group":"227.0.0.0/24","rp-address":"58.0.2.100 ","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pim/statistics":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PIM statistics list from device","operationId":"createPIMStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PIM statistics list":{"description":"PIM statistics list","value":{"data":[{"hello-rx":0,"unknown-rx":0,"vdevice-name":"169.254.10.10","vpn-id":"10","vdevice-host-name":"vm3","bad-rx":0,"join-prune-tx":0,"vdevice-dataKey":"169.254.10.10","join-prune-rx":0,"auto-rp-mapping-rx":0,"unsupported-rx":0,"lastupdated":1643259067333,"assert-rx":0,"auto-rp-announce-rx":0,"assert-tx":0,"hello-tx":1090}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/pki/trustpoint":{"get":{"tags":["Real-Time Monitoring - Pki Trustpoint"],"description":"Get device pki trustpoint","operationId":"getDevicePkiTrustpoint","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device pki trustpoint":{"description":"Device pki trustpoint","value":{"data":[{"cert/subject-name":"cn=Cisco Root CA M1,o=Cisco","cert/issuer-name":"cn=Cisco Root CA M1,o=Cisco","vdevice-dataKey":"172.16.255.15-Trustpool","vdevice-name":"172.16.255.15","cert/validity-end":"2033-11-18T21:59:46+00:00","cert/serial-number":"2ED20E7347D333834B4FDD0DD7B6967E","lastupdated":1687777199956,"cert/validity-start":"2008-11-18T21:50:24+00:00","label":"Trustpool","tp-authenticated":"true","vdevice-host-name":"vm5","cert/md5-fp":"F0F28550B0B8394B327BB8472FD1B807"},{"cert/subject-name":"cn=Cisco Root CA 2048,o=Cisco Systems","cert/issuer-name":"cn=Cisco Root CA 2048,o=Cisco Systems","vdevice-dataKey":"172.16.255.15-Trustpool1","vdevice-name":"172.16.255.15","cert/validity-end":"2029-05-14T20:25:42+00:00","cert/serial-number":"5FF87B282B54DC8D42A315B568C9ADFF","lastupdated":1687777199956,"cert/validity-start":"2004-05-14T20:17:12+00:00","label":"Trustpool1","tp-authenticated":"true","vdevice-host-name":"vm5","cert/md5-fp":"BE395ABE078AB1121725CC1D46343CB2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/policer":{"get":{"tags":["Real-Time Monitoring - Policer"],"description":"Get policed interface list from device","operationId":"getPolicedInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policed interface":{"description":"Policed interface","value":{"data":[{"oos-bytes":"0","oos-action":"drop","vdevice-dataKey":"169.254.10.10-10","vdevice-name":"169.254.10.10","rate":81920,"oos-pkts":"0","name":"TCPOPT_SYN_POLICER","index":10,"lastupdated":1643264577448,"burst":10240,"vdevice-host-name":"vm3","direction":"in"},{"oos-bytes":"0","oos-action":"drop","vdevice-dataKey":"169.254.10.10-11","vdevice-name":"169.254.10.10","rate":100000000,"oos-pkts":"0","name":"TCPOPT_DATA_POLICER","index":11,"lastupdated":1643264577448,"burst":12500000,"vdevice-host-name":"vm3","direction":"in"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistassociations":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list associations from device","operationId":"createPolicyAccessListAssociations","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{"data":[{"vdevice-dataKey":"172.16.255.16-pol-acl-test","vdevice-name":"172.16.255.16","name":"pol-acl-test","lastupdated":1653374017047,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistcounters":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list counter from device","operationId":"createPolicyAccessListCounters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list counter":{"description":"Access list counter","value":{"data":[{"vdevice-dataKey":"172.16.255.16-pol-acl-test","counter-name":"default_action_count","vdevice-name":"172.16.255.16","bytes":"0","name":"pol-acl-test","lastupdated":1653374287187,"vdevice-host-name":"vm6","packets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistnames":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list names from device","operationId":"createPolicyAccessListNames","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list names":{"description":"Access list names","value":{"data":[{"vdevice-dataKey":"172.16.255.16-pol-acl-test","vdevice-name":"172.16.255.16","name":"pol-acl-test","lastupdated":1653374338991,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/accesslistpolicers":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list policers from device","operationId":"createPolicyAccessListPolicers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list policers":{"description":"Access list policers","value":{"data":[{"name":"pol-acl-test","lastupdated":1653374393223,"vdevice-dataKey":"172.16.255.16-pol-acl-test-","vdevice-name":"172.16.255.16","vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/approutepolicyfilter":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get approute policy filter from device","operationId":"createPolicyAppRoutePolicyFilter","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Approute policy filter":{"description":"Approute policy filter","value":{"data":[{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","policy-name":"accept_nat","vpn-name":"vpn_1","counter-name":"natpool1","packets":18179,"bytes":"27448882","vdevice-dataKey":"172.16.255.16-accept_nat-vpn_1-natpool1","lastupdated":1656400527112},{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","policy-name":"accept_nat","vpn-name":"vpn_1","counter-name":"natpool2","packets":18229,"bytes":"27441234","vdevice-dataKey":"172.16.255.16-accept_nat-vpn_1-natpool2","lastupdated":1656400527112},{"vdevice-name":"172.16.255.16","vdevice-host-name":"vm6","policy-name":"accept_nat","vpn-name":"vpn_1","counter-name":"natpool3","packets":18888,"bytes":"27444442","vdevice-dataKey":"172.16.255.16-accept_nat-vpn_1-natpool3","lastupdated":1656400527112}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/datapolicyfilter":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get data policy filters from device","operationId":"createPolicDataPolicyFilter","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data policy filter":{"description":"Data policy filter","value":{"data":[{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool1","counter-name":"natpool1","vdevice-name":"172.16.255.15","bytes":"27448882","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":18179},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool2","counter-name":"natpool2","vdevice-name":"172.16.255.15","bytes":"27042692","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17910},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool3","counter-name":"natpool3","vdevice-name":"172.16.255.15","bytes":"26630462","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17637},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool4","counter-name":"natpool4","vdevice-name":"172.16.255.15","bytes":"26252860","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17386},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-natpool5","counter-name":"natpool5","vdevice-name":"172.16.255.15","bytes":"25849690","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":17119},{"vpn-name":"vpn_1","vdevice-dataKey":"172.16.255.15-accept_nat-vpn_1-default_action_count","counter-name":"default_action_count","vdevice-name":"172.16.255.15","bytes":"0","policy-name":"accept_nat","lastupdated":1656400527112,"vdevice-host-name":"vm5","packets":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/filtermemoryusage":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get data policy filter memory usage from device","operationId":"createPolicyFilterMemoryUsage","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Data policy filter memory usage":{"description":"Data policy filter memory usage","value":{"data":[{"filter-max":"512","vdevice-dataKey":"169.254.10.10-0","vdevice-name":"169.254.10.10","blocks-used":"0","blocks-max":"1048576","filter-used":"0","lastupdated":1643266183894,"vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/iptosgtbindings":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show ip to sgt binding from Vsmart","operationId":"showVsmartIptoSgtBinding","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/iptouserbindings":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show ip to user binding from Vsmart","operationId":"showVsmartIptoUserBinding","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistassociations":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list associations from device","operationId":"createPolicyAccessListAssociationsIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list associations":{"description":"Access list associations","value":{"data":[{"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test","vdevice-name":"172.16.255.16","name":"ipv6_pol-acl-test","lastupdated":1653376026043,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistcounters":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list counters from device","operationId":"createPolicyAccessListCountersIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list counters":{"description":"Access list counters","value":{"data":[{"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test","counter-name":"default_action_count","vdevice-name":"172.16.255.16","bytes":"0","name":"ipv6_pol-acl-test","lastupdated":1653376073433,"vdevice-host-name":"vm6","packets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistnames":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list names from device","operationId":"createPolicyAccessListNamesIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list names":{"description":"Access list names","value":{"data":[{"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test","vdevice-name":"172.16.255.16","name":"ipv6_pol-acl-test","lastupdated":1653376118299,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/ipv6/accesslistpolicers":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get access list policers from device","operationId":"createPolicyAccessListPolicersIpv6","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Access list policers":{"description":"Access list policers","value":{"data":[{"name":"ipv6_pol-acl-test","lastupdated":1653376169819,"vdevice-dataKey":"172.16.255.16-ipv6_pol-acl-test-","vdevice-name":"172.16.255.16","vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/pxgridstatus":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show Pxgrid status From Vsmart","operationId":"showVsmartPxGridStatus","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/pxgridusersessions":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show Pxgrid sessions From Vsmart","operationId":"showVsmartPxGridUserSessions","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/qosmapinfo":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get QoS map information from device","operationId":"createPolicQosMapInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"QoS map information":{"description":"QoS map information","value":{"data":[{"lastupdated":1654481032855,"vdevice-dataKey":"169.254.10.9-policy_qos_map","vdevice-name":"169.254.10.9","qos-map-name":"policy_qos_map","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/qosschedulerinfo":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get QoS scheduler information from device","operationId":"createPolicQosSchedulerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"QoS scheduler information":{"description":"QoS scheduler information","value":{"data":[{"vdevice-dataKey":"169.254.10.9-policy_qos_map_0","vdevice-name":"169.254.10.9","qos-map-name":"policy_qos_map","buffer-percent":"100","lastupdated":1654481134775,"bandwidth-percent":"100","qos-scheduler-name":"policy_qos_map_0","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/rewriteassociations":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get rewrite associations information from device","operationId":"createPolicyRewriteAssociationsInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Rewrite associations information":{"description":"Rewrite associations information","value":{"data":[{"name":"vpn10_rewrite_policy","lastupdated":1654562464357,"vdevice-dataKey":"169.254.10.9-vpn10_rewrite_policy","vdevice-name":"169.254.10.9","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/userusergroupbindings":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Show User-Usergroup bindings from Vsmart","operationId":"showVsmartUserUsergroupBindings","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":[{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:Employee","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser0"},{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:TestUserGroup-1","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser0"},{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:Employee","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser1"},{"omp-update-state":"omp-updated","vdevice-dataKey":"172.16.255.19","vdevice-name":"172.16.255.19","user-groups":"User Identity Groups:TestUserGroup-1","lastupdated":1646677354863,"vdevice-host-name":"vm9","username":"TestUser1"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/vsmart":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"show Sdwan Policy From Vsmart","operationId":"showSdwanPolicyFromVsmart","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SDWAN policy from vSmart":{"description":"SDWAN policy from vSmart","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","name":"dp1","app-list":"SSH_policy","vpn-list":"vpn_1_list","vpn-id":"1","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zbfwdropstatistics":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone drop statistics from device","operationId":"getZoneDropStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone drop statistics":{"description":"Zone drop statistics","value":{"data":[{"l4-tcp-l7-ooo-seg":"0","l4-icmp-err-l4-invalid-seq":"0","policy-action-drop":"0","l4-icmp-err-no-ip-no-icmp":"0","l7-type-drop":"0","l4-scb-close":"0","l4-tcp-invalid-seg-synsent-state":"0","l4-tcp-syn-flood-drop":"0","l4-icmp-internal-err-no-nat":"0","l4-tcp-invalid-seq":"0","l7-no-seg":"0","no-new-session":"0","l4-icmp-internal-err-get-stat-blk-fail":"0","syncookie-max-dst":"0","insp-internal-err-get-stat-blk-fail":"0","l4-invalid-hdr":"0","l4-icmp-internal-err-alloc-fail":"0","l4-tcp-invalid-seg-pkt-win-overflow":"0","no-forwarding-zone":"0","l4-icmp-too-many-err-pkts":"0","fdb-err":"0","no-session":"0","insp-dstaddr-lookup-fail":"0","l4-session-limit":"0","insp-class-action-drop":"0","l4-tcp-rst-to-resp":"0","l4-tcp-stray-seg":"0","not-initiator":"0","backpressure":"0","l4-tcp-invalid-tcp-initiator":"0","l4-icmp-pkt-too-short":"0","zone-mismatch":"0","l4-tcp-unexpect-tcp-payload":"0","l7-no-frag":"0","l4-tcp-invalid-seg-pyld-after-fin-send":"0","l4-icmp-err-policy-not-present":"0","l7-alg-ret-drop":"0","l4-tcp-internal-err-synflood-alloc-hostdb-fail":"0","insp-classification-fail":"0","l4-tcp-invalid-win-scale-option":"0","l4-tcp-syn-in-win":"0","policy-icmp-action-drop":"0","vdevice-name":"169.254.10.12","lisp-inner-ipv6-insane":"0","l4-tcp-rst-in-win":"0","l4-tcp-retrans-invalid-flags":"0","catch-all":"0","l4-icmp-err-l4-invalid-ack":"0","syncookie-trigger":"0","l7-unknown-proto":"0","l4-tcp-syn-with-data":"0","l4-tcp-invalid-seg-pkt-too-old":"0","l4-icmp-err-classification-fail":"0","l4-icmp-internal-err-dir-not-identified":"0","l4-internal-err-undefined-dir":"0","insp-policy-not-present":"0","syncookie-internal-err-alloc-fail":"0","lisp-header-restore-fail":"0","l4-tcp-synflood-blackout-drop":"0","l4-tcp-invalid-ack-flag":"0","insp-pam-lookup-fail":"0","l4-icmp-scb-close":"0","invalid-zone":"0","ha-ar-standby":"0","vdevice-host-name":"vm5","l4-tcp-invalid-seg-synrcvd-state":"0","l4-tcp-invalid-ack-num":"0","l7-promote-fail-no-policy":"0","l4-too-many-pkts":"0","l4-icmp-err-pkts-burst":"0","l7-promote-fail-no-zone-pair":"0","vdevice-dataKey":"169.254.10.12-0","l4-icmp-err-multiple-unreach":"0","policy-fragment-drop":"0","l4-tcp-invalid-flags":"0","lisp-inner-ipv4-insane":"0","lastupdated":1645666649064,"l4-max-halfsession":"0","insp-sess-miss-policy-not-present":"0","l4-icmp-pkt-no-ip-hdr":"0","insp-policy-misconfigure":"0","lisp-inner-pkt-insane":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zbfwstatistics":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone based firewall statistics from device","operationId":"getZbfwStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone based firewall statistics":{"description":"Zone based firewall statistics","value":{"data":[{"no-pair-diff-zone-dropped":"0","tcp-retrans-seg":"0","flow-add-fail":"0","vdevice-name":"169.254.10.10","tcp-drop-stray-seg":"0","tcp-drop-invalid-seg-pkt-too-old":"0","zbf-pkts":"0","state-check-fail":"0","unsupported-proto":"0","no-pair-same-zone-allowed":"0","zone-no-zone-inet-denied":"0","tcp-drop-invalid-seg-synsent-state":"0","max-halfopen-exceeded":"0","tcp-drop-invalid-flags":"0","tcp-drop-unexpect-tcp-pyld":"0","num-flow-entries":"0","tcp-ooo-seg":"0","tcp-drop-invalid-seg-synrcvd-state":"0","tcp-drop-no-syn-in-listen-state":"0","tcp-drop-invalid-ack-flag":"0","fragments":"0","zone-no-zone-dropped":"0","no-zone-no-zone-allowed":"0","tcp-drop-invalid-ack-num":"0","policy-change-dropped":"0","tcp-drop-rst-to-resp":"0","tcp-drop-syn-with-data":"0","tcp-drop-syn-in-win":"0","tcp-drop-invalid-dir":"0","tcp-drop-invalid-win-scale-option":"0","frag-fail":"0","tcp-drop-retrans-invalid-flags":"0","tcp-drop-internal-invalid-tcp-state":"0","tcp-drop-rst-in-win":"0","tcp-drop-invalid-seg-pkt-win-overflow":"0","vdevice-host-name":"vm3","vdevice-dataKey":"169.254.10.10-","lastupdated":1643271305369,"tcp-drop-invalid-seq":"0","zone-no-zone-inet-allowed":"0","tcp-drop-invalid-seg-pyld-after-fin-send":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zonepairsessions":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone pair sessions from device","operationId":"getZonePairSessions","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone pair session":{"description":"Zone pair session","value":{"data":[{"src-ip":"10.1.15.15","dst-ip":"10.0.5.19","src-vpn-id":"65534","vdevice-name":"172.16.255.15","src-port":12426,"zp-name":"self_to_inet","dst-vrf":"0","dst-port":12455,"vdevice-host-name":"vm5","total-responder-bytes":"115724","protocol":"PROTO_L4_UDP","vdevice-dataKey":"13","lastupdated":1655955518778,"state":"open","dst-vpn-id":"0","total-initiator-bytes":"103518","classmap-name":"3","session-id":"13","src-vrf":"0"},{"src-ip":"10.0.1.1","dst-ip":"10.0.1.255","src-vpn-id":"0","vdevice-name":"172.16.255.15","src-port":123,"zp-name":"inet_to_self","dst-vrf":"0","dst-port":123,"vdevice-host-name":"vm5","total-responder-bytes":"0","protocol":"PROTO_L7_NTP","vdevice-dataKey":"28","lastupdated":1655955518778,"state":"opening","dst-vpn-id":"65534","total-initiator-bytes":"48","classmap-name":"3","session-id":"28","src-vrf":"0"},{"src-ip":"10.1.15.15","dst-ip":"10.0.12.22","src-vpn-id":"65534","vdevice-name":"172.16.255.15","src-port":12426,"zp-name":"self_to_inet","dst-vrf":"0","dst-port":12446,"vdevice-host-name":"vm5","total-responder-bytes":"918966","protocol":"PROTO_L4_UDP","vdevice-dataKey":"15","lastupdated":1655955518778,"state":"open","dst-vpn-id":"0","total-initiator-bytes":"5037561","classmap-name":"3","session-id":"15","src-vrf":"0"},{"src-ip":"10.1.15.15","dst-ip":"10.0.12.20","src-vpn-id":"65534","vdevice-name":"172.16.255.15","src-port":12426,"zp-name":"self_to_inet","dst-vrf":"0","dst-port":12456,"vdevice-host-name":"vm5","total-responder-bytes":"116455","protocol":"PROTO_L4_UDP","vdevice-dataKey":"14","lastupdated":1655955518778,"state":"open","dst-vpn-id":"0","total-initiator-bytes":"107116","classmap-name":"3","session-id":"14","src-vrf":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zonepairstatistics":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone pair statistics from device","operationId":"getZonePairs","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone pair statistics":{"description":"Zone pair statistics","value":{"data":[{"max-active-conn":"0","class-action":"Inspect Drop","vdevice-name":"172.16.255.15","src-zone-name":"employee","pkts-counter":"0","max-halfopen-conn":"0","vdevice-host-name":"vm5","zonepair-name":"employee-inet","class-name":"cmap_1","attempted-conn":"0","match-type-id":"3","match-type":"access-group name","current-active-conn":"0","current-halfopen-conn":"0","vdevice-dataKey":"172.16.255.15-employee-inet-cmap_1","time-since-last-session-create":"0","current-terminating-conn":"0","policy-name":"fw_policy1","match-name":"acl1_1","lastupdated":1655267493875,"max-terminating-conn":"0","dst-zone-name":"internet","bytes-counter":"0"},{"max-active-conn":"0","class-action":"Inspect Drop","vdevice-name":"172.16.255.15","src-zone-name":"employee","pkts-counter":"0","max-halfopen-conn":"0","vdevice-host-name":"vm5","class-name":"class-default","zonepair-name":"employee-inet","attempted-conn":"0","current-active-conn":"0","current-halfopen-conn":"0","vdevice-dataKey":"172.16.255.15-employee-inet-class-default","time-since-last-session-create":"0","current-terminating-conn":"0","policy-name":"fw_policy1","lastupdated":1655267493875,"max-terminating-conn":"0","dst-zone-name":"internet","bytes-counter":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/policy/zonepolicyfilter":{"get":{"tags":["Real-Time Monitoring - Policy"],"description":"Get zone policy filter from device","operationId":"getZonePolicyFilters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone policy filter":{"description":"Zone policy filter","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","name":"ZONE-POLICY-1","counter-name":"counter_seq_1","packets":"2","bytes":"196","lastupdated":1658198416779,"vdevice-dataKey":"169.254.10.9-ZONE-POLICY-1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write"}},"/device/ppp/interface":{"get":{"tags":["Real-Time Monitoring - PIM"],"description":"Get PPP interface list from device (Real Time)","operationId":"createPPPInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PPP interface list":{"description":"PPP interface list","value":{"data":[{"vdevice-dataKey":"169.254.10.9-ppp1","vdevice-name":"169.254.10.9","ifname":"ppp1","lastupdated":1654477366044,"pppoe-interface":"ge0/0","vpn-id":"0","vdevice-host-name":"vm2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/pppoe/session":{"get":{"tags":["Real-Time Monitoring - PPPoE"],"description":"Get PPPoE session list from device","operationId":"createPPPoEInterfaceList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PPPoE session list":{"description":"PPPoE session list","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"0","ifname":"ge0/1","session-id":"1","server-mac":"00:0c:29:2e:20:1a","local-mac":"00:0c:29:be:27:f5","ppp-interface":"ppp1","ac-name":"branch100","service-name":"-","vdevice-dataKey":"169.254.10.9","lastupdated":1658198416779}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/pppoe/statistic":{"get":{"tags":["Real-Time Monitoring - PPPoE"],"description":"Get PPPoE statistics from device","operationId":"createPPPoENeighborList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"PPPoE statistics":{"description":"PPPoE statistics","value":{"data":[{"pppoe-pads-pkts":"0","pppoe-ipcp-pkts":"0","vdevice-name":"169.254.10.10","pppoe-lcp-pkts":"0","pppoe-tx-session-drops":"0","pppoe-pado-pkts":"0","pppoe-padt-pkts":"0","pppoe-padr-pkts":"0","vdevice-host-name":"vm3","pppoe-tx-pkts":"0","pppoe-inv-discovery-pkts":"0","pppoe-rx-session-drops":"0","vdevice-dataKey":"169.254.10.10","pppoe-ccp-pkts":"0","lastupdated":1643355873158,"pppoe-rx-pkts":"0","pppoe-padi-pkts":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/queues":{"get":{"tags":["Monitoring - Device Details"],"description":"Get synchronized queue information, returns information about syncing, queued and stuck devices","operationId":"getSyncQueues","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue status":{"description":"Queue status","value":{"syncing":[],"queued":[],"Stuck":{}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/reachable":{"get":{"tags":["Monitoring - Device Details"],"description":"Get list of reachable devices","operationId":"listReachableDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceReachableData"},"examples":{"List of reachable devices":{"description":"List of reachable devices","value":"[\n {\n \"device-model\":\"vsmart\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:17 2021 GMT\",\n \"uuid\":\"bd7440de-aff6-4f9f-a99a-48d5f08b9fa5\",\n \"deviceId\":\"172.16.255.19\",\n \"syncScheduled\":1616436317638,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":0.22,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"ompPeersUp\":3,\n \"syncQueued\":1616436317586,\n \"isDeviceGeoData\":true,\n \"device-type\":\"vsmart\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-122.0\",\n \"syncCompleted\":1616436319560,\n \"domain-id\":\"1\",\n \"policy-template-name\":\"\",\n \"expectedControlConnections\":1,\n \"memUsageDisplay\":\"39.0\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":2,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.19\",\n \"controlConnectionsUp\":5,\n \"controlConnectionsToVsmarts\":\"1\",\n \"number-vbond-peers\":\"1\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"ompPeers\":\"3\",\n \"memState\":\"normal\",\n \"chassis-number\":\"bd7440de-aff6-4f9f-a99a-48d5f08b9fa5\",\n \"board_type\":\"None\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.19\",\n \"timezone\":\"UTC\",\n \"latitude\":\"45.0\",\n \"system-ip\":\"172.16.255.19\",\n \"site-id\":\"100\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:17 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345981\",\n \"@rid\":377,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vsmart\",\n \"memUsage\":39.0,\n \"lastDataSyncTime\":1616436319524,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"controlConnections\":\"5\",\n \"controlConnectionsDown\":0,\n \"availableVersions\":[\n\n ],\n \"policy-template-version\":\"\",\n \"number-vsmart-peers\":1,\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n\n ],\n \"host-name\":\"vm9\",\n \"uptime\":\"27 days 15 hrs 59 min 37 sec\",\n \"token\":\"-NA-\",\n \"cpuLoadDisplay\":\"0.22\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"number-vsmart-control-connections\":1,\n \"vmanage-system-ip\":\"172.16.255.19\",\n \"ompPeersDown\":0,\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616436319460,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045900000\n },\n {\n \"device-model\":\"vsmart\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:18 2021 GMT\",\n \"uuid\":\"0faa6449-8ab8-4e53-a580-893f16f80738\",\n \"deviceId\":\"172.16.255.20\",\n \"syncScheduled\":0,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":0.18,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"ompPeersUp\":3,\n \"syncQueued\":1616395493285,\n \"isDeviceGeoData\":true,\n \"device-type\":\"vsmart\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-90.0\",\n \"syncCompleted\":1616395494540,\n \"domain-id\":\"1\",\n \"policy-template-name\":\"\",\n \"expectedControlConnections\":1,\n \"memUsageDisplay\":\"39.0\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":2,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.20\",\n \"controlConnectionsUp\":5,\n \"controlConnectionsToVsmarts\":\"1\",\n \"number-vbond-peers\":\"1\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"ompPeers\":\"3\",\n \"memState\":\"normal\",\n \"chassis-number\":\"0faa6449-8ab8-4e53-a580-893f16f80738\",\n \"board_type\":\"None\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.20\",\n \"timezone\":\"UTC\",\n \"latitude\":\"45.0\",\n \"system-ip\":\"172.16.255.20\",\n \"site-id\":\"200\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:18 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345975\",\n \"@rid\":393,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vsmart\",\n \"memUsage\":39.0,\n \"lastDataSyncTime\":1616395494518,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"controlConnections\":\"5\",\n \"controlConnectionsDown\":0,\n \"availableVersions\":[\n\n ],\n \"policy-template-version\":\"\",\n \"number-vsmart-peers\":1,\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n\n ],\n \"host-name\":\"vm10\",\n \"uptime\":\"27 days 04 hrs 39 min 57 sec\",\n \"token\":\"-NA-\",\n \"cpuLoadDisplay\":\"0.18\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"number-vsmart-control-connections\":1,\n \"vmanage-system-ip\":\"172.16.255.20\",\n \"ompPeersDown\":0,\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616395494468,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045840000\n }\n{\n \"device-model\":\"vedge-cloud\",\n \"statusOrder\":4,\n \"total_cpu_count\":\"2\",\n \"groupId\":[\n \"none\"\n ],\n \"certificate-not-valid-before\":\"Feb 23 02:32:40 2021 GMT\",\n \"fp_cpu_count\":\"1\",\n \"uuid\":\"fd31a48b-2908-4315-a911-a3f2f0a8da24\",\n \"deviceId\":\"172.16.255.26\",\n \"syncScheduled\":1616411710011,\n \"chassis-serial-number\":\"None\",\n \"cpuLoad\":1.04,\n \"state_description\":\"All daemons up\",\n \"vsmart-list-version\":\"0\",\n \"vbond\":\"10.0.12.26\",\n \"syncQueued\":1616411703542,\n \"isDeviceGeoData\":false,\n \"device-type\":\"vbond\",\n \"state\":\"green\",\n \"firmwareVersion\":\"---\",\n \"organization-name\":\"vIPtela Inc Regression\",\n \"longitude\":\"-122.777023\",\n \"syncCompleted\":1616411711225,\n \"memUsageDisplay\":\"63.7\",\n \"model_sku\":\"None\",\n \"sp-organization-name\":\"vIPtela Inc Regression\",\n \"version\":\"20.6.999-756\",\n \"firmwareAvailablePackages\":\"[]\",\n \"layoutLevel\":3,\n \"bootloader_version\":\"Not applicable\",\n \"fips_mode\":\"enabled\",\n \"name\":\"172.16.255.26\",\n \"defaultVersion\":\"20.6.999-756\",\n \"status\":\"normal\",\n \"memState\":\"normal\",\n \"chassis-number\":\"fd31a48b-2908-4315-a911-a3f2f0a8da24\",\n \"board_type\":\"Sim\",\n \"device-os\":\"next\",\n \"local-system-ip\":\"172.16.255.26\",\n \"timezone\":\"UTC\",\n \"latitude\":\"37.666684\",\n \"system-ip\":\"172.16.255.26\",\n \"certificate-not-valid-after\":\"Feb 23 02:32:40 2022 GMT\",\n \"platform\":\"x86_64\",\n \"hardwareState\":\"--\",\n \"board-serial\":\"12345979\",\n \"@rid\":369,\n \"vedge-list-version\":\"0\",\n \"personality\":\"vbond\",\n \"memUsage\":63.7,\n \"lastDataSyncTime\":1616411711185,\n \"certificate-status\":\"Installed\",\n \"reachability\":\"reachable\",\n \"linux_cpu_count\":\"1\",\n \"availableVersions\":[\n\n ],\n \"vbond-standalone\":\"false\",\n \"connectedVManages\":[\n \"172.16.255.22\"\n ],\n \"testbed_mode\":true,\n \"syncState\":\"Completed\",\n \"firmwareAvailableVersions\":[\n\n ],\n \"host-name\":\"vm16\",\n \"tcpd_cpu_count\":\"0\",\n \"uptime\":\"27 days 09 hrs 09 min 40 sec\",\n \"cpuLoadDisplay\":\"1.04\",\n \"cpuState\":\"normal\",\n \"certificate-validity\":\"Valid\",\n \"vmanage-system-ip\":\"172.16.255.26\",\n \"vmanageConnectionState\":\"connected\",\n \"build_number\":\"756\\n\",\n \"lastupdated\":1616411711138,\n \"device-category\":\"controller\",\n \"device-groups\":[\n \"No groups\"\n ],\n \"hasGeoData\":true,\n \"uptime-date\":1614045900000\n} ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/reboothistory":{"get":{"tags":["Real-Time Monitoring - Reboot History"],"description":"Get device reboot history","operationId":"createRebootHistoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reboot history":{"description":"Device reboot history","value":{"data":[{"reboot_date_time-date":1642651714000,"lastupdated":1642656685355,"vdevice-dataKey":"172.16.255.11-2022-01-20T04:08:34+00:00","reboot_date_time":"2022-01-20T04:08:34+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,dca,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/reboothistory/details":{"get":{"tags":["Real-Time Monitoring - Reboot History"],"description":"Get detailed reboot history list","operationId":"getRebootHistoryDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Detailed device reboot history":{"description":"Detailed device reboot history","value":{"data":[{"reboot_date_time-date":1642651714000,"lastupdated":1642652319187,"reboot_date_time":"2022-01-20T04:08:34+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"},{"reboot_date_time-date":1642656388000,"lastupdated":1642656695661,"reboot_date_time":"2022-01-20T05:26:28+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"},{"reboot_date_time-date":1642657398000,"lastupdated":1642657658587,"reboot_date_time":"2022-01-20T05:43:18+00:00","reboot_reason":"reload","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"reboot_date_time-date":1642658548000,"lastupdated":1642659153477,"reboot_date_time":"2022-01-20T06:02:28+00:00","reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/reboothistory/synced":{"get":{"tags":["Real-Time Monitoring - Reboot History"],"description":"Get device reboot history synchronously","operationId":"createSyncedRebootHistoryList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reboot history":{"description":"Device reboot history","value":{"data":[{"reboot_date_time-date":1642658548000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T06:02:28+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T06:02:28+00:00","createTimeStamp":1642659153490,"lastupdated":1642659153477,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1078},{"reboot_date_time-date":1642651714000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T04:08:34+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T04:08:34+00:00","createTimeStamp":1642652319194,"lastupdated":1642652319187,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1086},{"reboot_date_time-date":1642656388000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T05:26:28+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T05:26:28+00:00","createTimeStamp":1642656696210,"lastupdated":1642656695661,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1095},{"reboot_date_time-date":1642659874000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T06:24:34+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T06:24:34+00:00","createTimeStamp":1642660158532,"lastupdated":1642660158402,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1103},{"reboot_date_time-date":1642659181000,"vmanage-system-ip":"172.16.255.11","reboot_date_time":"2022-01-20T06:13:01+00:00","vdevice-dataKey":"172.16.255.11-2022-01-20T06:13:01+00:00","createTimeStamp":1642659460686,"lastupdated":1642659460446,"reboot_reason":"Initiated by user - Reboot issued via NETCONF","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11","@rid":1104}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Device Monitoring-read,Device Monitoring-write,Software Upgrade-read,Software Upgrade-write,Device Reboot-read,Device Reboot-write,Software Upgrade > Edge-write,Software Upgrade > Edge-read,Software Upgrade > Controller-write,Software Upgrade > Controller-read"}},"/device/redundancy-group/app-group":{"get":{"tags":["Monitoring - Cedge Cflowd"],"description":"Get Redundancy Group Information","operationId":"getRedundancyGroupAppGroup","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}}],"responses":{"200":{"description":"Success","content":{"application/json":{}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/roleBasedCounters":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based Counters information from device","operationId":"getRoleBasedCounters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based counters information":{"description":"TrustSec role based counters information","value":{"data":[{"software-permit-count":"0","software-monitor-count":"0","software-deny-count":"0","vdevice-name":"172.16.255.15","total-permit-count":"0","src-sgt":55,"total-deny-count":"0","vdevice-host-name":"vm5","hardware-deny-count":"0","vdevice-dataKey":"172.16.255.15-vm5-55-66","hardware-permit-count":"0","lastupdated":1654768097970,"dst-sgt":66,"hardware-monitor-count":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/roleBasedIpv6Counters":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based Ipv6 Counters information from device","operationId":"getRoleBasedIpv6Counters","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based counters information":{"description":"TrustSec role based counters information","value":{"data":[{"software-permit-count":"0","software-monitor-count":"0","software-deny-count":"0","vdevice-name":"172.16.255.16","total-permit-count":"0","src-sgt":3,"total-deny-count":"0","vdevice-host-name":"vm6","hardware-deny-count":"0","vdevice-dataKey":"172.16.255.16-vm6-3-5","hardware-permit-count":"0","lastupdated":1654823680867,"dst-sgt":5,"hardware-monitor-count":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/roleBasedIpv6Permissions":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based ipv6 Permissions information from device","operationId":"getRoleBasedIpv6Permissions","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based permissions information":{"description":"TrustSec role based permissions information","value":{"data":[{"last-updated-time":"2036-02-07T06:28:16+00:00","num-of-sgacl":1,"vdevice-dataKey":"172.16.255.16-vm6-3-5","vdevice-name":"172.16.255.16","policy-life-time":"0","sgacl-name":"zhanglist2","monitor-mode":"false","src-sgt":3,"lastupdated":1654823603240,"dst-sgt":5,"vdevice-host-name":"vm6"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/roleBasedPermissions":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based Permissions information from device","operationId":"getRoleBasedPermissions","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based permissions information":{"description":"TrustSec role based permissions information","value":{"data":[{"last-updated-time":"2036-02-07T06:28:16+00:00","num-of-sgacl":1,"vdevice-dataKey":"172.16.255.15-vm5-55-66","vdevice-name":"172.16.255.15","policy-life-time":"0","sgacl-name":"acl1","monitor-mode":"false","src-sgt":55,"lastupdated":1654767424577,"dst-sgt":66,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/roleBasedSgtMap":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec Role Based SGT Map information from device","operationId":"getRoleBasedSgtMap","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec role based SGT map information":{"description":"TrustSec role based SGT map information","value":{"data":[{"vdevice-dataKey":"172.16.255.15-vm5-10.0.1.15/32-Default","ip":"10.0.1.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.0.20.15/32-Default","ip":"10.0.20.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.0.100.15/32-Default","ip":"10.0.100.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.1.15.15/32-Default","ip":"10.1.15.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"},{"vdevice-dataKey":"172.16.255.15-vm5-10.1.17.15/32-Default","ip":"10.1.17.15/32","sgt":10,"lastupdated":1652322326243,"source":"from-cli-hi","vrf-name":"Default","vdevice-host-name":"vm5","vdevice-name":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/sdwan-global-drop-statistics":{"get":{"tags":["Real-Time Monitoring - SDWAN Statistics"],"description":"Get SD-WAN global drop statistics detail from device (Real Time)","operationId":"getSDWanGlobalDropStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD-WAN global drop statistics":{"description":"SD-WAN global drop statistics","value":{"data":[{"ipv4-acl-lookup-miss-octets":"0","ip-ttl-exceeded-pkts":"0","unconfigured-mpls-fia-pkts":"0","tunnel-pkt-sb-missed-octets":"0","lisp-decap-failed-octets":"0","sdwan-bfd-octets":"0","gre-bad-options-pkts":"0","sdwan-data-policy-octets":"0","inv-common-preamble-pkts":"0","firewall-nonsession-octets":"0","bqs-oor-pkts":"0","unconfigured-ipv4-fia-pkts":"0","perf-lic-policer-lo-octets":"0","reass-frag-too-big-octets":"0","unsupport-linktype-no-route-pkts":"0","lisp-failed-to-punt-dynmaic-eid-config-pkts":"0","ipv4-no-adj-pkts":"323","sdwan-octets":"0","ipv6-acl-octets":"0","ipv4-acl-pkts":"0","firewall-backpressure-octets":"0","ipsec-input-octets":"6185","ipv6-adj-drop-pkts":"0","lookup-oce-unsupport-linktype-octets":"0","ipv6-no-adj-pkts":"6","reass-bad-len-octets":"0","ipv4-null0-pkts":"0","tcp-badfrag-pkts":"0","ip-bad-options-pkts":"0","reass-bad-len-pkts":"0","reass-no-frags-left-pkts":"0","reass-timeout-pkts":"0","ipv4-no-route-octets":"63122","oce-drop-adj-octets":"0","sdwan-generic-pkts":"0","no-gpm-memory-err-octets":"0","lisp-decap-failed-pkts":"0","frfab-wred-drop-octets":"0","ipsec-ted-indicate-octets":"0","lisp-sfltr-pkts":"0","tunnel-sec-chk-fail-octets":"0","pa-walk-err-pkts":"0","loadbalance-null0-pkts":"0","hqf-tx-error-octets":"0","ipv4mc-extra-replicae-octets":"0","ipv4-martian-pkts":"0","tcp-octets":"0","ipv4-pbr-pkts":"0","ipsec-invalid-sa-octets":"0","no-mem-octets":"0","ipv4-adj-drop-octets":"0","glean-adj-unsupport-linktype-octets":"0","vdevice-name":"169.254.10.12","ipv4-martian-octets":"0","identity-cft-error-pkts":"0","reass-frag-too-big-pkts":"0","lisp-disabled-octets":"0","udp-octets":"0","multilink-cfg-pkts":"0","pa-walk-err-octets":"0","bad-adj-octets":"0","unconfigured-ipv6-fia-pkts":"51334","flow-queue-failure-id-octets":"0","multilink-cfg-octets":"0","gpm-tx-len-exceed-pkts":"0","tunnel-decap-too-many-times-pkts":"0","inv-hdr-err-pkts":"0","attn-invalid-spid-octets":"0","tail-drop-octets":"0","tunnel-bad-gre-checksum-octets":"0","ipv4mc-ttl-threshold-chk-failed-pkts":"0","mpass-err-octets":"0","nat-out2in-octets":"0","ip-format-err-octets":"0","firewall-backpressure-pkts":"0","illegal-obj-pkts":"0","reass-overlap-octets":"0","bad-len-octets":"0","tunnel-misconfiguration-pkts":"0","reass-too-many-frags-octets":"0","punt-global-policer-drop-octets":"0","reass-too-many-frags-pkts":"0","frr-oce-invalid-state-octets":"0","invalid-queue-pkts":"0","ipv4mc-extra-replicae-pkts":"0","mpls-adj-drop-octets":"0","bad-uidb-idx-octets":"0","mpass-err-pkts":"0","ipv6-truncatedpkts-octets":"0","lastupdated":1645693979596,"ip-format-err-pkts":"0","ipsec-deny-drop-pkts":"0","invalid-encap-octets":"0","lookup-oce-should-drop-octets":"0","lisp-hash-lkup-failed-octets":"0","unresolved-octets":"0","ipv4-no-route-pkts":"398","lisp-failed-to-punt-gsmr-enabled-pkts":"0","ipv6-null0-pkts":"0","sdwan-bfd-pkts":"0","ipv4mc-invalid-replica-record-pkts":"0","unconfigured-fia-octets":"0","ext-drop-path-octets":"0","qos-actions-pkts":"0","mpass-invalid-fs-vector-pkts":"0","oce-drop-adj-pkts":"0","max-tu-octets":"0","invalid-encap-pkts":"0","mpls-pkts":"0","punt-err-pkts":"0","hqf-tx-error-pkts":"0","reass-drop-octets":"0","tail-drop-pkts":"0","ip-frag-err-octets":"0","punt-policer-drop-pkts":"0","mlp-pkts":"0","max-tu-pkts":"0","lisp-hash-lkup-failed-pkts":"0","inv-l2-hdr-pkts":"0","ipv4-unclassified-octets":"0","lisp-failed-to-punt-lsb-mismatch-pkts":"0","nat64-v6tov4-octets":"480","lisp-failed-to-punt-gsmr-enabled-octets":"0","sdwan-data-policy-pkts":"0","bqs-oor-octets":"0","ipv4-routing-err-pkts":"0","disabled-pkts":"2590","cts-format-octets":"0","bad-len-pkts":"0","ipv6-routing-err-octets":"0","illegal-obj-octets":"0","ipv6-unclassified-octets":"0","bad-uidb-idx-pkts":0,"bad-uidb-sub-idx-pkts":"0","for-us-pkts":"0","icmp-pkts":"0","invalid-wred-pkts":"0","lisp-elig-oce-octets":"0","bfd-octets":"0","sdwan-tloc-ext-pkts":"0","ipv4-acl-lookup-miss-pkts":"0","reass-no-frag-info-octets":"0","mpls-adj-drop-pkts":"0","sdwan-generic-octets":"0","reass-drop-pkts":"0","inv-common-preamble-octets":"0","bad-ip-checksum-octets":"0","ipv6-acl-lookup-miss-pkts":"0","reass-no-frag-info-low-pkts":"0","frr-oce-no-backup-pkts":"0","ipv6-unclassified-pkts":"0","mpls-mismatch-linktype-pkts":"0","wred-pkts":"0","ipv6-badsource-pkts":"0","lisp-disabled-pkts":"0","choice-oce-octets":"0","ipv6-acl-lookup-miss-octets":"0","bad-adj-pkts":"0","min-tu-octets":"0","nat-out2in-pkts":"0","unsupport-linktype-null0-octets":"0","firewall-invalid-zone-pkts":"0","lisp-failed-to-punt-dynmaic-eid-config-octets":"0","attn-invalid-spid-pkts":"0","not-enabled-octets":"0","fia-error-pkts":"0","bad-ip-checksum-pkts":"0","ipsec-ike-indicate-octets":"0","sdwan-app-route-policy-pkts":"0","ipv6-toobigpacket-octets":"0","ipv6-formaterr-octets":"0","ipv4mc-no-route-pkts":"0","mpls-frag-req-octets":"0","vdevice-dataKey":"169.254.10.12-","lookup-oce-should-drop-pkts":"0","cts-not-enable-octets":"0","loadbalance-null0-octets":"0","frr-oce-invalid-state-pkts":"0","tcp-pkts":"0","ipv6-acl-pkts":"0","nat-in2out-pkts":"0","ipv6-badhop-pkts":"0","ipv6-badsource-octets":"0","inv-hdr-err-octets":"0","tcp-badfrag-octets":"0","ipv4-mtr-octets":"0","ipsec-ted-indicate-pkts":"0","ipsec-output-octets":"0","nat66-out2in-octets":"0","lisp-misconfiguration-octets":"0","ipsec-output-pkts":"0","cts-not-enable-pkts":"0","mlp-octets":"0","qos-actions-octets":"0","iphc-octets":"0","disabled-octets":"403111","unknown-ext-header-pkts":"0","mpls-mismatch-linktype-octets":"0","ipv6-no-adj-octets":"456","fia-error-octets":"0","gre-bad-options-octets":"0","reass-overlap-pkts":"0","vfr-tail-drop-octets":"0","sdwan-acl-octets":"0","ipv4-null0-octets":"0","unresolved-pkts":"0","invalid-queue-octets":"0","sdwan-implicit-acl-octets":"55011","ipv4-routing-err-octets":"0","inject-err-pkts":"0","punt-policer-drop-octets":"0","reass-no-frag-info-low-octets":"0","min-tu-pkts":"0","ipsec-input-pkts":"17","perf-lic-policer-hi-octets":"0","mac-acl-lookup-miss-octets":"0","ipv6-no-route-pkts":"3","cts-format-pkts":"0","ipsec-deny-drop-octets":"0","ip-bad-options-octets":"0","frag-tail-drop-octets":"0","frr-oce-no-backup-octets":"0","internal-ctl-pkts":"0","flow-queue-failure-id-pkts":"0","unconfigured-mpls-fia-octets":"0","ip-ttl-exceeded-octets":"0","unsupported-oce-pkts":"0","sdwan-acl-pkts":"0","no-gpm-memory-err-pkts":"0","perf-lic-policer-hi-pkts":"0","nat64-v6tov4-pkts":"6","unsupport-linktype-null0-pkts":"0","ipv4mc-ttl-threshold-chk-failed-octets":"0","glean-adj-unsupport-linktype-pkts":"0","firewall-l4-insp-pkts":"0","mpass-invalid-fs-vector-octets":"0","inv-l2-hdr-octets":"0","mpls-frag-req-pkts":"0","internal-ctl-octets":"0","identity-cft-error-octets":"0","sdwan-pkts":"0","reass-no-frag-info-pkts":"0","mpls-octets":"0","sdwan-interface-policy-octets":"0","frag-tail-drop-pkts":"0","ip-acl-err-octets":"0","discard-pkts":"0","sdwan-tunnel-lkup-pkts":"0","not-enabled-pkts":"0","choice-oce-pkts":"0","lookup-oce-unsupport-linktype-pkts":"0","sdwan-app-route-policy-octets":"0","lisp-misconfiguration-pkts":"0","bad-uidb-sub-idx-octets":"0","reass-timeout-octets":"0","tunnel-decap-too-many-times-octets":"0","vdevice-host-name":"vm5","icmp-octets":"0","ipv4-adj-drop-pkts":"0","tunnel-invalid-protocol-pkts":"0","wred-octets":"0","lisp-sfltr-octets":"0","ipv6-no-route-octets":"168","unconfigured-ipv6-fia-octets":"5564369","for-us-octets":"0","vfr-tail-drop-pkts":"0","frfab-wred-drop-pkts":"0","ipsec-invalid-sa-pkts":"0","ipv6-null0-octets":"0","ipv4-acl-octets":"0","firewall-nonsession-pkts":"0","ipsec-tail-drop-pkts":"0","tunnel-misconfiguration-octets":"0","bfd-pkts":"0","ipv4mc-invalid-replica-record-octets":"0","ip-acl-err-pkts":"0","ipsec-ike-indicate-pkts":"0","idle-packet-octets":"0","unconfigured-ipv4-fia-octets":"0","ipv6-toobigpacket-pkts":"0","idle-packet-pkts":"0","ipv4mc-rpf-failed-pkts":"0","ip-frag-err-pkts":"0","sdwan-interface-policy-pkts":"0","vfr-err-pkts":"0","unknown-encap-octets":"0","ipv4mc-no-route-octets":"0","unsupported-oce-octets":"0","unconfigured-fia-pkts":"0","sdwan-tloc-ext-octets":"0","qos-policing-octets":"0","sdwan-implicit-acl-pkts":"607","internal-intf-err-pkts":"0","firewall-l4-insp-octets":"0","mac-acl-octets":"0","no-mem-pkts":"0","ipv4-mtr-pkts":"0","internal-intf-err-octets":"0","invalid-wred-octets":"0","ipsec-tail-drop-octets":"0","lisp-elig-oce-pkts":"0","layer2-no-route-pkts":"0","ipv6-routing-err-pkts":"0","ext-drop-path-pkts":"0","unsupport-linktype-no-route-octets":"0","mac-acl-lookup-miss-pkts":"0","ipv4-fpm-pkts":"0","nat-in2out-octets":"0","ipv6-adj-drop-octets":"0","ipv4-no-adj-octets":"20728","ipv4-fpm-octets":"0","punt-global-policer-drop-pkts":"0","ipv4-pbr-octets":"0","nat66-in2out-octets":"0","nat66-out2in-pkts":"0","nat66-in2out-pkts":"0","ipv6-formaterr-pkts":"0","vfr-err-octets":"0","mac-acl-pkts":"0","ipv6-truncatedpkts-pkts":"0","tunnel-pkt-sb-missed-pkts":"0","qos-policing-pkts":"0","gpm-tx-len-exceed-octets":"0","layer2-no-route-octets":"0","perf-lic-policer-lo-pkts":"0","null-jib-hdr-tbl-pkts":"0","ipv6-badhop-octets":"0","udp-pkts":"0","unknown-encap-pkts":"0","ipv4-unclassified-pkts":"0","tunnel-bad-gre-checksum-pkts":"0","tunnel-invalid-protocol-octets":"0","reass-no-frags-left-octets":"0","tunnel-sec-chk-fail-pkts":"0","ipv4mc-rpf-failed-octets":"0","lisp-failed-to-punt-lsb-mismatch-octets":"0","inject-err-octets":"0","iphc-pkts":"0","discard-octets":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/sdwan-stats":{"get":{"tags":["Real-Time Monitoring - SDWAN Statistics"],"description":"Get SD-WAN statistics detail from device (Real Time)","operationId":"getSDWanStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD-WAN statistics":{"description":"SD-WAN statistics","value":{"data":[{"ipv4-acl-out-drop-action-drop":"0","ipv4-acl-in-drop-action-drop":"0","ipv6-acl-in-drop-action-drop":"0","ipv4-acl-in-prior-implicit-acl-disallow-drop":"607","vdevice-name":"169.254.10.12","app-route-sla-strict-drop":"0","data-policy-in-drop-action-drop":"0","ipv6-acl-in-prior-implicit-acl-disallow-drop":"0","data-policy-out-drop-action-drop":"0","vdevice-host-name":"vm5","ipv4-acl-in-implicit-acl-allow-service-accept":"9484","ipv4-acl-out-police-exceed-drop":"0","ipv6-acl-out-police-exceed-drop":"0","ipv4-acl-in-police-exceed-drop":"0","ipv6-acl-in-police-exceed-drop":"0","vdevice-dataKey":"169.254.10.12-","ipv6-acl-out-drop-action-drop":"0","ipv6-acl-in-implicit-acl-allow-service-accept":"0","lastupdated":1645691843259,"data-policy-in-set-remote-tloc-fail-drop":"0","app-route-matched-none-drop":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/security/information":{"get":{"tags":["Real-Time Monitoring - Security"],"description":"Get security information from devices","operationId":"createSessionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Security information":{"description":"Security information","value":{"data":[{"authentication-type":"deprecated","replay-window":"512","rekey":"86400","lastupdated":1642754840126,"vdevice-dataKey":"169.254.10.12","vdevice-host-name":"vm5","fips-mode":"Disabled","vdevice-name":"169.254.10.12"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/sfp/detail":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP detail","operationId":"getDetail","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ge0/0","vdevice-name":"169.254.10.10","ifname":"ge0/0","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/1","vdevice-name":"169.254.10.10","ifname":"ge0/1","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/2","vdevice-name":"169.254.10.10","ifname":"ge0/2","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/3","vdevice-name":"169.254.10.10","ifname":"ge0/3","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/4","vdevice-name":"169.254.10.10","ifname":"ge0/4","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/5","vdevice-name":"169.254.10.10","ifname":"ge0/5","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/6","vdevice-name":"169.254.10.10","ifname":"ge0/6","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/7","vdevice-name":"169.254.10.10","ifname":"ge0/7","lastupdated":1643091761770,"present":"No","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sfp/diagnostic":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP diagnostic","operationId":"getDiagnostic","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-dataKey":"169.254.10.10-ge0/0","vdevice-name":"169.254.10.10","ifname":"ge0/0","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/1","vdevice-name":"169.254.10.10","ifname":"ge0/1","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/2","vdevice-name":"169.254.10.10","ifname":"ge0/2","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/3","vdevice-name":"169.254.10.10","ifname":"ge0/3","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/4","vdevice-name":"169.254.10.10","ifname":"ge0/4","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/5","vdevice-name":"169.254.10.10","ifname":"ge0/5","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/6","vdevice-name":"169.254.10.10","ifname":"ge0/6","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"},{"vdevice-dataKey":"169.254.10.10-ge0/7","vdevice-name":"169.254.10.10","ifname":"ge0/7","lastupdated":1643093876343,"present":"No","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sfp/diagnosticMeasurementAlarm":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP diagnostic measurement alarm","operationId":"getDiagnosticMeasurementAlarm","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-name":"169.254.10.10","vdevice-host-name":"vm1","ifname":"ge0/3","measurement":"Rx power","low-alarm-alarm":"Y","low-warning-alarm":"Y","high-warning-alarm":"N","high-alarm-alarm":"N","lastupdated":1661322671947,"vdevice-dataKey":"169.254.10.10-ge0/3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sfp/diagnosticMeasurementValue":{"get":{"tags":["Real-Time Monitoring - SFP"],"description":"Get SFP diagnostic measurement value","operationId":"getDiagnosticMeasurementValue","parameters":[{"name":"ifname","in":"query","description":"IF Name","schema":{"type":"string","enum":["ge0/0","ge0/1","ge0/2","ge0/3","ge0/4","ge0/5","ge0/6","ge0/7","system","eth0"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Serial interface":{"description":"Serial interface","value":{"data":[{"vdevice-name":"169.254.10.10","vdevice-host-name":"vm1","ifname":"ge0/3","measurement":"Rx power","unit-value":"mW","low-alarm-value":"0.010","low-warning-value":"0.016","high-warning-value":"1.585","high-alarm-value":"1.778","current-value":"0.000","lastupdated":1661324101365,"vdevice-dataKey":"169.254.10.10-ge0/3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/sig/getSigTunnelList":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"get Sig TunnelList","operationId":"getSigTunnelList","parameters":[{"name":"pageSize","in":"query","description":"Page Size","schema":{"type":"string"}},{"name":"offset","in":"query","description":"Page offset","schema":{"type":"string"}},{"name":"lastNHours","in":"query","description":"last n hours","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/getSigTunnelTotal":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"get Sig Tunnel Total coount","operationId":"getSigTunnelTotal","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":{"count":"0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/tunnelDashboard":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"Get SIG Zscaler tunnels from device","operationId":"tunnelDashboard","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/umbrella/tunnels":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"Get SIG Umbrella tunnels from device","operationId":"getSigUmbrellaTunnels","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Umbrella tunnels":{"description":"Sig Umbrella tunnels","value":[{"lastupdated":1649242617635,"tunnel-if-name":"Tunnel100512","tunnel-id":"94075","tunnel-name":"128.107.85.118","tunnel-state":"active","fsm-state":"fsm-state","http-resp-code":"200","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","last-http-req":"activate-req","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sig/zscaler/tunnels":{"get":{"tags":["Real-Time Monitoring - SIG"],"description":"Get SIG Zscaler tunnels from device","operationId":"getSigZscalerTunnels","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig Zscaler tunnels":{"description":"Sig Zscaler tunnels","value":[{"tunnel-if-name":"Tunnel100512","tunnel-fsm-state":"gre-add-tunnel","vdevice-name":"172.16.255.15","fqdn":"n/a","vdevice-host-name":"vm5","tunnel-id":"94075","last-http-req":"activate-req","vdevice-dataKey":"172.16.255.15","http-resp-code":"200","tunnel-name":"128.107.85.118","location-id":"43551040","lastupdated":1649242617635,"location-fsm-state":"location-init-state"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/smu":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device","operationId":"createSmuList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","smu-compatible-with":"16.6.1.0","package-state":"Not Installed","defect":"CSCxxXXXXX","smu-type":"reload","lastupdated":1661330128299,"vdevice-dataKey":"172.16.254.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/smu/synced":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device synchronously","operationId":"createSyncedSmuList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","smu-compatible-with":"16.6.1.0","package-state":"Not Installed","defect":"CSCxxXXXXX","smu-type":"reload","lastupdated":1661330128299,"vdevice-dataKey":"172.16.254.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/software":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device","operationId":"getAAAUcreateSoftwareListsers","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"default":"true","vdevice-dataKey":"169.254.10.10-20.6.2-432","software":true,"vdevice-name":"169.254.10.10","active":"true","lastupdated":1643356263821,"version":"20.6.2-432","vdevice-host-name":"vm3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/software/synced":{"get":{"tags":["Real-Time Monitoring - Software"],"description":"Get software list from device synchronously","operationId":"createSyncedSoftwareList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Software list":{"description":"Software list","value":{"data":[{"vdevice-name":"172.16.255.11","software":true,"createTimeStamp":1647315989838,"active":"true","version":"20.9.999-1787","vdevice-host-name":"vm1","default":"true","vdevice-dataKey":"172.16.255.11-20.9.999-1787","@rid":1084,"vmanage-system-ip":"172.16.255.11","lastupdated":1647315989833}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/sse/tunnels":{"get":{"tags":["Real-Time Monitoring - SSE"],"description":"Get SSE tunnels from device","operationId":"getSSETunnel","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sig SSE tunnels":{"description":"Sig SSE tunnels","value":[{"lastupdated":1649242617635,"tunnel-if-name":"Tunnel100512","tunnel-id":"94075","tunnel-name":"128.107.85.118","tunnel-state":"active","fsm-state":"fsm-state","http-resp-code":"200","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","last-http-req":"activate-req","vdevice-dataKey":"172.16.255.15"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write,Security-read,Security-write"}},"/device/sslproxy/statistics":{"get":{"tags":["Real-Time Monitoring - Sslproxy"],"description":"Get ssl proxy statistics from device","operationId":"getSslProxyStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Ssl proxy statistics":{"description":"Ssl proxy statistics","value":{"data":[{"exception":"0","app-ocsp-req-int-error":"0","decrypt-fail-mode":"0","ps-pkt-rec-from-client":"0","tot-client-cert-val-req":"0","c2s-fin-rec-from-sc":"0","tot-req-tls1-1-flows":"0","ocsp-stap-unknown-resp":"0","tot-failed-renego":"0","s2c-fin-rec":"0","pc-pkt-rec-from-server":"0","s2c-cn-rec":"0","c2s-fin-rec":"0","tot-client-cert-untrusted":"0","c2s-cn-rec-from-sc":"0","s2c-cn-rec-from-sc":"0","tot-ssl-renego":"0","s2c-fin-rec-from-sc":"0","drop-mempool-get-fail":"0","drop-load-key-packet-fail":"0","nodecrypt-unsup-cipher":"0","max-conc-non-proxied-conn":"0","pc-clr-pkt-rec-from-sc":"0","c2s-rst-generated":"0","pc-pkt-sent-to-server":"0","che-bypass":"0","s2c-rst-rec":"0","c2s-rst-rec":"0","che-pushdown":"0","client-ocsp-res":"0","ocsp-stap-reqs":"0","tot-server-cert-untrusted":"0","alert-genrtd-c2s":"0","vdevice-name":"169.254.10.12","alert-genrtd-s2c":"0","pc-rst-rec-from-sc":"0","c2s-cn-sent-to-sc":"0","lwssl-send-msg-toism-fail":"0","c2s-rst-rec-from-sc":"0","c2s-fin-sent":"0","ps-clr-pkt-to-client":"0","s2c-rst-rec-from-sc":"0","client-ocsp-reqs":"0","tot-ssl-resump-ses-tkt":"0","s2c-rst-sent":"0","drop-null-ch-buf":"0","non-proxied-conn":"0","hs-unsupported":"0","app-ocsp-good":"0","s2c-fin-rec-during-hs":"0","drop-inv-evt-in-fsm-state":"0","drop-unable-to-get-pr-cert":"0","lastupdated":1645776582193,"ism-sem-post-failed":"0","s2c-fin-rec-after-hs":"0","app-ocsp-res":"0","c2s-rst-sent-to-sc":"0","s2c-rst-sent-to-sc":"0","app-ocsp-unknown":"0","c2s-cn-rec":"0","ism-flow-create-fail":"0","c2s-cn-sent":"0","s2c-cn-sent":"0","ps-clr-pkt-rec-from-sc":"0","tot-client-cert-val-succes":"0","pc-pkt-rec-from-sc":"0","rm-session-alloc-success":"0","unsup-ssl-version":"0","ps-pkt-sent-to-sc":"0","alert-recvd-c2s":"0","alert-recvd-s2c":"0","endpoint-alert":"0","mem-alloc-fail":"0","ocsp-stap-valid-resp":"0","client-ocsp-revoked":"0","min-tls-version":"0","ssl-parse-failure":"0","s2c-fin-rec-non-ssl":"0","ism-flow-create":"0","rm-session-alloc-failures":"0","ps-lwssl-flow-delete":"0","drop-ssl-parse-abort":"0","drop-unsup-prot-vers":"0","tot-select-tls1-1-flows":"0","client-ocsp-failures":"0","pc-clr-pkt-rec-from-server":"0","pc-clr-pkt-sent-to-sc":"0","c2s-pkt-drop-deny-verdict":"0","decrypt-untrusted-cert":"0","peer-pd":"0","tot-server-cert-expired":"0","vdevice-dataKey":"169.254.10.12","pc-fin-rec-from-sc":"0","drop-untrusted-cert":"0","ocsp-stap-resp":"0","tcp-close-before-hs":"0","nodecrypt-unsup-prot-vers":"0","c2s-fin-rec-non-ssl":"0","tot-select-tls1-0-flows":"0","s2c-pkt-drop-deny-verdict":"0","c2s-fin-sent-to-sc":"0","s2c-fin-sent-to-sc":"0","client-ocsp-req-int-error":"0","client-ocsp-unknown":"0","app-ocsp-timeout":"0","tot-full-ssl-hs":"0","rm-session-free-success":"0","tot-req-sslv2-flows":"0","ps-cn-sent":"0","tot-ssl-hs-completed":"0","ps-clr-pkt-sent-to-sc":"0","ism-flow-delete":"0","tot-client-cert-expired":"0","drop-unknown-status":"0","clear-conn":"0","active-non-proxied-conn":"0","pc-lwssl-flow-create":"0","che-process":"0","client-ocsp-good":"0","tot-select-tls1-2-flows":"0","tot-ssl-hs-started":"0","drop-mem-access-issue":"0","app-ocsp-failures":"0","unknown-reasons":"0","tot-ssl-resump-ses-id":"0","app-ocsp-reqs":"0","tot-conn":"0","drop-null-ssl-rec":"0","drop-ocsp-cert-verify-fail":"0","drop-de-handle-data-fail":"0","ism-fifo-enqueue-failed":"0","unsup-cipher":"0","drop-fail-mode":"0","drop-invalid-fsm-evt":"0","drop-invalid-fs-type":"0","pc-fs-mem-alloc-fail":"0","error-state":"0","tot-server-cert-val-req":"0","vdevice-host-name":"vm5","s2c-cn-sent-to-sc":"0","drop-invalid-ssl-rec":"0","ps-clr-pkt-rec-from-client":"0","pc-lwssl-flow-delete":"0","tot-server-cert-val-succes":"0","c2s-fin-rec-during-hs":"0","drop-ism-flow-create-fail":"0","pc-cn-sent":"0","ps-lwssl-flow-create":"0","c2s-fin-rec-after-hs":"0","drop-expired-cert":"0","drop-key-pkt-snd-fail":"0","proxied-conn":"0","drop-other-side-key-pend":"0","active-proxied-conn":"0","max-conc-proxied-conn":"0","mem-access-issue":"0","unexpected-packet":"0","tot-ssl-resump":"0","ssl-error":"0","decrypt-exp-cert":"0","ps-pkt-sent-to-client":"0","rm-session-free-failures":"0","pc-clr-pkt-to-server":"0","drop-send-ism-hs-msg-fail":"0","ocsp-stap-revoked-resp":"0","client-ocsp-timeout":"0","ps-fin-rec-from-sc":"0","tot-req-sslv3-flows":"0","drop-invalid-msg-type":"0","che-strip":"0","active-clear-conn":"0","non-ssl-traffic":"0","drop-hs-unsupported":"0","max-conc-clear-conn":"0","ps-fs-mem-alloc-fail":"0","tot-req-tls1-0-flows":"0","pc-pkt-sent-to-sc":"0","s2c-rst-generated":"0","drop-unsup-cipher":"0","ocsp-stap-resp-val-fail":"0","tot-req-tls1-3-flows":"0","decrypt-unknown-status":"0","app-ocsp-revoked":"0","s2c-fin-sent":"0","tot-ssl-fb-full-hs":"0","drop-exp-cert":"0","drop-tcp-close-before-hs":"0","ps-pkt-rec-from-sc":"0","ism-msg-mem-alloc-failed":"0","tot-req-tls1-2-flows":"0","drop-endpoint-alert":"0","drop-mem-alloc-fail":"0","tot-closed-conn":"0","c2s-rst-sent":"0","drop-nop-read-fn":"0","ps-rst-rec-from-sc":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/sslproxy/status":{"get":{"tags":["Real-Time Monitoring - Sslproxy"],"description":"Get ssl proxy status from device","operationId":"getSslProxyStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Ssl proxy status":{"description":"Ssl proxy status","value":{"data":[{"failure-mode":"failure-mode-action-close","minimum-tls-version":"tls-ver-1","vdevice-name":"169.254.10.12","cert-lifetime-in-days":"730","unsup-cipher-suite":"unsup-mode-action-drop","expired-cert":"cert-valid-action-decrypt","untrusted-cert":"cert-valid-action-decrypt","ca-tp-label":"PROXY-SIGNING-CA","unknown-status":"cert-valid-action-drop","rsa-key-mod":"2048","clear-mode":"false","vdevice-host-name":"vm5","ec-key-type":"ec-key-p256","cert-revocation":"cert-rev-none","vdevice-dataKey":"169.254.10.12","ca-cert-bundle":"/bootflash/vmanage-admin/sslProxyDefaultCAbundle.pem","lastupdated":1645776060286,"unsup-protocol-version":"unsup-mode-action-drop"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/staticRouteTracker":{"get":{"tags":["Real-Time Monitoring - Static Route Tracker Service"],"description":"Get single static route tracker info from device","operationId":"getStaticRouteTrackerInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Static route tracker info":{"description":"Static route tracker info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/stats":{"get":{"tags":["Monitoring - Device Details"],"description":"Get stats queue information","operationId":"getStatsQueues","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue status":{"description":"Queue status","value":{"ProcessQueue-0":{"syncing":[],"queued":[],"stuck":{}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/status":{"get":{"tags":["Monitoring - Device Details"],"description":"Get devices status for vSmart,vBond,vEdge, and cEdge","operationId":"getAllDeviceStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device status list":{"description":"Device status list","value":{"header":{"generatedOn":1635236849570},"data":[{"type":"vSmart","name":"vSmart","image":"images/vsmart.png","count":3,"detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart","statusList":[{"status":"error","name":"Error","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=error","color":"fa7c7d","icon":"images/device/device-error.png","count":0},{"status":"warning","name":"Warning","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=warning","color":"f2ce60","icon":"images/device/device-warning.png","count":0},{"status":"normal","name":"Normal","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=normal","color":"b0e276","icon":"images/device/device-normal.png","count":3},{"status":"new","name":"Discovered device","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=new","color":"7c8afa","icon":"images/device/device-new.png","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/sxpConnections":{"get":{"tags":["Real-Time Monitoring - Trustsec"],"description":"get Cisco TrustSec SXP Connections information from device","operationId":"getSxpConnections","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TrustSec SXP Connections information":{"description":"TrustSec SXP Connections information","value":{"data":[{"listener-duration":"23","vdevice-dataKey":"172.16.255.15-vm5-10.1.16.116-Default","vdevice-name":"172.16.255.15","source-ip":"10.1.15.15","listener-state":"state-off","peer-ip":"10.1.16.116","vrf-name":"Default","lastupdated":1652319406421,"speaker-state":"state-off","vdevice-host-name":"vm5","local-mode":"con-mode-both","speaker-duration":"35008"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/sync_status":{"get":{"tags":["Monitoring - Device Details"],"description":"Get list of currently syncing devices","operationId":"listCurrentlySyncingDevices","parameters":[{"name":"groupId","in":"query","description":"Group Id","required":true,"schema":{"type":"string","default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"List of currently syncing devices":{"description":"List of currently syncing devices","value":{"header":{"generatedOn":1635237704919},"data":[{"name":"vedge-C8500-12X4QC","templateClass":"cedge","displayName":"C8500-12X4QC","deviceType":"vedge","isCliSupported":true,"templateSupported":true,"deviceClass":"cisco-router","cpuCountAttribute":{"enable":true,"attributeField":"total_cpu_count"},"interfaces":{"wan":["GigabitEthernet","TenGigabitEthernet","Loopback"],"lan":["GigabitEthernet","TenGigabitEthernet","Loopback"],"mgmt":["GigabitEthernet","TenGigabitEthernet","Loopback"],"day0":["GigabitEthernet0/0/0"]},"onboardCert":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/syncall/memorydb":{"post":{"tags":["Monitoring - Device Details"],"description":"Synchronize memory database for all devices","operationId":"syncAllDevicesMemDB","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/system/clock":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system clock","operationId":"getDeviceSystemClock","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system clock":{"description":"Device system clock","value":{"data":[{"current_date/date-time-string":"Tue Mar 15 16:46:40 UTC 2022"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/system/info":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device information list","operationId":"createDeviceInfoList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"array","example":"169.254.10.10","items":{"type":"string","example":"169.254.10.10"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device info":{"description":"Device info","value":{"data":[{"device-model":"vedge-cloud","statusOrder":4,"total_cpu_count":"2","max-controllers":"0","groupId":["none"],"certificate-not-valid-before":"Jan 29 00:19:35 2022 GMT","fp_cpu_count":"1","deviceId":"169.254.10.10","uuid":"bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e","syncScheduled":1644759037120,"chassis-serial-number":"None","cpuLoad":1.46,"state_description":"All daemons up","vsmart-list-version":"9223372036854775807","vbond":"10.103.135.135","ompPeersUp":2,"syncQueued":1644759037119,"isDeviceGeoData":false,"device-type":"vedge","state":"green","firmwareVersion":"---","organization-name":"vIPtela Inc Regression-Apple Inc","longitude":"-122.777023","syncCompleted":1644759039647,"domain-id":"1","downloadedServices":[],"availableServices":[],"expectedControlConnections":2,"memUsageDisplay":"24.1","model_sku":"None","sp-organization-name":"vIPtela Inc Regression","version":"20.6.2-440","firmwareAvailablePackages":"[]","layoutLevel":4,"bootloader_version":"Not applicable","fips_mode":"enabled","name":"169.254.10.10","controlConnectionsUp":3,"controlConnectionsToVsmarts":"2","number-vbond-peers":"1","defaultVersion":"20.6.2-440","status":"normal","ompPeers":"2","memState":"normal","chassis-number":"bc2a78ac-a06e-40fd-b2b7-1b1e062f3f9e","board_type":"Sim","device-os":"next","local-system-ip":"172.16.254.2","timezone":"UTC","latitude":"37.666684","system-ip":"169.254.10.10","site-id":"3","certificate-not-valid-after":"Jan 29 00:19:35 2023 GMT","downloadedImages":[],"platform":"x86_64","hardwareState":"normal","board-serial":"12345708","@rid":2493,"personality":"vedge","memUsage":24.1,"lastDataSyncTime":1644801887955,"certificate-status":"Installed","reachability":"reachable","controlConnections":"3","linux_cpu_count":"1","controlConnectionsDown":0,"availableVersions":[],"number-vsmart-peers":2,"connectedVManages":["169.254.10.3"],"testbed_mode":true,"syncState":"Completed","firmwareAvailableVersions":[],"host-name":"vm3","bfdSessionsDown":0,"tcpd_cpu_count":"0","uptime":"15 days 13 hrs 52 min 15 sec","token":"Invalid","cpuLoadDisplay":"1.46","certificate-validity":"Valid","cpuState":"normal","number-vsmart-control-connections":2,"vmanage-system-ip":"169.254.10.10","ompPeersDown":0,"bfdSessions":"5","tenantId":"c2c6093d-a33c-400a-90e8-1f549fe7a12c","vmanageConnectionState":"connected","build_number":"440\n","lastupdated":1644759039485,"device-category":"vedge","device-groups":["No groups"],"hasGeoData":true,"uptime-date":1643413080000,"isMultiStepUpgradeSupported":false,"bfdSessionsUp":5}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/system/statistics":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system stats list (Real Time)","operationId":"createDeviceSystemStatsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"tx_gre_pkts":132344,"tx_arp_replies":1700,"rx_icmp_port_unreach":303,"rx_window_drops_tc6":0,"rx_window_drops_tc7":0,"tx_arp_reqs":43535,"rx_window_drops_tc4":0,"rx_window_drops_tc5":0,"pko_wred_drops":0,"rx_window_drops_tc2":0,"rx_window_drops_tc3":0,"rx_window_drops_tc0":0,"rx_window_drops_tc1":0,"bfd_rx_non_ip":0,"ip_fwd_mcast_invalid_iif":0,"route_to_host":0,"tx_pkts":55508251,"arp_add_fail":51,"tx_ipsec_policer_drops":0,"tx_fragment_drops":0,"ip_fwd_from_cpu_non_local":0,"ip_fwd_null_mcast_group":0,"buf_alloc_fails":0,"fragment_df_drops":0,"rx_drops":0,"tx_fragment_fail":0,"bfd_lkup_fail":0,"rx_icmp_network_unreach":9,"vdevice-name":"169.254.10.10","tx_icmp_fragment_required":0,"cflowd_pkts":0,"tx_fragment_alloc_fail":0,"rx_replay_integrity_drops_tc3":0,"rx_replay_integrity_drops_tc4":0,"rx_replay_integrity_drops_tc5":0,"rx_sa_ipsec_drops":0,"rx_replay_integrity_drops_tc6":0,"openssl_aes_encrypt":0,"rx_replay_integrity_drops_tc7":0,"to_cpu_policer_drops":3173,"rx_icmp_redirect":0,"tx_no_tunn_pre_ipsec_drops":0,"tx_icmp_src_quench":0,"rx_icmp_ttl_expired":0,"rx_replay_integrity_drops_tc0":1,"rx_replay_integrity_drops_tc1":0,"rx_arp_reqs":1333,"rx_replay_integrity_drops_tc2":0,"tx_icmp_ttl_expired":0,"ip_fwd_mirror_pkts":0,"rx_non_ip_drops":1469202,"rx_icmp_bad_ip_hdr":0,"tx_ip6_ipsec_drops":0,"nat_xlate_outbound_drops":0,"rx_err_pad_ipsec_drops":0,"rx_pre_ipsec_pkts":0,"lastupdated":1644814365917,"tx_icmp_policer_drops":0,"mirror_drops":0,"rx_ipsec_bad_inner":0,"rx_ip_errs":0,"ip_fwd_null_nhop":132344,"tx_bcast":2353,"bfd_rx_parse_err":0,"rx_bcast":185,"rx_icmp_echo_requests":0,"tx_if_not_preferred":1197705,"tx_icmp_dst_unreach_other":0,"rx_invalid_port":0,"split_horizon_drops":0,"rx_icmp_other_types":5458,"rx_arp_replies":43098,"tx_no_out_sa_pre_ipsec_drops":0,"invalid_back_ptr":0,"rx_pkts":31444972,"rx_invalid_qtags":244,"ip_fwd_to_cpu_nat_drops":0,"tx_gre_drops":0,"rx_icmp_src_quench":0,"rx_gre_policer_drops":0,"cbf_discards":0,"tx_gre_policer_drops":0,"rx_arp_non_local_drops":161199,"ip_fwd_unknown_nh_type":0,"tx_arp_req_fail":0,"tx_icmp_echo_requests":486552,"ip_fwd_to_egress":22866794,"tx_ipsec_encap":16205725,"rx_tunneled_pkts":0,"bfd_tx_record_changed":374,"rx_mcast_mirror_fwd_drops":0,"rx_unexpected_replay_drops_tc1":0,"rx_unexpected_replay_drops_tc2":0,"rx_unexpected_replay_drops_tc3":0,"rx_invalid_ipsec_pkt_size":0,"rx_unexpected_replay_drops_tc4":0,"ip_disabled_tx":0,"rx_unexpected_replay_drops_tc0":0,"rx_ipsec_policer_drops":0,"rx_unexpected_replay_drops_tc5":0,"rx_unexpected_replay_drops_tc6":0,"rx_unexpected_replay_drops_tc7":0,"rx_replay_drops_tc7":0,"rx_replay_drops_tc5":0,"ip_fwd_to_cpu_nat_xlates":0,"rx_replay_drops_tc6":0,"vdevice-dataKey":"169.254.10.10","rx_replay_drops_tc3":0,"rx_replay_drops_tc4":0,"rx_replay_drops_tc1":0,"rx_ipsec_decap":16201636,"rx_replay_drops_tc2":0,"rx_spi_ipsec_drops":0,"rx_replay_drops_tc0":0,"rx_host_mirror_drops":0,"rx_gre_drops":0,"ip_fwd_nat_on_tunnel":0,"rx_cp_non_local":0,"ip_fwd_to_cpu":6893414,"bfd_rx_record_invalid":0,"no_nat_nexthop":0,"tx_fragment_needed":0,"ip_fwd_mcast_life_exceeded_drops":0,"rx_pre_ipsec_decap":0,"ip_fwd":46077192,"rx_unexpected_replay_drops":0,"bfd_rec_down":0,"tunnel_pmtu_lowered":0,"filter_drops":0,"rx_icmp_protocol_unreach":0,"tx_queue_exceeded":0,"nat_xlate_inbound_fail":0,"tx_icmp_bad_ip_hdr":0,"nat_xlate_inbound":0,"rx_arp_rate_limit_drops":0,"bfd_rec_invalid":1,"rx_implicit_acl_drops":869,"ip_disabled_rx":0,"rx_mac_compare_ipsec_drops":0,"tx_ipsec_pkts":16205725,"rx_mcast_threshold_exceeded":0,"bfd_timer_add_fail":0,"openssl_aes_decrypt":0,"nat_xlate_outbound":0,"tx_ipsec_mcast_encap":0,"rx_gre_decap":0,"tx_errors":0,"bfd_tx_pkts":16142569,"service_label_fwd":0,"unknown_nh_type":0,"rx_mcast_policy_fwd_drops":0,"rx_pre_ipsec_drops":0,"tx_icmp_host_unreach":0,"vdevice-host-name":"vm3","rx_icmp_host_unreach":0,"rx_icmp_dst_unreach_other":0,"tx_icmp_redirect":0,"rx_mcast_link_local":17935,"rx_host_local_pkt":0,"tx_fragments":0,"tx_icmp_port_unreach":50,"icmp_redirect":0,"rx_mcast":18682,"tx_mcast":55760,"tx_mcast_fragment_needed":0,"rx_replay_integrity_drops":1,"rx_mcast_filter_to_cpu":0,"ip_fwd_rx_gre":0,"tx_icmp_protocol_unreach":0,"port_disabled_rx":9018,"ttl_expired":0,"tx_gre_encap":132344,"bfd_rx_pkts":16138479,"ip_fwd_arp":1187,"tx_icmp_network_unreach":0,"ip_fwd_invalid_tun_oil":0,"ip_fwd_rx_ipsec":16202760,"tx_icmp_other_types":654,"rx_no_tun_if":0,"app_route_policy_discards":0,"tx_no_out_sa_ipsec_drops":0,"rx_bad_label":0,"tx_pre_ipsec_pkts":16205725,"rx_mcast_filter_to_cpu_and_fwd":0,"tx_pre_ipsec_policer_drops":0,"rx_next_hdr_ipsec_drops":0,"bfd_tx_fail":0,"rx_ip6_ipsec_drops":0,"tunnel_loop_drops":0,"tx_arp_rate_limit_drops":0,"bfd_alloc_fail":0,"tx_pre_ipsec_encap":16205725,"ip_v6_mcast_drops":0,"port_disabled_tx":193,"ecmp_discards":0,"tx_icmp_echo_replies":0,"rx_icmp_fragment_required":0,"ip_fwd_from_cpu_nat_xlates":0,"rx_icmp_echo_replies":486048,"tx_no_tunn_ipsec_drops":0,"tx_no_arp_drop":0,"tx_vsmart_drop":0,"rx_policer_drops":0,"ip_fwd_invalid_oil":0,"rx_replay_drops":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/system/status":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system status list (Real Time)","operationId":"createDeviceSystemStatusList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system status":{"description":"Device system status","value":{"data":[{"mem_used":"954024","procs":"244","disk_avail":"7015M","disk_mount":"/","board_type":"Sim","vdevice-name":"169.254.10.10","total_cpu_count":"2","mem_cached":"740972","reboot_type":"Not Applicable","disk_fs":"/dev/root","fp_cpu_count":"1","chassis-serial-number":"None","min1_avg":"1.06","state_description":"All daemons up","personality":"vedge","disk_used":"174M","disk_use":"2","disk_status":"enabled","state":"green","config_date/date-time-string":"Mon Feb 14 04:47:05 UTC 2022","linux_cpu_count":"1","cpu_user":"5.53","testbed_mode":"1","min15_avg":"1.08","disk_size":"7615M","cpu_idle":"91.96","mem_buffers":"82140","model_sku":"None","cpu_system":"2.51","version":"20.6.2-440","min5_avg":"1.10","tcpd_cpu_count":"0","vdevice-host-name":"vm3","mem_total":"3906816","uptime":"16 days 05 hrs 08 min 45 sec","vdevice-dataKey":"169.254.10.10","mem_free":"2129680","bootloader_version":"Not applicable","fips_mode":"enabled","build_number":"440\n","lastupdated":1644814027189,"loghost_status":"disabled","uptime-date":1643413080000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/device/system/synced/status":{"get":{"tags":["Real-Time Monitoring - System"],"description":"Get device system stats list synchronously","operationId":"createSyncedDeviceSystemStatusList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"vdevice-name":"172.16.255.11","board_type":"Sim","total_cpu_count":"2","reboot_type":"NotApplicable","fp_cpu_count":"1","chassis-serial-number":"None","state_description":"Alldaemonsup","@rid":1175,"personality":"vedge","disk_status":"enabled","state":"green","linux_cpu_count":"1","testbed_mode":"1","createTimeStamp":1647316043522,"model_sku":"None","version":"20.9.999-1787","tcpd_cpu_count":"0","vdevice-host-name":"vm1","vdevice-dataKey":"172.16.255.11","vmanage-system-ip":"172.16.255.11","bootloader_version":"Notapplicable","fips_mode":"enabled","lastupdated":1647316042867,"build_number":"1787\n","loghost_status":"disabled","uptime-date":1647312840000}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/device/tcpopt/activeflows":{"get":{"tags":["Real-Time Monitoring - TCP Optimization"],"description":"Get TCP optimized active flows from device (Real Time)","operationId":"getActiveTCPFlows","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TCP optimized active flow":{"description":"TCP optimized active flow","value":{"data":[{"vdevice-name":"172.16.254.1","vdevice-host-name":"vm2","vpn-id":"1","src-ip":"10.20.24.17","dest-ip":"10.20.25.18","src-port":53723,"dest-port":22,"start-time":"Fri Mar 17 13:21:02 2022","egress-intf-name":"loop0.3","ingress-intf-name":"ge0_4","tx-bytes":"153","rx-bytes":"64","tcp-state":"In progress","unopt-reason":"-","delete-reason":"-","proxy-identity":"Client-Proxy","lastupdated":0,"vdevice-dataKey":"172.16.254.1"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/tcpopt/expiredflows":{"get":{"tags":["Real-Time Monitoring - TCP Optimization"],"description":"Get TCP optimized expired flows from device (Real Time)","operationId":"getExpiredTCPFlows","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TCP optimized expired flow":{"description":"TCP optimized expired flow","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","src-ip":"10.20.24.17","dest-ip":"10.20.25.18","src-port":53722,"dest-port":22,"start-time":"Fri Mar 17 13:16:26 2022","end-time":"Fri Mar 17 13:17:51 2022","tx-bytes":"4113","rx-bytes":"4333","tcp-state":"Optimized","unopt-reason":"-","proxy-identity":"Client-Proxy","delete-reason":"Closed","vdevice-dataKey":"169.254.10.9","lastupdated":1659327030348}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/tcpopt/summary":{"get":{"tags":["Real-Time Monitoring - TCP Optimization"],"description":"Get TCP optimization summary from device (Real Time)","operationId":"getTCPSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TCP optimization summary":{"description":"TCP optimization summary","value":{"data":[{"flows-expired":"0","vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","flows-optimized":"0","lastupdated":1644816147644,"flows-passthrough":"0","vdevice-host-name":"vm3","flows-in-progress":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/device/tcpproxy/statistics":{"get":{"tags":["Real-Time Monitoring - Tcpproxy"],"description":"Get tcp proxy statistics from device","operationId":"getTcpProxyStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tcp proxy statistics":{"description":"Tcp proxy statistics","value":{"data":[{"syn-purged-enq":"0","tot-fin-processed":"0","enable-rx-called":"0","tot-ev-tx-enable-process":"0","tot-send-fail":"0","tot-ssl-trig-rst-wkq-fail":"0","tcpp-aoim-sync-done":"0","tot-tcp-buf-sent":"0","tot-ssl-pause-called":"0","tot-ssl2svc-buf-enq":"0","tcp-flow-stats-del-fail":"0","enable-rx-queued":"0","tot-tcp-buf-rcvd":"0","tot-bytes-read-less-512":"0","tot-dre-resume-to-be-sent":"0","sync-fail-marked-cleanup":"0","sync-fail-entry-invalid":"0","tot-clean-server-data-q":"0","tot-ssl-resume-done":"0","ssl-init-failure":"0","tot-bytes-read-less-1024":"0","tot-tcp-buf-alloc":"0","pre-list-enq-failed":"0","tot-actual-pause-done":"0","tot-tcp-flow-clean-done":"0","tot-sc-reset-rcvd":"0","tot-rx-ssl-pause-process":"0","tot-async-event-send":"0","tot-bytes-read-less-4096":"0","vpath-cleanup-from-nmrx":"0","tcp-flow-entries-created":"0","tot-ssl-pause-done":"0","tot-tx-async-event-proc":"0","tcp-flow-stats-add-fail":"0","unif-logg-deq-no-space":"0","vdevice-name":"169.254.10.12","tot-snort-resume-done":"0","tot-pause-count-buf":"0","tot-snort-reset-init":"0","tot-buf-128k-alloc-failed":"0","unified-logging-msg-recvd":"0","tot-bytes-read-less-2048":"0","wcapi-svc-flow-delete-f":"0","sync-flow-mismatch":"0","num-stack-cb-null-ctx":"0","tot-tcp-buf-128k-alloc":"0","tot-clean-flow-ign":"0","cur-rx-epoll-count":"0","cur-tx-epoll-count":"0","curr-val-tcp-flow-entries":"0","unified-logg-deq-succ":"0","tx-enq-failure-count":"0","tot-reset-processed":"0","vpath-cleanup-from-evlib":"0","tot-en-rx-sock-stk-cl-svr":"0","tot-rx-dre-pause-process":"0","unified-logg-data-too-long":"0","sync-fail-nat-entry-null":"0","tot-tcp-reset-rcvd":"0","current-conn-count":"0","tot-ssl-fin-rcvd":"0","tot-tcp-buf-16k-alloc":"0","tot-buf-16k-alloc-failed":"0","tot-ssl-server-init":"0","vdevice-host-name":"vm5","tot-sc-fin-rcvd":"0","sync-fail-entry-null":"0","tot-ssl-buf-free":"0","tot-buff-drop-sock-closed":"0","enable-rx-done":"0","tot-page-alloc-retry":"0","tot-resume-count-buf":"0","lastupdated":1646012087379,"tx-enqueue-drops-close":"0","unified-logg-enq-succ":"0","proxy-cleanup-enq":"0","tot-ssl-reset-init":"0","tot-buff-drop-sock-not-av":"0","conn-failed":"0","tot-dre-resume-done":"0","tcpp-aoim-sync-error":"0","timer-expire-cleanup-enq":"0","tcp-flow-inv-entries":"0","other-cleanup-enq":"0","tot-page-alloc-failed":"0","tot-ssl2tcp-buf-enq":"0","tot-clean-add-wk-q-fail":"0","tot-dre-resume-msg-sent":"0","tot-uhi-munmap":"2768","pre-list-enq":"0","tot-fin-ign-fd-close":"0","tot-buf-32k-alloc-failed":"0","flow-drop-sn-gbl-health-y":"0","stack-cleanup-enq":"0","pre-remove-cleanup":"0","tot-en-rx-sock-stk-cl-clnt":"0","total-conns":"0","tot-ev-resume-process":"0","tot-svc2ssl-buf-enq":"0","tot-page-free":"0","conn-in-progress":"0","tot-dre-close-init":"0","clean-req-watcher-called":"1104871","tot-async-event-process":"0","tot-svc-reset-processed":"0","tot-page-alloc-fail-size":"0","flows-drop-wcapi-health-y":"0","tot-rx-snort-pause-proc":"0","pre-remove-err-timer":"0","tot-uhi-mmap":"88936","tot-page-alloc":"0","tot-cleanup-add-to-wk-q":"0","stack-cleanup-enq-failed":"0","pre-remove-accept":"0","tot-tcp2ssl-buf-enq":"0","tot-ssl-clean-addwkq-fail":"0","tot-ssl-buf-alloc":"0","tot-actual-resume-done":"0","tot-pause-count":"0","wcapi-svc-flow-create-f":"0","enable-rx-enq-failed":"0","flow-drop-sn-inst-health-y":"0","max-conns":"0","proxy-cleanup-enq-failed":"0","tot-ssl-reset-rcvd":"0","pre-rem-err-accept":"0","tot-ssl-reset-rcvd-sc":"0","wcapi-svc-flow-close-f":"0","other-cleanup-enq-failed":"0","tot-ssl-fin-rcvd-sc":"0","tot-tcp-buf-free":"0","tot-resume-count":"0","tot-tcp-fin-rcvd":"0","tot-tcp-buf-32k-alloc":"0","tot-clean-msg-rcvd":"0","tot-clean-client-data-q":"0","enable-rx-failed":"0","curr-tcp-flow-entries":"0","syn-purge-enq-failed":"0","tot-tx-async-event-send":"0","wcapi-svc-data-send-f":"0","tcp-flow-entries-deleted":"0","timer-ex-clean-enq-failed":"0","pre-clean-time-update":"0","vdevice-dataKey":"169.254.10.12","tot-ssl-buf-alloc-failed":"0","tot-ssl-resume-called":"0","tcpp-aoim-sync-started":"0","tot-dre-pause-done":"0","tot-tcp-buf-alloc-failed":"0","tot-snort-pause-done":"0","sync-fail-entry-inuse":"0","syncache-add-done":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/tcpproxy/status":{"get":{"tags":["Real-Time Monitoring - Tcpproxy"],"description":"Get tcp proxy status from device","operationId":"getTcpProxyStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tcp proxy status":{"description":"Tcp proxy status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","oper-state":"running","sng-name":"SNG-APPQOE","lastupdated":1646011762240,"sng-addr":"192.168.2.2","vdevice-host-name":"vm5","vpg-name":"VirtualPortGroup2","vpg-addr":"192.168.2.1","vpg-netmask":"255.255.255.0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/tier":{"get":{"tags":["Monitoring - Device Details"],"description":"getTiers","operationId":"getTiers","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Device Details"],"description":"add tier","operationId":"addTier","parameters":[{"name":"addTier","in":"path","description":"addTier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/device/tier/{tierName}":{"delete":{"tags":["Monitoring - Device Details"],"description":"deleteTier","operationId":"deleteTier","parameters":[{"name":"tierName","in":"path","description":"deletetier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tloc":{"get":{"tags":["Monitoring - Device Details"],"description":"Get TLOC status list","operationId":"getDeviceTlocStatus","parameters":[{"name":"deviceId","in":"query","schema":{"type":"string"}},{"name":"color","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceTlocDataWithBFD"},"examples":{"Tloc Status":{"description":"Tloc Status","value":[{"color":"default","system-ip":"172.16.255.22","expectedControlConnections":2,"controlConnectionsUp":8,"controlConnectionsToVsmarts":2,"controlConnectionsDown":0},{"color":"default","system-ip":"172.16.255.20","expectedControlConnections":1,"controlConnectionsUp":15,"controlConnectionsToVsmarts":1,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.21","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.21","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"red","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"gold","system-ip":"172.16.255.11","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":5,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.14","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":10,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.16","bfdSessionsDown":0,"controlConnectionsUp":3,"controlConnectionsToVsmarts":"--","bfdSessionsUp":10,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.16","bfdSessionsDown":0,"controlConnectionsUp":2,"controlConnectionsToVsmarts":"--","bfdSessionsUp":9,"controlConnectionsDown":0},{"color":"default","system-ip":"172.16.255.19","expectedControlConnections":1,"controlConnectionsUp":15,"controlConnectionsToVsmarts":1,"controlConnectionsDown":0},{"color":"lte","system-ip":"172.16.255.15","bfdSessionsDown":0,"controlConnectionsUp":3,"bfdSessionsUp":9,"controlConnectionsDown":0},{"color":"3g","system-ip":"172.16.255.15","bfdSessionsDown":0,"controlConnectionsUp":2,"bfdSessionsUp":10,"controlConnectionsDown":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tlocutil":{"get":{"tags":["Monitoring - Device Details"],"description":"Get TLOC list","operationId":"getDeviceTlocUtil","parameters":[{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TLOC list":{"description":"TLOC list","value":{"header":{"generatedOn":1635311915500,"title":"Transport Interface Distribution","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-TlocUtilization"},"columns":[{"title":"Percentage Distribution","property":"percentageDistribution","dataType":"string"},{"title":"Value","property":"value","dataType":"number"}],"fields":[{"property":"percentageDistribution","dataType":"string"},{"property":"value","dataType":"number"}]},"data":[{"name":"less_than_10_mbps","percentageDistribution":"< 10 Mbps","detailsURL":"/dataservice/device/tlocutil/detail?util=lessthan10mbps","value":0},{"name":"10_mbps_100_mbps","percentageDistribution":"10 Mbps - 100 Mbps","detailsURL":"/dataservice/device/tlocutil/detail?util=10mbps100mbps","value":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tlocutil/detail":{"get":{"tags":["Monitoring - Device Details"],"description":"Get detailed TLOC list","operationId":"getDeviceTlocUtilDetails","parameters":[{"name":"util","in":"query","description":"Tloc util","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}},{"name":"util","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Detailed TLOC list":{"description":"Detailed TLOC list","value":{"header":{"generatedOn":1635314596057,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-TlocUtilizationDetails"},"columns":[{"title":"Average","property":"average","hideable":false,"dataType":"number"}],"fields":[{"property":"system-ip","dataType":"string"},{"property":"average","dataType":"number"}]},"data":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Generate admin tech logs","operationId":"createAdminTech","requestBody":{"description":"Admin tech generation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechCreateReq"},"examples":{"Generate Admin tech log":{"description":"Generate Admin tech log","value":{"deviceIP":"10.3.0.1","device-type":"vmanage","exclude-cores":true,"exclude-tech":false,"exclude-logs":false}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintech/copy":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"copy admin tech logs","operationId":"copyAdminTechOnDevice","requestBody":{"description":"Admin tech copy request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechReq"},"examples":{"Copy Admin tech log":{"description":"Copy Admin tech log","value":{"deviceIP":"10.3.0.1","fileName":"10.3.0.1-20200522-102611-admin-tech.tar.gz"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintech/delete":{"delete":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"delete admin tech logs","operationId":"deleteAdminTechOnDevice","requestBody":{"description":"Admin tech delete request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechReq"},"examples":{"Delete Admin tech log":{"description":"Delete Admin tech log","value":{"deviceIP":"10.3.0.1","fileName":"10.3.0.1-20200522-102611-admin-tech.tar.gz"}}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintech/download/{filename}":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Download admin tech logs","operationId":"downloadAdminTechFile","parameters":[{"name":"filename","in":"path","description":"Admin tech file","required":true,"schema":{"type":"string"},"example":"172.16.255.14-vm4-20240605-175206-admin-tech.tar.gz"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintech/supportedfeatures/{deviceModel}/{deviceIP}/{personality}":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"summary":"Get supported admin tech features","description":"Get supported admin tech features","operationId":"getSupportedAdminTechFeatures","parameters":[{"name":"deviceModel","in":"path","description":"device Model","required":true,"schema":{"$ref":"#/components/schemas/DeviceModel"}},{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"$ref":"#/components/schemas/DeviceIP"}},{"name":"personality","in":"path","description":"personality","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/admintech/{requestID}":{"delete":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Delete admin tech logs","operationId":"deleteAdminTechFile","parameters":[{"name":"requestID","in":"path","description":"Request Id of admin tech generation request","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"}},"/device/tools/admintechlist":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"List admin tech logs","operationId":"listAdminTechsOnDevice","requestBody":{"description":"Admin tech listing request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechListReq"},"examples":{"List Admin tech log":{"description":"List Admin tech log","value":{"deviceIP":"10.3.0.1"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdminTechListRes"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintechs":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Get device admin-tech information","operationId":"listAdminTechs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechsRes"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/Admintechs"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintechs/inprogress":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Get device admin-tech InProgressCount","operationId":"getInProgressCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InProgressCount"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/AdmintechsInProgress"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/admintechs/upload":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"upload admin tech to SR","operationId":"uploadAdminTech","requestBody":{"description":"Admin tech upload request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTechsUploadReq"},"examples":{"upload Admin tech log":{"description":"upload Admin tech log","value":{"sr_number":"69131837254","token":"9b42986QTUc","vpn":"VPN 0","requestTokenId":"ea8cb172-61c4-47e0-8957-ac83b384f53e"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write,dca"}},"/device/tools/factoryreset":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Device factory reset","operationId":"factoryReset","requestBody":{"description":"Device factory reset","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device factory reset":{"description":"Device factory reset","value":{"deviceIP":"172.16.255.16","resetOption":"full-wipe/retain-license"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/netstat":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get device tool net stat","operationId":"getDeviceToolsNetstat","parameters":[{"name":"vpn","in":"query","description":"VPN","schema":{"type":"string","enum":["0","512"]}},{"name":"options","in":"query","description":"Options","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tools netstat Data Example":{"description":"Tools netstat Data Example","value":"{{\n \"rawOutput\": [\n \"Active Internet connections (w/o servers)\",\n \"Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name\",\n \"tcp 0 0 vm1:ssh 10.0.1.1:54932 ESTABLISHED 8964/sshd: admin [p\",\n \"Active UNIX domain sockets (w/o servers)\",\n \"Proto RefCnt Flags Type State I-Node PID/Program name Path\",\n \"unix 3 [ ] STREAM CONNECTED 1154465 3283/ftmd /var/run/.ftmd.512\",\n \"unix 3 [ ] STREAM CONNECTED 767015 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 1154461 2519/zebra \",\n \"unix 3 [ ] STREAM CONNECTED 767017 2181/cfgmgr /var/run/quagga/zebra_protobuf_notify.api.512\",\n \"unix 3 [ ] STREAM CONNECTED 1177839 8966/0 \",\n \"unix 2 [ ] STREAM CONNECTED 1177830 8964/sshd: admin [p \",\n \"unix 3 [ ] STREAM CONNECTED 1177840 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 1177838 8964/sshd: admin [p \",\n \"unix 2 [ ] DGRAM 766216 2519/zebra \"\n ]\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/nping/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"NPing device","operationId":"npingDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ping parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPingRequest"},"examples":{"Ping parameter":{"description":"Ping parameter","value":{"host":"10.1.12.16","probeType":"icmp","source":"10.1.12.15","interfaceIP":"10.1.12.15","vpn":"0"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NPingResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/device/tools/nslookup":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get device tool nslookup","operationId":"getDeviceToolsNSlookup","parameters":[{"name":"vpn","in":"query","description":"VPN","required":true,"schema":{"type":"string","enum":["0","512"]}},{"name":"dns","in":"query","description":"DNS","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"8.8.8.8"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device tool nslookup data":{"description":"Device tool nslookup data","value":{"rawOutput":["Server: 10.0.1.1","Address 1: 10.0.1.1","","Name: 8.8.8.8","Address 1: 8.8.8.8"]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/ping/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Ping device","operationId":"pingDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ping parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingRequest"},"examples":{"Ping parameter":{"description":"Ping parameter","value":{"host":"10.1.12.16","source":"10.1.12.15","vpn":"0"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/device/tools/porthopcolor/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Request port hop color","operationId":"processPortHopColor","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device port hop color","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device port hop color":{"description":"Device port hop color","value":{"color":"mpls"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/realtimeinfo":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get hardware real time info from device","operationId":"getRealTimeinfo","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"hardware real time info data":{"description":"hardware real time info data","value":"{\t\"hardware-info\" : \"Hardware Information\\n---------------------------------\\n\nBaseboard Details:\\nboard type : ISR1100-4G\\nboard serial number:\nISR1100-4G-FCH2414L04T\\n-------------------------------\\nTPM Details:\\nAikido FPGA : 07250006\\n---------------------------------------------------------\\nBootloader version:\\nBIOS Version:17.7(1r)\\nBootloader Source: Upgrade\nBIOS\\n----------------------------------------------------------------\\nTemperature threshold history:\\n\",\n\"Kernel-log\" : \"Critical Kernel Logs:\"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/reset/interface/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Reset device interface","operationId":"processInterfaceReset","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device interface","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetInterfaceReq"},"examples":{"Device interface":{"description":"Device interface","value":{"vpnId":"512","ifname":"GigabitEthernet1"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-write"}},"/device/tools/resetuser/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Request reset user","operationId":"processResetUser","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device user reset","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device user reset":{"description":"Device user reset","value":{"user":"admin"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/servicepath/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Service path","operationId":"servicePath","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Service path parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Service path parameter":{"description":"Service path parameter","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/ss":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get device tool ss","operationId":"getDeviceToolsSS","parameters":[{"name":"vpn","in":"query","description":"VPN","schema":{"type":"string","enum":["0","512"]}},{"name":"options","in":"query","description":"Options","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device tool SS data ":{"description":"Device tool SS data ","value":{"rawOutput":["Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process ","u_str ESTAB 0 0 * 767015 * 0 users:((\"zebra\",pid=2519,fd=13)) ","u_str ESTAB 0 0 /var/run/quagga/zebra_protobuf_notify.api.512 767017 * 0 users:((\"cfgmgr\",pid=2181,fd=30)) ","u_str ESTAB 0 0 * 1154461 * 0 users:((\"zebra\",pid=2519,fd=16)) ","u_str ESTAB 0 0 /var/run/.ftmd.512 1154465 * 0 users:((\"ftmd\",pid=3283,fd=58)) ","u_str ESTAB 0 0 * 1177830 * 0 users:((\"sshd\",pid=8966,fd=6),(\"sshd\",pid=8964,fd=6)) ","u_str ESTAB 0 0 * 1177839 * 0 users:((\"sshd\",pid=8966,fd=5)) ","u_str ESTAB 0 0 * 1177840 * 0 users:((\"sshd\",pid=8964,fd=7)) ","u_dgr ESTAB 0 0 * 766216 * 0 users:((\"zebra\",pid=2519,fd=3)) ","u_dgr ESTAB 0 0 * 1177838 * 0 users:((\"sshd\",pid=8966,fd=3),(\"sshd\",pid=8964,fd=3)) ","tcp ESTAB 0 0 10.0.1.11:ssh 10.0.1.1:54932 users:((\"sshd\",pid=8966,fd=4),(\"sshd\",pid=8964,fd=4)) "]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/system-netfilter":{"get":{"tags":["Real-Time Monitoring - Tools"],"description":"Get system netfilter info from device","operationId":"getSystemNetfilter","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"System Netfilter info":{"description":"System Netfilter info","value":{"ipv4":"Chain POLICE_PROT (2 references)\n pkts bytes target prot opt in out source destination\n 113K 16M ACCEPT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT tcp -- * * 0.0.0.0/0 172.16.255.11 tcp dpt:830\n 0 0 ACCEPT icmp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0\n 0 0 ACCEPT 89 -- ge0_2 * 0.0.0.0/0 0.0.0.0/0\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:22\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:179\n 0 0 ACCEPT tcp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 ACCEPT udp -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 udp spt:67 dpt:68\nChain INPUT (policy ACCEPT 760K packets, 433M bytes)\n pkts bytes target prot opt in out source destination\n 113K 16M POLICE_PROT tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 0 0 LOGGING tcp -- * * 0.0.0.0/0 0.0.0.0/0 tcp dpt:830\n 921K 494M ACCEPT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0 ctstate ESTABLISHED\n 0 0 POLICE_PROT all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0\n 0 0 LOGGING all -- ge0_2 * 0.0.0.0/0 0.0.0.0/0\nChain LOGGING (2 references)\n pkts bytes target prot opt in out source destination\n 0 0 DROP all -- * * 0.0.0.0/0 0.0.0.0/0","ipv6":"Chain INPUT (policy ACCEPT 90 packets, 5040 bytes)\n pkts bytes target prot opt in out source destination\n 0 0 ACCEPT all ge0_2 * ::/0 ::/0 ctstate ESTABLISHED\n 30 1680 POLICE_PROT all ge0_2 * ::/0 ::/0\n 0 0 LOGGING all ge0_2 * ::/0 ::/0\nChain POLICE_PROT (1 references)\n pkts bytes target prot opt in out source destination\n 0 0 ACCEPT tcp * * ::/0 ::/0 tcp dpt:830\n 30 1680 ACCEPT icmpv6 ge0_2 * ::/0 ::/0\n 0 0 ACCEPT 89 ge0_2 * ::/0 ::/0\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:22\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:179\n 0 0 ACCEPT tcp ge0_2 * ::/0 ::/0 tcp dpt:830\n 0 0 ACCEPT udp ge0_2 * ::/0 ::/0 udp spt:547 dpt:546\nChain LOGGING (1 references)\n pkts bytes target prot opt in out source destination\n 0 0 DROP all * * ::/0 ::/0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/tools/traceroute/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Traceroute","operationId":"tracerouteDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Traceroute parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TracerouteRequest"},"examples":{"Traceroute parameter":{"description":"Traceroute parameter","value":{"deviceIp":"172.16.255.15","host":"10.1.12.16","interface":"10.1.12.15","interfaceIP":"10.1.12.15","vpn":"0"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TracerouteResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/device/tools/tunnelpath/{deviceIP}":{"post":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"TunnelPath","operationId":"tunnelPath","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TunnelPath parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"TunnelPath parameter":{"description":"TunnelPath parameter","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/transport/connection":{"get":{"tags":["Real-Time Monitoring - Transport"],"description":"Get transport connection list from device","operationId":"createTransportConnectionList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Transport connection list":{"description":"Transport connection list","value":{"data":[{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"0","lastupdated":1644816647932,"source":"0.0.0.0","time":"Fri Feb 11 18:19:43 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"1","lastupdated":1644816647933,"source":"0.0.0.0","time":"Fri Feb 11 18:16:58 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"2","lastupdated":1644816647933,"source":"0.0.0.0","time":"Fri Feb 4 18:19:51 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"3","lastupdated":1644816647933,"source":"0.0.0.0","time":"Fri Feb 4 18:17:06 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"4","lastupdated":1644816647934,"source":"0.0.0.0","time":"Thu Feb 3 18:23:58 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"5","lastupdated":1644816647934,"source":"0.0.0.0","time":"Thu Feb 3 18:21:13 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"6","lastupdated":1644816647935,"source":"0.0.0.0","time":"Wed Feb 2 18:19:38 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"7","lastupdated":1644816647935,"source":"0.0.0.0","time":"Wed Feb 2 18:16:47 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"8","lastupdated":1644816647935,"source":"0.0.0.0","time":"Tue Feb 1 18:19:56 2022","state":"up","vdevice-host-name":"vm3","track-type":"tloc"},{"vdevice-dataKey":"169.254.10.10--","vdevice-name":"169.254.10.10","destination":"10.103.135.135","index":"9","lastupdated":1644816647936,"source":"0.0.0.0","time":"Tue Feb 1 18:17:11 2022","state":"down","vdevice-host-name":"vm3","track-type":"tloc"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/tunnel/bfd_statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel BFD statistics all devices","operationId":"createBfdStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tunnel BFD statistics":{"description":"Tunnel BFD statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"bfd-echo-rx-pkts":0,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":0,"bfd-echo-tx-octets":0,"bfd-pmtu-rx-octets":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","bfd-pmtu-tx-pkts":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","lastupdated":1644817628460,"source-ip":"10.0.3.3","bfd-echo-tx-pkts":0,"bfd-pmtu-rx-pkts":0,"bfd-echo-rx-octets":0},{"dest-ip":"10.101.2.2","source-port":12366,"bfd-echo-rx-pkts":427365,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":307216,"bfd-echo-tx-octets":71583641,"bfd-pmtu-rx-octets":307216,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":376,"dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":427365,"bfd-pmtu-rx-pkts":376,"bfd-echo-rx-octets":71583634},{"dest-ip":"10.101.4.4","source-port":12366,"bfd-echo-rx-pkts":427523,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":307090,"bfd-echo-tx-octets":71610106,"bfd-pmtu-rx-octets":305818,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":375,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":427523,"bfd-pmtu-rx-pkts":375,"bfd-echo-rx-octets":71610099},{"dest-ip":"10.102.5.5","source-port":12366,"bfd-echo-rx-pkts":449468,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":531622,"bfd-echo-tx-octets":75208785,"bfd-pmtu-rx-octets":2835599,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":2157,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":449468,"bfd-pmtu-rx-pkts":2157,"bfd-echo-rx-octets":75362995},{"dest-ip":"10.102.6.6","source-port":12366,"bfd-echo-rx-pkts":449575,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":531622,"bfd-echo-tx-octets":75226641,"bfd-pmtu-rx-octets":2835599,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":2157,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":449575,"bfd-pmtu-rx-pkts":2157,"bfd-echo-rx-octets":75380984},{"dest-ip":"10.102.16.16","source-port":12366,"bfd-echo-rx-pkts":449641,"vdevice-name":"169.254.10.10","bfd-pmtu-tx-octets":531622,"bfd-echo-tx-octets":75237437,"bfd-pmtu-rx-octets":2835599,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","bfd-pmtu-tx-pkts":2157,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","lastupdated":1644817628460,"source-ip":"10.101.3.3","bfd-echo-tx-pkts":449641,"bfd-pmtu-rx-pkts":2157,"bfd-echo-rx-octets":75392298}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/fec_statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel fec statistics","operationId":"createFecStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"tunnel fec statistics":{"description":"tunnel fec statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","fec-tx-data-pkts":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.0.3.3","fec-dynamic":"false"},{"dest-ip":"10.101.2.2","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.101.4.4","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.102.5.5","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.102.6.6","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"},{"dest-ip":"10.102.16.16","source-port":12366,"vdevice-name":"169.254.10.10","fec-rx-parity-pkts":0,"fec-capable":"false","fec-tx-parity-pkts":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","fec-tx-data-pkts":0,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","fec-rx-data-pkts":0,"fec-reconstruct-pkts":0,"lastupdated":1644821014912,"source-ip":"10.101.3.3","fec-dynamic":"false"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/gre-keepalives":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get GRE keep alive information","operationId":"createGreKeepalivesList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"GRE keep alive":{"description":"GRE keep alive","value":{"data":[{"dest-ip":"30.30.30.30","vdevice-name":"169.254.10.10","rx-packets":0,"rx-errors":0,"oper-state":"down","tx-errors":0,"admin-state":"up","vpn-id":"10","vdevice-host-name":"vm3","ka-enabled":"true","remote-tx-packets":0,"if-name":"gre1","vdevice-dataKey":"169.254.10.10-10-gre1","tx-packets":81366,"remote-rx-packets":0,"lastupdated":1644817234436,"source-ip":"10.0.3.3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/ipsec_statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel IPSec statistics all devices","operationId":"createIpsecStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tunnel IPSec statistics":{"description":"Tunnel IPSec statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","vdevice-name":"169.254.10.10","lastupdated":1644818093996,"source-ip":"10.0.3.3","vdevice-host-name":"vm3","tunnel-protocol":"gre"},{"dest-ip":"10.101.2.2","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","ipsec-decrypt-inbound":428675,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":428675},{"dest-ip":"10.101.4.4","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","ipsec-decrypt-inbound":428832,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":428832},{"dest-ip":"10.102.5.5","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","ipsec-decrypt-inbound":452605,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":452605},{"dest-ip":"10.102.6.6","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","ipsec-decrypt-inbound":452712,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":452712},{"dest-ip":"10.102.16.16","source-port":12366,"vdevice-name":"169.254.10.10","ipsec-rx-failures":0,"ipsec-rx-auth-failures":0,"ipsec-tx-auth-failures":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","ipsec-decrypt-inbound":452777,"lastupdated":1644818093996,"source-ip":"10.101.3.3","ipsec-tx-failures":0,"ipsec-encrypt-outbound":452777}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/packet-duplicate":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel statistics packet duplication statistics","operationId":"createPacketDuplicateStatistics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"tunnel statistics packet duplication stats":{"description":"tunnel statistics packet duplication stats","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.0.3.3","pktdup-tx-other":0},{"dest-ip":"10.101.2.2","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.101.4.4","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.102.5.5","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.102.6.6","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0},{"dest-ip":"10.102.16.16","source-port":12366,"pktdup-tx":0,"pktdup-rx-other":0,"vdevice-name":"169.254.10.10","pktdup-rx":0,"pktdup-rx-this":0,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","pktdup-capable":"false","lastupdated":1644820446648,"source-ip":"10.101.3.3","pktdup-tx-other":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/tunnel/statistics":{"get":{"tags":["Real-Time Monitoring - Tunnel"],"description":"Get tunnel statistics all devices","operationId":"createStatisticsList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tunnel statistics":{"description":"Tunnel statistics","value":{"data":[{"dest-ip":"30.30.30.30","source-port":0,"vdevice-name":"169.254.10.10","rx_pkts":0,"tcp-mss-adjust":1392,"tx_octets":0,"vdevice-host-name":"vm3","tunnel-protocol":"gre","tx_pkts":0,"dest-port":0,"vdevice-dataKey":"169.254.10.10-gre-10.0.3.3-30.30.30.30-0-0","rx_octets":0,"tunnel-mtu":1476,"lastupdated":1644819414066,"source-ip":"10.0.3.3"},{"dest-ip":"10.101.2.2","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":431317,"system-ip":"172.16.254.1","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":72492445,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":431317,"dest-port":12346,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.2.2-12366-12346","rx_octets":72492438,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.101.4.4","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":431474,"system-ip":"172.16.254.3","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":72518784,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":431474,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.101.4.4-12366-12366","rx_octets":72517505,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.102.5.5","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":455393,"system-ip":"172.16.254.4","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":76373141,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":455393,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.5.5-12366-12366","rx_octets":78844158,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.102.6.6","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":455504,"system-ip":"172.16.254.5","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":76391653,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":455504,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.6.6-12366-12366","rx_octets":78862831,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"},{"dest-ip":"10.102.16.16","source-port":12366,"vdevice-name":"169.254.10.10","rx_pkts":455567,"system-ip":"172.16.254.16","tcp-mss-adjust":1361,"remote-color":"default","tx_octets":76401957,"vdevice-host-name":"vm3","tunnel-protocol":"ipsec","local-color":"default","tx_pkts":455567,"dest-port":12366,"vdevice-dataKey":"169.254.10.10-ipsec-10.101.3.3-10.102.16.16-12366-12366","rx_octets":78873632,"tunnel-mtu":1441,"lastupdated":1644819414066,"source-ip":"10.101.3.3"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write,System-read,System-write"}},"/device/ucse/stats":{"get":{"tags":["Real-Time Monitoring - Ucse"],"description":"Get UCSE stats entry from device","operationId":"createUcseStats","parameters":[{"name":"remote-tloc-address","in":"query","description":"Remote TLOC address","schema":{"type":"string"}},{"name":"remote-tloc-color","in":"query","description":"Remote tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"local-tloc-color","in":"query","description":"Local tloc color","schema":{"type":"string","enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{" UCSE stats entry":{"description":" UCSE stats entry","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.254.15","lastupdated":1646031617468,"slot-num":"0","subslot-num":"1","shutdown-count":"1","status-count":"0","server-raid-password-reset-count":"1","server-bios-password-reset-count":"2","server-reload-count":"1","server-reset-count":"1","server-start-count":"1","server-stop-count":"1","imc-password-reset-count":"1","imc-vlan-count":"1","imc-access-port-count":"1","imc-ip-count":"1","stats-start-time":"13:59:27 PDT Jun 5 2022"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Security-read,Security-write"}},"/device/umbrella/device-registration":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella device registration from device","operationId":"getUmbrellaDevReg","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella device registration":{"description":"Umbrella device registration","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vdevice-dataKey":"169.254.10.9","vpn-id":"1","intf-name":"GigabitEthernet1/0/1","state":"SUCCESS","deviceID":"010a9b2b0d5cb21f","org-id":1892929,"retry-count":10,"tag":"vpn29","label":"-","http-response-code":200,"http-response-text":"SUCCESS","last-error":"-","last-code":"-","last-code-text":"-","lastupdated":1659327030348}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/dnscrypt":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella DNScrypt information from device","operationId":"getUmbrellaDNSCrypt","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella DNScrypt information":{"description":"Umbrella DNScrypt information","value":{"data":[{"vdevice-name":"169.254.10.10","index":0,"serial-num":0,"vdevice-host-name":"vm3","certificate-valid-from":"Jan 01 00:00:00 1970 GMT","client-magic":"0:0:0:0","vdevice-dataKey":"169.254.10.10-0","certificate-validity":"Invalid","client-public-key":"B40F:FA9A:31BB:690:C9F:7FEF:60A6:7FF5:286A:F519:64B2:586B:E35E:E4F0:E496:7FEE","certificate-state":"Init","resolver-public-key":"0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0","certificate-valid-till":"Jan 01 00:00:00 1970 GMT","lastupdated":1644823735329,"certificate-last-refresh-time":"Jan 01 00:00:00 1970 GMT","resolver-address":"208.67.222.222"},{"vdevice-name":"169.254.10.10","index":1,"serial-num":0,"vdevice-host-name":"vm3","certificate-valid-from":"Jan 01 00:00:00 1970 GMT","client-magic":"0:0:0:0","vdevice-dataKey":"169.254.10.10-1","certificate-validity":"Invalid","client-public-key":"97A1:BCCD:92FE:7FCE:2EC7:CEBC:B6CB:7589:9E63:D830:5D56:FEFD:301E:56C3:D9EF:1851","certificate-state":"Init","resolver-public-key":"0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0","certificate-valid-till":"Jan 01 00:00:00 1970 GMT","lastupdated":1644823735329,"certificate-last-refresh-time":"Jan 01 00:00:00 1970 GMT","resolver-address":"208.67.220.220"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/dp-stats":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella dp-stats from device","operationId":"getUmbrellaDpStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella dp-stats":{"description":"Umbrella dp-stats","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vpn-id":"1","local-domain-bypass-pkts":"0","dnscrypt-dec-rcvd":"0","redirect-pkts":"0","dnscrypt-enc-sent":"0","dnscrypt-errors":"0","parser-errors":"0","lastupdated":1659327030348,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/overview":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella overview from device","operationId":"getUmbrellaOverview","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella overview":{"description":"Umbrella overview","value":{"data":[{"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","registrations-requested":"0","registrations-completed":"0","lastupdated":1644823908956,"dnscrypt":"true","vdevice-host-name":"vm3","last-success-attempt":"0000-00-00T00:00:00+00:00"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/umbrella/umbrella-config":{"get":{"tags":["Real-Time Monitoring - Umbrella"],"description":"Get Umbrella configuration from device","operationId":"getUmbrellaConfig","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Umbrella configuration":{"description":"Umbrella configuration","value":{"data":[{"vdevice-dataKey":"169.254.10.10","vdevice-name":"169.254.10.10","ldb-status":"-N/A-","public-key":"B0E1:6D15:C32D:4E8C:996B:635A:FA90:05B9","lastupdated":1644823464208,"DNSCrypt":"Enabled","vdevice-host-name":"vm3","resolver-address":"208.67.222.222, 208.67.220.220"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/unclaimed/vedges":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get unclaimed vEdges from vbond","operationId":"getUnclaimedVedges","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Unclaimed vEdges":{"description":"Unclaimed vEdges","value":{"data":[{"vdevice-name":"172.16.255.15","chassis-number":"07a08f05-ad1d-4ccc-b383-dc608f4eb2a3","serial-number":"E66DC14C154D4861","subject-serial-number":"E66DC14C154D4861","org":"viptela.local"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Routing-read,Routing-write,System-read,System-write"}},"/device/unconfigured":{"get":{"tags":["Monitoring - Device Details"],"description":"Get wan edge devices not configured by vManage (that is, those in CLI mode)","operationId":"getUnconfigured","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Device"}},"examples":{"Unconfigured devices":{"description":"Unconfigured devices","value":[{"uuid":"3e314ce8-cbaf-4fc7-882b-bacd16bd9a33","systemIp":"172.16.255.11","deviceType":"vedge"},{"uuid":"a9d47933-ee30-4e9f-bee6-a2ac81a0b284","systemIp":"172.16.255.21","deviceType":"vedge"},{"uuid":"e417ea1d-43dd-4285-8077-f7e20975568a","systemIp":"172.16.255.14","deviceType":"vedge"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/unreachable":{"get":{"tags":["Monitoring - Device Details"],"description":"Get list of unreachable devices","operationId":"listUnreachableDevices","parameters":[{"name":"personality","in":"query","description":"Device personality (vedge OR vsmart OR vbond... )","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"List of unreachable devices":{"description":"List of unreachable devices","value":{"header":{"generatedOn":1635316653935,"viewKeys":{"uniqueKey":["system-ip"],"preferenceKey":"grid-vManage Control Connections"},"columns":[{"title":"Reachability","property":"reachability","colorProperty":"reachability","color":[{"key":"reachable","value":"616161"},{"key":"unreachable","value":"ef5350"},{"key":"auth-failed","value":"ffb300"}],"width":100,"minWidth":90,"dataType":"string"},{"title":"Hostname","property":"host-name","display":"iconAndText","iconProperty":"device-type","hideable":false,"icon":[{"key":"vmanage","value":"images/vmanage_table.png"},{"key":"vedge","value":"images/vedge_table.png"},{"key":"vedge-vbond","value":"images/vedge-vbond_table.png"},{"key":"vsmart","value":"images/vsmart_table.png"},{"key":"vbond","value":"images/vbond_table.png"}],"width":150,"dataType":"string"}],"fields":[{"property":"board-serial","dataType":"string"},{"property":"lastupdated","dataType":"date"}]},"data":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/unreachable/{deviceIP}":{"delete":{"tags":["Monitoring - Device Details"],"description":"Delete unreachable device","operationId":"removeUnreachableDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/users":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get users from device (Real Time)","operationId":"getUsersFromDevice","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Users":{"description":"Users","value":[{"from":"10.0.1.1","proto":"ssh","login-time":"2022-01-26T07:36:15+00:00","auth-group":"netadmin log ","lastupdated":1644914131016,"vdevice-dataKey":"172.16.255.11-28","session":"28","user":"admin","context":"cli","vdevice-host-name":"vm1","vdevice-name":"172.16.255.11"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/users/list":{"get":{"tags":["Real-Time Monitoring - AAA"],"description":"Get all users from device","operationId":"getAllDeviceUsers","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Users":{"description":"Users","value":{"data":[{"user":"admin"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Tools-read,Tools-write"}},"/device/utd/dataplane-config":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane config from Device","operationId":"getUTDDataplaneConfig","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane config":{"description":"UTD data plane config","value":{"data":[{"sn-redirect":"fail-open","vdevice-name":"172.16.255.15","context-flag":"8847361","defense-mode":"IPS","context-id":"0","redirect-type":"divert","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15-0","threat-inspection":"enabled","engine":"Standard","domain-filtering":"not-enabled","url-filtering":"not-enabled","lastupdated":1659514008513,"state":"enabled","all-interface":"enabled"},{"sn-redirect":"fail-open","vdevice-name":"172.16.255.15","context-flag":"13041665","defense-mode":"IPS","context-id":"3","redirect-type":"divert","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15-3","threat-inspection":"enabled","engine":"Standard","domain-filtering":"not-enabled","url-filtering":"enabled","lastupdated":1659514008513,"state":"enabled","all-interface":"enabled"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/dataplane-global":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane global from Device","operationId":"getUTDDataplaneGlobal","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane global":{"description":"UTD data plane global","value":{"data":[{"utd-appnav-dereg-failed":"0","utd-appnav-health-down":"0","vdevice-name":"172.16.255.15","utd-appnav-health-yellow":"0","init-service-plane-failed":"0","sn-threads":"12","cft-utd-fo-id":"4","cft-feat-id":"4","sn-health":"green","nat64":"disabled","utd-appnav-health-green":"1","multi-tenancy":"enabled","max-flows":"165000","cft-utd-fo-chunk-id":"12","utd-appnav-health-unknown":"0","utd-appnav-health-red":"1","vdevice-host-name":"vm5","dp-initialized":"yes","vdevice-dataKey":"172.16.255.15","cft-id":"0","utd-appnav-register":"0","utd-appnav-deregister":"0","utd-appnav-reg-failed":"0","lastupdated":1659514090144,"drop-pkts":"disabled"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/dataplane-stats":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane stats from Device","operationId":"getUTDDataplaneStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane stats":{"description":"UTD data plane stats","value":{"data":[{"cft-ager-del-fo":"0","utd-appnav-decaps-icmp-no-payload-err":"0","utd-drop-cft-lookup-flow":"0","utd-pkts-enter-divert":"0","utd-appnav-encaps-debug-err":"0","utd-appnav-decaps-ip-unsup-ver":"0","cft-ager-del-fo-failed":"0","utd-flow-bypass":"0","utd-packets-reinjected":"0","utd-sn-drop":"0","utd-drop-cft-get-fo":"0","utd-appnav-decaps-icmp-v6-tcp-err":"0","utd-df-blacklist-match":"0","utd-drop-appnav-decaps-class-event-err":"0","pkt-skip-invalid-iuidb":"0","pkt-skip-for-us":"0","utd-appnav-decaps-icmp-no-inner-flow":"0","utd-appnav-encap-fail":"0","utd-appnav-encaps-fail":"0","pkt-skip-unsupport-prot":"0","utd-appnav-decaps-icmp-udp-err":"0","utd-drop-msg-logged":"0","utd-appnav-decaps-no-fo":"0","utd-drop-bad-ip-ver":"0","utd-drop-cft-alloc-fo":"0","utd-drop-nat64-int-lookup-fail":"0","utd-drop-appnav-encaps-debug":"0","pkt-no-inspect-divert-intf":"4516","utd-drop-divert-down":"0","pkt-policy-inspected":"87657","min-utd-drop-cause":"0","pkt-nat-dropped-pkt":"0","utd-appnav-decaps-icmp-tcp-err":"0","utd-df-gray-flows":"0","vdevice-name":"172.16.255.15","utd-drop-ipv6-frag":"0","init-cft-inst-get-failed":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-decaps-del-term":"0","pkt-skip-new-pkt":"0","init-vfr-unreg-failed":"0","utd-drop-appnav-encaps-vrf":"0","utd-appnav-decaps-tlv-len-err":"0","utd-appnav-decaps-icmp-no-inner-fo":"0","utd-appnav-decaps-icmp-v6-udp-err":"0","utd-appnav-redirect-fail":"0","utd-drop-cft-attach-fo":"0","utd-appnav-decaps-not-icmp-v6":"0","utd-appnav-decaps-icmp-v6-no-payload-err":"0","utd-pm-udpconns":"0","flow-setup-failed":"0","utd-df-whitelist-match":"0","utd-drop-appnav-encaps-service-add":"0","vdevice-host-name":"vm5","utd-drop-appnav-encaps-not-enuf":"0","utd-appnav-decaps-del-unknown":"0","utd-drop-cft-no-fo":"0","utd-drop-appnav-encaps-conn-handle-err":"0","skp-no-divert-needed":"0","utd-drop-was-vfr":"0","lastupdated":1659514165829,"utd-df-blacklisted-flows":"0","utd-appnav-decaps":"0","utd-appnav-decaps-icmp-unsup-proto":"0","utd-drop-appnav-encaps-no-fo":"0","utd-appnav-encaps":"0","utd-active-conns":"0","utd-appnav-decaps-no-flow":"0","utd-bypass-drop":"0","utd-appnav-decaps-ipv6-parse-err":"0","init-cft-del-cb-reg-failed":"0","utd-appnav-encaps-conn-est-err":"0","utd-drop-appnav-divert":"0","utd-drop-no-uidb":"0","pkt-skip-inspected":"4516","utd-appnav-decaps-unsupported-tlv":"0","utd-drop-appnav-encaps-no-classified":"0","pkt-fo-free-err":"0","utd-drop-appnav-unhealthy":"0","utd-drop-appnav-encaps-first-pkt-fail":"0","utd-reinject-no-ctx":"0","pkt-skip-no-ctx":"0","pkt-skip-inspected-no-divert":"0","utd-flow-notify-offload":"0","utd-appnav-decaps-not-icmp-err":"0","utd-drop-no-fib":"0","utd-pkts-dropped":"0","utd-pkt-entry-sp":"0","utd-drop-appnav-decaps-no-flow-tuple":"0","context-id":"0","utd-df-whitelisted-flows":"0","utd-drop-no-divert-intf":"0","utd-appnav-redirect":"0","pkt-skip-mpls-non-ip":"0","utd-appnav-decaps-not-icmp-v6-err":"0","utd-drop-no-oce-chain":"0","pkt-skip-l2-glean-adj":"0","utd-appnav-decaps-icmp-v6-unsup-proto":"0","utd-pm-icmpconns":"0","utd-appnav-reinject":"0","cft-flow-responder-seen":"0","utd-drop-appnav-decaps-conn-est":"0","utd-drop-no-egress-intf":"0","utd-appnav-decaps-del-req":"0","utd-appnav-unhealthy":"0","utd-drop-appnav-encaps-no-mem":"0","pkt-fo-alloc":"0","utd-drop-ips":"0","pkt-fo-free":"0","init-vfr-reg-failed":"0","utd-packets-diverted":"0","utd-drop-appnav-decaps-delete":"0","utd-drop-ipv4-frag":"0","utd-drop-appnav-decaps-pass-err":"0","utd-drop-sn-request":"0","utd-appnav-encaps-vrf-err":"0","utd-drop-reinject":"0","utd-pkts-skipped":"0","utd-packets-failed-divert":"0","utd-appnav-decaps-no-conn-tlv-flow":"0","vdevice-dataKey":"172.16.255.15-0","pkt-skip-invalid-ouidb":"0","utd-appnav-decaps-del-resource":"0","utd-appnav-decaps-del-idle":"0"},{"cft-ager-del-fo":"0","utd-appnav-decaps-icmp-no-payload-err":"0","utd-drop-cft-lookup-flow":"0","utd-pkts-enter-divert":"0","utd-appnav-encaps-debug-err":"0","utd-appnav-decaps-ip-unsup-ver":"0","cft-ager-del-fo-failed":"0","utd-flow-bypass":"0","utd-packets-reinjected":"0","utd-sn-drop":"0","utd-drop-cft-get-fo":"0","utd-appnav-decaps-icmp-v6-tcp-err":"0","utd-df-blacklist-match":"0","utd-drop-appnav-decaps-class-event-err":"0","pkt-skip-invalid-iuidb":"0","pkt-skip-for-us":"0","utd-appnav-decaps-icmp-no-inner-flow":"0","utd-appnav-encap-fail":"0","utd-appnav-encaps-fail":"0","pkt-skip-unsupport-prot":"0","utd-appnav-decaps-icmp-udp-err":"0","utd-drop-msg-logged":"0","utd-appnav-decaps-no-fo":"0","utd-drop-bad-ip-ver":"0","utd-drop-cft-alloc-fo":"0","utd-drop-nat64-int-lookup-fail":"0","utd-drop-appnav-encaps-debug":"0","pkt-no-inspect-divert-intf":"0","utd-drop-divert-down":"0","pkt-policy-inspected":"0","min-utd-drop-cause":"0","pkt-nat-dropped-pkt":"0","utd-appnav-decaps-icmp-tcp-err":"0","utd-df-gray-flows":"0","vdevice-name":"172.16.255.15","utd-drop-ipv6-frag":"0","init-cft-inst-get-failed":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-decaps-del-term":"0","pkt-skip-new-pkt":"0","init-vfr-unreg-failed":"0","utd-drop-appnav-encaps-vrf":"0","utd-appnav-decaps-tlv-len-err":"0","utd-appnav-decaps-icmp-no-inner-fo":"0","utd-appnav-decaps-icmp-v6-udp-err":"0","utd-appnav-redirect-fail":"0","utd-drop-cft-attach-fo":"0","utd-appnav-decaps-not-icmp-v6":"0","utd-appnav-decaps-icmp-v6-no-payload-err":"0","utd-pm-udpconns":"0","flow-setup-failed":"0","utd-df-whitelist-match":"0","utd-drop-appnav-encaps-service-add":"0","vdevice-host-name":"vm5","utd-drop-appnav-encaps-not-enuf":"0","utd-appnav-decaps-del-unknown":"0","utd-drop-cft-no-fo":"0","utd-drop-appnav-encaps-conn-handle-err":"0","skp-no-divert-needed":"0","utd-drop-was-vfr":"0","lastupdated":1659514165829,"utd-df-blacklisted-flows":"0","utd-appnav-decaps":"0","utd-appnav-decaps-icmp-unsup-proto":"0","utd-drop-appnav-encaps-no-fo":"0","utd-appnav-encaps":"0","utd-active-conns":"0","utd-appnav-decaps-no-flow":"0","utd-bypass-drop":"0","utd-appnav-decaps-ipv6-parse-err":"0","init-cft-del-cb-reg-failed":"0","utd-appnav-encaps-conn-est-err":"0","utd-drop-appnav-divert":"0","utd-drop-no-uidb":"0","pkt-skip-inspected":"0","utd-appnav-decaps-unsupported-tlv":"0","utd-drop-appnav-encaps-no-classified":"0","pkt-fo-free-err":"0","utd-drop-appnav-unhealthy":"0","utd-drop-appnav-encaps-first-pkt-fail":"0","utd-reinject-no-ctx":"0","pkt-skip-no-ctx":"0","pkt-skip-inspected-no-divert":"0","utd-flow-notify-offload":"0","utd-appnav-decaps-not-icmp-err":"0","utd-drop-no-fib":"0","utd-pkts-dropped":"0","utd-pkt-entry-sp":"0","utd-drop-appnav-decaps-no-flow-tuple":"0","context-id":"3","utd-df-whitelisted-flows":"0","utd-drop-no-divert-intf":"0","utd-appnav-redirect":"0","pkt-skip-mpls-non-ip":"0","utd-appnav-decaps-not-icmp-v6-err":"0","utd-drop-no-oce-chain":"0","pkt-skip-l2-glean-adj":"0","utd-appnav-decaps-icmp-v6-unsup-proto":"0","utd-pm-icmpconns":"0","utd-appnav-reinject":"0","cft-flow-responder-seen":"0","utd-drop-appnav-decaps-conn-est":"0","utd-drop-no-egress-intf":"0","utd-appnav-decaps-del-req":"0","utd-appnav-unhealthy":"0","utd-drop-appnav-encaps-no-mem":"0","pkt-fo-alloc":"0","utd-drop-ips":"0","pkt-fo-free":"0","init-vfr-reg-failed":"0","utd-packets-diverted":"0","utd-drop-appnav-decaps-delete":"0","utd-drop-ipv4-frag":"0","utd-drop-appnav-decaps-pass-err":"0","utd-drop-sn-request":"0","utd-appnav-encaps-vrf-err":"0","utd-drop-reinject":"0","utd-pkts-skipped":"0","utd-packets-failed-divert":"0","utd-appnav-decaps-no-conn-tlv-flow":"0","vdevice-dataKey":"172.16.255.15-3","pkt-skip-invalid-ouidb":"0","utd-appnav-decaps-del-resource":"0","utd-appnav-decaps-del-idle":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/dataplane-stats-summary":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get data plane stats summary","operationId":"getUTDDataplaneStatsSummary","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD data plane stats summary":{"description":"UTD data plane stats summary","value":{"data":[{"utd-active-conns":"0","vdevice-name":"172.16.255.15","utd-drop-sn-request":"0","utd-pm-udpconns":"0","utd-pkts-dropped":"0","context-id":"0","utd-pkts-skipped":"0","vdevice-host-name":"vm5","utd-packets-reinjected":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-unhealthy":"0","vdevice-dataKey":"172.16.255.15-0","utd-pm-icmpconns":"0","lastupdated":1659514169760,"utd-packets-diverted":"0","utd-flow-notify-offload":"0"},{"utd-active-conns":"0","vdevice-name":"172.16.255.15","utd-drop-sn-request":"0","utd-pm-udpconns":"0","utd-pkts-dropped":"0","context-id":"3","utd-pkts-skipped":"0","vdevice-host-name":"vm5","utd-packets-reinjected":"0","utd-pm-tcpconns":"0","utd-pkts-enter-policy":"0","utd-appnav-unhealthy":"0","vdevice-dataKey":"172.16.255.15-3","utd-pm-icmpconns":"0","lastupdated":1659514169760,"utd-packets-diverted":"0","utd-flow-notify-offload":"0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/engine-instance-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD engine instance status from device (Real Time)","operationId":"getUTDEngineInstanceStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD engine instance status":{"description":"UTD engine instance status","value":{"data":[{"utd-engine-instance-status-running":"true","vdevice-dataKey":"172.16.255.15-1","vdevice-name":"172.16.255.15","utd-engine-instance-status-id":"1","utd-engine-instance-status-status":"utd-oper-status-green","lastupdated":1659499440216,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/engine-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD engine status from device (Real Time)","operationId":"getUTDEngineStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD engine status":{"description":"UTD engine status","value":{"data":[{"vdevice-dataKey":"172.16.255.15","utd-engine-status-version":"1.0.6_SV2.9.18.1_XE17.9","vdevice-name":"172.16.255.15","utd-engine-status-memory-status":"utd-oper-status-green","lastupdated":1659514314427,"utd-engine-status-status":"utd-oper-status-green","utd-engine-status-memory-usage":"8.9","vdevice-host-name":"vm5","utd-engine-status-profile":"Cloud-Low"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/file-analysis-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD file analysis status from device (Real Time)","operationId":"getUTDFileAnalysisStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD file analysis status":{"description":"UTD file analysis status","value":{"data":[{"utd-file-analysis-status-status":"tg-client-stat-unknown","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","lastupdated":1645768248935,"utd-file-analysis-status-backoff-interval":"0","vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/file-reputation-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD file reputation status from device (Real Time)","operationId":"getUTDFileReputationStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD file reputation status":{"description":"UTD file reputation status","value":{"data":[{"vdevice-dataKey":"169.254.10.12","utd-file-reputation-status-status":"utd-file-repu-stat-process-unknown","vdevice-name":"169.254.10.12","lastupdated":1645773049060,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/ips-update-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD IPS update status from device (Real Time)","operationId":"getUTDIpsUpdateStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD IPS update status":{"description":"UTD IPS update status","value":{"data":[{"ips-update-status-last-update-time":"1970-01-01T00:00:00+00:00","vdevice-dataKey":"172.16.255.15","vdevice-name":"172.16.255.15","lastupdated":1659499361542,"ips-update-status-last-update-status":"utd-update-status-unknown","vdevice-host-name":"vm5","ips-update-status-last-successful-update-time":"1970-01-01T00:00:00+00:00"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/signature/version/details":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD Signature version information from Device","operationId":"getSignatureVersionInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD Signature version":{"description":"UTD Signature version","value":{"data":[{"last-updated":"-","ips-version":"29.0.c"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/urlf-con-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD URLF Connection status from device (Real Time)","operationId":"getUTDUrlfConnectionStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD URLF connection status":{"description":"UTD URLF connection status","value":{"data":[{"vdevice-dataKey":"172.16.255.15","vdevice-name":"172.16.255.15","lastupdated":1659499167268,"vdevice-host-name":"vm5","last-attempt-time":"1970-01-01T00:00:00+00:00","status":"utd-con-unknown"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/utd/urlf-update-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD URLF update status from device (Real Time)","operationId":"getUTDUrlfUpdateStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD URLF update status":{"description":"UTD URLF update status","value":{"data":[{"urlf-update-status-last-successful-update-time":"1970-01-01T00:00:00+00:00","vdevice-dataKey":"null","urlf-update-status-last-update-status":"utd-update-status-unknown","vdevice-name":"172.16.255.15","urlf-update-status-last-update-time":"1970-01-01T00:00:00+00:00","lastupdated":1659499288353,"vdevice-host-name":"vm5"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/utd/version-status":{"get":{"tags":["Real-Time Monitoring - UTD"],"description":"Get UTD version status from device (Real Time)","operationId":"getUTDVersionStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UTD version status":{"description":"UTD version status","value":{"data":[{"utd-version-status-supported":"false","vdevice-dataKey":"169.254.10.12","vdevice-name":"169.254.10.12","utd-version-status-recommended-version":"1.11.1_SV2.9.18.1_XEmain","lastupdated":1645756283937,"vdevice-host-name":"vm5","utd-version-status-supported-regex":"^1\\.11\\.([0-9]+)_SV(.*)_XEmain$"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/coLineSpecificStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service line bonding stats from device","operationId":"getCoLineSpecificStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service line bonding stats":{"description":"VDSL service line bonding stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","slot-num":"0","line-num":"4","trellis-state":"ON","sra-enabled":"disabled","sra-count":"0","bit-swap-enabled":"enabled","bit-swap-count":"0","line-attenuation":"0.9dB","signal-attenuation":"1.8dB","noise-margin":"18.6dB","attainable-rate":"138139 kbits/s","actual-power":"14.1dBm","total-fecc":"302690","total-es":"295","total-ses":"161","total-loss":"14","total-uas":"87189","total-lprs":"0","total-lofs":"80","total-lols":"0","speed":"27547","sra-previous-speed":"0","previous-speed":"128857","reed-solomon-ec":"0","crc-errors":"24722","header-errors":"8","interleave":"7.00","actual-inp":"1.00","gfast-fra-count":"57","gfast-rpa-count":"45","gfast-tiga-count":"76","gfast-rtx-uc":"0","gfast-rtx-tx":"0","gfast-attainable-exp-thru":"0","gfast-error-free-thru":"0","atm-total-cells":"11338923","atm-user-cells":"0","vdsl2-la-band-d1":"0.2","vdsl2-la-band-d2":"0.9","vdsl2-la-band-d3":"1.7","vdsl2-sa-band-d1":"0.2","vdsl2-sa-band-d2":"0.9","vdsl2-sa-band-d3":"1.7","vdsl2-snr-band-d1":"27.7","vdsl2-snr-band-d2":"16.9","vdsl2-snr-band-d3":"10.9","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/coStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get CO stats from device","operationId":"getCoStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CO stats":{"description":"CO stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","chip-vendor":"BDCM","line-attenuation":"0.9dB","noise-margin":"18.6dB","attainable-rate":"138139kbits/s","actual-power":"14.1dBm","speed":"128857","slot-num":"0","subslot-num":"0","modem-serial":"FCH2234TH6R C927-4P 15.8(3)M1","chip-vendor-specific":"0xB11F","chip-vendor-country":"0xB500","modem-vendor-id":"CSCO","modem-vendor-specific":"0x4602","modem-vendor-country":"0xB500","modem-version":"15.8(3)M1","lastupdated":1642581869106,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/cpeLineSpecificStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service CPE line specific stats from device","operationId":"getCpeLineSpecificStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service CPE line specific stats":{"description":"VDSL service CPE line specific stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","slot-num":"0","line-num":"4","trellis-state":"ON","sra-enabled":"disabled","sra-count":"0","bit-swap-enabled":"enabled","bit-swap-count":"0","line-attenuation":"0.9dB","signal-attenuation":"1.8dB","noise-margin":"18.6dB","attainable-rate":"138139 kbits/s","actual-power":"14.1dBm","total-fecc":"302690","total-es":"295","total-ses":"161","total-loss":"14","total-uas":"87189","total-lprs":"0","total-lofs":"80","total-lols":"0","speed":"27547","sra-previous-speed":"0","previous-speed":"128857","reed-solomon-ec":"0","crc-errors":"24722","header-errors":"8","interleave":"7.00","actual-inp":"1.00","gfast-fra-count":"57","gfast-rpa-count":"45","gfast-tiga-count":"76","gfast-rtx-uc":"0","gfast-rtx-tx":"0","gfast-attainable-exp-thru":"0","gfast-error-free-thru":"0","atm-total-cells":"11338923","atm-user-cells":"0","vdsl2-la-band-d1":"0.2","vdsl2-la-band-d2":"0.9","vdsl2-la-band-d3":"1.7","vdsl2-sa-band-d1":"0.2","vdsl2-sa-band-d2":"0.9","vdsl2-sa-band-d3":"1.7","vdsl2-snr-band-d1":"27.7","vdsl2-snr-band-d2":"16.9","vdsl2-snr-band-d3":"10.9","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/cpeStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get CPE stats from device","operationId":"getCpeStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CPE stats":{"description":"CPE stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","chip-vendor":"BDCM","line-attenuation":"0.9dB","noise-margin":"18.6dB","attainable-rate":"138139kbits/s","actual-power":"14.1dBm","speed":"128857","slot-num":"0","subslot-num":"0","modem-serial":"","chip-vendor-specific":"FCH2234TH6R C927-4P 15.8(3)M1","chip-vendor-country":"0xB500","modem-vendor-id":"CSCO","modem-vendor-specific":"0x4602","modem-vendor-country":"0xB500","modem-version":"15.8(3)M1","lastupdated":1642581869106,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/lineBondingStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service line bonding stats from device","operationId":"getLineBondingStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service line bonding stats":{"description":"VDSL service line bonding stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","slot-num":"0","ports-supported":"0","port-0-link-status":"up","port-1-link-status":"down","aggregate-us-rate":"87957 kbits/s","aggregate-ds-rate":"138139 kbits/s","lastupdated":0,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/lineSpecificStats":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL service line specific stats from device","operationId":"getLineSpecificStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL service line specific stats":{"description":"VDSL service line specific stats","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vdevice-dataKey":"172.16.255.15","slot-num":"0","line-number":"4","modem-status":"TC Sync (Showtime!)","trained-mode":"G.992.5 (ADSL2+) Annex A","profile-30a-enabled":"enabled","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vdslService/vdslInfo":{"get":{"tags":["Real-Time Monitoring - VDSL Service"],"description":"Get VDSL info from device","operationId":"getVdslInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VDSL info":{"description":"VDSL info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","state":"UP","mode":"AUTO","modem-status":"TC Sync (Showtime!)","trained-mode":"G.993.2 (VDSL2) Profile 17a","firmware-version":"4.14L.04","phy-version":"A2pv6F039x8.d26d","slot-num":"0","subslot-num":"0","dsl-config-mode":"AUTO","delt-configuration-enabled":"disabled","delt-state":"not running","failed-full-inits":"15","short-inits":"8","failed-short-inits":"7","modem-phy-source":"embedded","training-log-state":"Stopped","training-log-filename":"flash:vdsllog.bin","lastupdated":1642581869106,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/vedgeinventory/detail":{"get":{"tags":["Monitoring - Device Details"],"description":"Get detailed vEdge inventory","operationId":"getVedgeInventory","parameters":[{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VedgeInventoryData"},"examples":{"vEdge Inventory":{"description":"vEdge Inventory","value":[{"site-id":"400","serialNumber":"12346576","validity":"valid","host-name":"vm4","deviceType":"vedge","local-system-ip":"172.16.255.14","chasisNumber":"59414e3c-24cd-44de-8072-261224224c25","system-ip":"172.16.255.14"},{"site-id":"100","serialNumber":"12346568","validity":"valid","host-name":"vm11","deviceType":"vedge","local-system-ip":"172.16.255.21","chasisNumber":"63e8518c-e76f-4d5f-a4c7-28ffb669526b","system-ip":"172.16.255.21"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/vedgeinventory/summary":{"get":{"tags":["Monitoring - Device Details"],"description":"Get vEdge inventory","operationId":"getVedgeInventorySummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vEdge inventory":{"description":"vEdge inventory","value":{"header":{"generatedOn":1635390164998,"title":"WAN Edge Inventory","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-vedgeInventory"},"columns":[{"title":"Inventory List","property":"list","dataType":"string"}],"fields":[{"property":"list","dataType":"string"}]},"data":[{"name":"Total","list":"Total","value":0,"detailsURL":"/dataservice/device/vedgeinventory/detail"},{"name":"Authorized","list":"Authorized","detailsURL":"/dataservice/device/vedgeinventory/detail?status=authorized","value":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/virtualApplication/te":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get ThousandEyes app list from device","operationId":"createTeList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Te apps list":{"description":"Te apps list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","version":"1.0.16_SV2.9.16.1_XE17.3","active":"true","previous":"true","timestamp":"2022-09-01T13:29:43-00:00","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/virtualApplication/utd":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get Utd apps list from device","operationId":"createUtdList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Utd apps list":{"description":"Utd apps list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","version":"1.0.16_SV2.9.16.1_XE17.3","active":"true","previous":"true","timestamp":"2022-09-01T13:29:43-00:00","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/virtualApplication/waas":{"get":{"tags":["Real-Time Monitoring - NTP"],"description":"Get Waas apps list from device","operationId":"createWaasList","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Waas apps list":{"description":"Waas apps list","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","version":"1.0.16_SV2.9.16.1_XE17.3","active":"true","previous":"true","timestamp":"2022-09-01T13:29:43-00:00","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/vm/nics":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get vbranch vm lifecycle state (NIC)","operationId":"getVbranchVMLifecycleNics","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vBranch VM lifecycle state (NIC)":{"description":"vBranch VM lifecycle state (NIC)","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"int-mgmt-net-subnet","vnic-id":"1","network":"int-mgmt-net","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vm/notifications":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get CloudDock vm lifecycle state","operationId":"getCloudDockVMLifecycleNics","parameters":[{"name":"userGroup","in":"query","description":"userGroup Name","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudDock VM lifecycle state ":{"description":"CloudDock VM lifecycle state ","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","depname":"SystemAdminTena_isrv1_0_72619ffd-df8e-4c32-b24a-3d7b03a31303","eventTime":"600","hostname":"nfvis","type":"local","vmid":"1","vmName":"ISR","status_message":"active","status_code":"200","user-group":"router1","category":"Sample_Category_0001","vdevice-dataKey":"172.16.255.15","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vm/oper/state":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get vbranch vm lifecycle state","operationId":"getVbranchVMLifecycle","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vBranch VM lifecycle state":{"description":"vBranch VM lifecycle state","value":{"data":[{"vdevice-dataKey":"172.16.255.15","vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","name":"int-mgmt-net-subnet","state":"Active","lastupdated":1642581869106,"vcpus":"2","memory-mb":"4096","color":"default","root-disk-mb":"8192"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vm/state":{"get":{"tags":["Real-Time Monitoring - VM"],"description":"Get vm lifecycle state","operationId":"getVMLifeCycleState","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VM lifecycle state":{"description":"VM lifecycle state","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","deployment_name":"dep1","deployment_id":"SystemAdminTenantIdisrv1","name":"router1","state":"Active"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write"}},"/device/vmanage":{"get":{"tags":["Monitoring - Device Details"],"description":"Get vManage system IP","operationId":"getVManageSystemIP","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceVmanageResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/device/voice/dspActive":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm Active DSP info from device","operationId":"getDspActive","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm Active DSP info":{"description":"DSPFarm Active DSP info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","dsp-num":2,"dsp-status":"up","rsc-id":1,"bridge-id":9,"pkts-txed":228,"pkts-rxed":119,"lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/phoneInfo":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get phone registration info from device","operationId":"getPhoneInfo","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VOIP call info":{"description":"VOIP call info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","pool-tag":"1","id-network":"10.1.10.217","reg-state":"yes","dialpeer-tag":"100","address":"10.64.86.70","dir-number":"5550111","lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/profiles":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm Profiles info from device","operationId":"getDSPFarmProfiles","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm Profiles info":{"description":"DSPFarm Profiles info","value":{"data":[{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-mtp","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"1","rsc-status":"rsc-group-state-none","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-9","rsc-provider":"rsc-prov-none","profile-id":"9","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"},{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-mtp","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"2","rsc-status":"rsc-group-state-none","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-52","rsc-provider":"rsc-prov-none","profile-id":"52","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"},{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-mtp","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"3","rsc-status":"rsc-group-state-none","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-183","rsc-provider":"rsc-prov-none","profile-id":"183","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"},{"prof-oper-state":"prof-oper-state-active-in-prog","service-id":"profile-transcode","app-id":"app-id-sccp","vdevice-name":"32.32.32.17","prof-admin-state":"prof-admin-state-up","vdevice-host-name":"isr4331-prakuma3-2","resource-id":"4","rsc-status":"rsc-group-state-up","app-assoc-status":"app-assoc-active-in-prog","vdevice-dataKey":"32.32.32.17-711","rsc-provider":"rsc-prov-flex-dsprm","profile-id":"711","lastupdated":1660244459596,"secure-mode":"srvc-mode-non-secure"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/sccpCcmGroups":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm SCCP CCM Groups info from device","operationId":"getSccpCcmGroups","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm SCCP CCM Groups info":{"description":"DSPFarm SCCP CCM Groups info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","ccm-group-id":5,"description":"boston office","switchover-method":"GRACEFUL","switchback-method":"GRACEFUL_GUARD","ccm-id":1,"ccm-priority":1,"profile-id":6,"reg-name":"MTP123456789988","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/sccpConnections":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get DSPFarm SCCP Connections info from device","operationId":"getSccpConnections","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSPFarm SCCP Connections info":{"description":"DSPFarm SCCP Connections info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","conn-id":16777409,"sess-id":16777222,"stype":"secure-xcode","mode":"sendrecv","codec":"g729b","rmt-ipaddr":"10.3.56.120","rmt-port":"16772","src-port":"19354","dtmf-method":"enabled","lastupdated":1642581869106}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/voiceCalls":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get voice call info from device","operationId":"getVoiceCalls","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Voice call info":{"description":"Voice call info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","key-id":"0312341111","call-id":"24","voice-port-id":"1/015","codec-type":"g729r8","vad":"disabled","dsp-id":"010","dsp-type":"C549","dsp-abort-packet-cnt":0,"dsp-tx-packet-cnt":67400,"dsp-rx-packet-cnt":67400,"lastupdated":1660244459596}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voice/voipCalls":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Get VOIP call info from device","operationId":"getVoipCalls","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VOIP call info":{"description":"VOIP call info","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","call-index":3917844,"call-setuptime":126640,"call-id":5554071,"codec":"g711ulaw","remote-ip-address":"10.128.136.58","remote-media-port":17602,"transmit-packets":2246,"receive-packets":2246,"call-duration":"00:00:50","lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voiceisdninfo/isdnstatus":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Retrieve Voice ISDN Status from device","operationId":"getT1e1IsdnStatus","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device voice ISDN status":{"description":"Device voice ISDN status","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","key-id":0,"intf-name":"Serial0:23","switch-type":"primary-5ess","l1-status":"ACTIVE","l2-status":"MULTIPLE_FRAME_ESTABLISHED","num-active-calls":1,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voicet1e1controllerinfo/current15minstats":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Retrieve T1E1 controller last 15 min stats from device (Real Time)","operationId":"getControllerT1e1InfoCurrent15MinStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"T1E1 controller status":{"description":"T1E1 controller status","value":{"data":[{"vdevice-name":"32.32.32.17","vdevice-host-name":"vm5","slot-num":"6","subslot-num":"3","port-num":"0","state":"up","type":"t1","clocking":"internal","vdevice-dataKey":"32.32.32.17-711","lcvs":136,"pcvs":63,"csss":0,"sefss":6,"less":4,"dms":0,"ess":7,"bess":1,"sess":6,"uass":458,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/voicet1e1controllerinfo/totalstats":{"get":{"tags":["Real-Time Monitoring - Voice"],"description":"Retrieve T1E1 controller total stats from device (Real Time)","operationId":"getControllerT1e1InfoTotalStats","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"T1E1 controller status":{"description":"T1E1 controller status","value":{"data":[{"vdevice-name":"32.32.32.17","vdevice-host-name":"vm5","slot-num":"6","subslot-num":"3","port-num":"0","state":"up","type":"t1","clocking":"internal","vdevice-dataKey":"32.32.32.17-711","lcvs":136,"pcvs":63,"csss":0,"sefss":6,"less":4,"dms":0,"ess":7,"bess":1,"sess":6,"uass":458,"lastupdated":1660727547133}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/device/vpn":{"get":{"tags":["Real-Time Monitoring - VPN"],"description":"Get VPN instance list from device (Real Time)","operationId":"getVPNInstances","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPN instance list ":{"description":"VPN instance list ","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","vpn-id":"10","if-name":"ge0/1","ip-address":"10.0.0.2 255.255.255.0","color":"mpls","shutdown":"no shutdown","lastupdated":1660890739250,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/vrrp":{"get":{"tags":["Real-Time Monitoring - VRRP"],"description":"Get VRRP interface list from device","operationId":"getVRRPInterface","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VRRP interface":{"description":"VRRP interface","value":{"data":[{"omp-state":"up","group-id":"123","if-name":"ge0/0","virtual-mac":"00:00:5e:00:01:7b","lastupdated":1650878690993,"vpn-id":"10","vdevice-dataKey":"169.254.10.9-10-ge0/0-123","advertisement-timer":"1","last-state-change-time":"0000-00-00T00:00:00+00:00","vdevice-host-name":"vm2","vrrp-state":"init","vdevice-name":"169.254.10.9","priority":"101"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Interface-read,Interface-write"}},"/device/wireless/client":{"get":{"tags":["Real-Time Monitoring - Wireless"],"description":"Get wireless clients from device","operationId":"getWirelessClients","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wireless client":{"description":"Wireless client","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","wlan-id":"1","mac-address":"24:77:03:89:9b:f8","ssid":"rf4k3ap","band":"band-24ghz","status":"0","ip-address":"192.168.1.1","device-type":"Android","vdevice-dataKey":"172.16.255.15","rssi":-51,"lastupdated":1660894960587}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/wireless/radio":{"get":{"tags":["Real-Time Monitoring - Wireless"],"description":"Get wireless Radios from device","operationId":"getWirelessRadios","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wireless Radio":{"description":"Wireless Radio","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","band":"band-24ghz","channel":11,"channel-bandwidth":"chan-bw-160mhz","client-count":110,"lastupdated":1660898493410,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/wireless/ssid":{"get":{"tags":["Real-Time Monitoring - Wireless"],"description":"Get wireless SSID from device","operationId":"getWirelessSsid","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wireless SSID":{"description":"Wireless SSID","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","wlan-id":"1","ssid":"rf4k3ap","vlan-id":1,"band":"band-24ghz","admin-up":"true","oper-up":"true","client-count":110,"max-client-count":200,"lastupdated":1660910032581,"vdevice-dataKey":"172.16.255.15"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write,System-read,System-write"}},"/device/wlan/clients":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN client from device","operationId":"getWLANClients","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN client":{"description":"WLAN client","value":{"data":[{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","client-id":"0","mac":"50:50:50:50:50:50","mode":"802.11ac","band":"5 GHz","channel":"36","channel-bandwidth":"80","data-security":"none","rx-rate":"175","rssi":"11","assoc-time":"00:11:43","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9"},{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","client-id":"1","mac":"50:50:50:50:50:53","mode":"802.11ac","band":"5 GHz","channel":"36","channel-bandwidth":"80","data-security":"none","rx-rate":"175","rssi":"11","assoc-time":"00:11:43","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9"},{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","client-id":"2","mac":"50:50:50:50:50:56","mode":"802.11ac","band":"5 GHz","channel":"36","channel-bandwidth":"80","data-security":"none","rx-rate":"175","rssi":"11","assoc-time":"00:11:43","lastupdated":1658194642863,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/wlan/interfaces":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN interface from device","operationId":"getWLANInterfaces","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN interface":{"description":"WLAN interface","value":{"data":[{"vdevice-name":"vm2","vdevice-host-name":"169.254.10.9","vap":"vap0","ssid":"tb31_pm6_5ghz_vap0","bssid":"80:b7:09:08:b7:6a","data-security":"wpa/wpa2-enterprise","mgmt-security":"optional","band":"5 GHz","mode":"802.11ac","description":"-","bit-rate":"1300","tx-power":"25","admin-status":"Up","oper-status":"Up","max-clients":"50","num-clients":"8","lastupdated":0,"vdevice-dataKey":"169.254.10.9"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/wlan/radios":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN Radios from device","operationId":"getWLANRadios","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN Radios":{"description":"WLAN Radios","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vdevice-dataKey":"169.254.10.9","radio-name":"wifi0","mode":"802.11ac","band":"5 GHz","mac":"80:b7:09:08:b7:6a","country":"United States","channel":"36","channel-bandwidth":"80","frequency":"5180","guard-interval":"400","vaps":"4","lastupdated":1658194642863}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device/wlan/radius":{"get":{"tags":["Real-Time Monitoring - WLAN"],"description":"Get WLAN RADIUS authentication from device","operationId":"getWLANRadius","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WLAN RADIUS authentication":{"description":"WLAN RADIUS authentication","value":{"data":[{"vdevice-name":"169.254.10.9","vdevice-host-name":"vm2","vap-ifname":"vap1","preference":"-","ip-address":"10.20.24.15","vpn-id":"1","priority":"0","source-interface":"-","source-address":"-","tag":"tag_dummy1","vdevice-dataKey":"169.254.10.9","auth-port":"1812","auth-active":"true","auth-rtt":"0","auth-requests":"0","auth-retrans":"0","auth-accepts":"0","auth-rejects":"0","auth-challenges":"0","auth-mal-resp":"0","auth-bad-auth":"0","auth-pend-reqs":"0","auth-timeouts":"0","auth-unk-types":"0","auth-pkts-drop":"0","acct-port":"0","acct-active":"false","acct-rtt":"0","acct-requests":"0","acct-retrans":"0","acct-responses":"0","acct-mal-resp":"0","acct-bad-auth":"0","acct-pend-reqs":"0","acct-timeouts":"0","acct-unk-types":"0","acct-pkts-drop":"0","lastupdated":1658194642863}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write"}},"/device_authorization/{regionBaseUri}/{clientId}":{"post":{"tags":["Monitoring - SecureX Integration"],"description":"User authorization for Cisco vManage SecureX integration","operationId":"deviceAuthorization","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Codes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/activate":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Activate cluster to start working as primary","operationId":"activate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/clusterInfo":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery cluster info","operationId":"getClusterInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR cluster info":{"description":"DR cluster info","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/dbrestorestatus":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Config-db restore status","operationId":"getConfigDBRestoreStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Config-db Restore Status":{"description":"Config-db Restore Status","value":{"currentState":"DOWNLOADING"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/deleteLocalDataCenter":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Delete local data center","operationId":"deleteLocalDC","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request status":{"description":"Request status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/deleteRemoteDataCenter":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Delete data center","operationId":"deleteDC","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request status":{"description":"Request status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/deregister":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Delete disaster recovery","operationId":"delete","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/details":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery details","operationId":"getDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR details":{"description":"DR details","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/drstatus":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Disaster recovery status","operationId":"getDisasterRecoveryStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"DR status":{"description":"DR status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/history":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery switchover history","operationId":"getHistory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR switchover history":{"description":"DR switchover history","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/localLatestHistory":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery local switchover history","operationId":"getLocalHistory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR local switchover history":{"description":"DR local switchover history","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/localdc":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get local data center details","operationId":"getLocalDataCenterState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Local datacenters detail":{"description":"Local datacenters detail","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/password":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update data centers and vBonds passwords for disaster recovery","operationId":"update","requestBody":{"description":"Datacenter/vBond password update request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter/vBond password update request":{"description":"Datacenter/vBond password update request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR setting updated":{"description":"DR setting updated","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pause":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR","operationId":"pauseDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pauseLocalArbitrator":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR for Local Arbitrator","operationId":"pauseLocalArbitrator","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pauseLocalDC":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR for Local datacenter","operationId":"pauseLocalDCForDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/pauseLocalReplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR replication for Local datacenter","operationId":"pauseLocalDCReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/disasterrecovery/pausereplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Pause DR data replication","operationId":"disasterRecoveryPauseReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/register":{"put":{"tags":["Configuration - Disaster Recovery"],"description":"Update data centers for disaster recovery","operationId":"update_1","requestBody":{"description":"Datacenter registration request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter registration request":{"description":"Datacenter registration request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR setting updated":{"description":"DR setting updated","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"},"post":{"tags":["Configuration - Disaster Recovery"],"description":"Register data centers for disaster recovery","operationId":"register","requestBody":{"description":"Datacenter registration request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter registration request":{"description":"Datacenter registration request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/remoteDcState":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Gets remote data center member state","operationId":"getRemoteDCMembersState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Remote DC member details":{"description":"Remote DC member details","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/remotedc":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get remote data center details","operationId":"getRemoteDataCenterState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Remote datacenters detail":{"description":"Remote datacenters detail","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/remotedc/swversion":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get remote data center vManage version","operationId":"getRemoteDataCenterVersion","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage version":{"description":"vManage version","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/disasterrecovery/schedule":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery local replication schedule","operationId":"getDisasterRecoveryLocalReplicationSchedule","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR replication schedule":{"description":"DR replication schedule","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write"}},"/disasterrecovery/status":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Get disaster recovery status","operationId":"getdrStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR status":{"description":"DR status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-read,Disaster Recovery-write,Template Deploy-read,Template Deploy-write"}},"/disasterrecovery/unpause":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR","operationId":"unpauseDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/unpauseLocalArbitrator":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR for Local Arbitrator","operationId":"unpauseLocalArbitrator","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/unpauseLocalDC":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR for Local datacenter","operationId":"unpauseLocalDCForDR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/unpauseLocalReplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Unpause DR replication for local datacenter","operationId":"unpauseLocalDCReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/disasterrecovery/unpausereplication":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Un-Pause DR data replication","operationId":"disasterRecoveryUnPauseReplication","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request Status":{"description":"Request Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Disaster Recovery-write"}},"/disasterrecovery/updateDRConfigOnArbitrator":{"post":{"tags":["Configuration - Disaster Recovery"],"description":"Update arbitrator with primary and secondary states cluster","operationId":"updateDrState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Request status":{"description":"Request status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/disasterrecovery/usernames":{"get":{"tags":["Configuration - Disaster Recovery"],"description":"Fetch data centers and vBonds usernames for disaster recovery","operationId":"get","requestBody":{"description":"Datacenter/vBond password update request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Datacenter/vBond password update request":{"description":"Datacenter/vBond password update request","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DR setting updated":{"description":"DR setting updated","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Disaster Recovery-write"}},"/entityownership/list":{"get":{"tags":["System - Cloud Service"],"summary":"List all entity ownership info","description":"List all entity ownership info","operationId":"listEntityOwnershipInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityOwnershipInfo"},"examples":{"Entity Ownership List Response":{"description":"Entity Ownership List Response","$ref":"#/components/examples/entity_ownership_list"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/entityownership/tree":{"get":{"tags":["System - Cloud Service"],"description":"Entity ownership info grouped by buckets","operationId":"entityOwnershipInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Entity ownership":{"description":"Entity ownership","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event":{"get":{"tags":["Monitoring - Events"],"description":"Get events for given query. If query is empty then last 30 mins data will be returned.","operationId":"getEvents","parameters":[{"name":"query","in":"query","description":"Query","allowEmptyValue":true,"schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"}}},{"name":"page","in":"query","description":"Specify page number. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Specify page size. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Specify a field by which alarms need to be sorted","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Select sorting order. Use ASC for ascending and DESC for descending","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Events":{"description":"Events","$ref":"#/components/examples/event"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"},"post":{"tags":["Monitoring - Events"],"description":"Get events for given query.","operationId":"postEvents","parameters":[{"name":"page","in":"query","description":"Specify page number. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Specify page size. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Specify a field by which alarms need to be sorted","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Select sorting order. Use ASC for ascending and DESC for descending","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"requestBody":{"description":"Event query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"},"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Events":{"description":"Events","$ref":"#/components/examples/event"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/event/aggregation":{"get":{"tags":["Monitoring - Events"],"description":"Get aggregated count of events based on given query.","operationId":"getAggregationData_1","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity-3"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmAggregationResponse"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity-4"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"},"post":{"tags":["Monitoring - Events"],"description":"Get aggregated count of events based on given query.","operationId":"postAggregationData_1","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmAggregationResponse"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","$ref":"#/components/examples/aggregation_by_severity-4"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"}},"/event/component/keyvalue":{"get":{"tags":["Monitoring - Events"],"description":"Get event component types.","operationId":"getComponentsAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleKeyValueMapping"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/component_keyvalue"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/event/doccount":{"get":{"tags":["Monitoring - Events"],"description":"Get the count of events as per the query passed.","operationId":"getDocCount_2","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Count":{"description":"Count","$ref":"#/components/examples/doccount-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Events"],"description":"Get the count of events as per the query passed.","operationId":"postDocCount_1","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"},"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Count":{"description":"Count","$ref":"#/components/examples/doccount-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/enable/fileprocess":{"get":{"tags":["Monitoring - Events"],"description":"Enable events from file.","operationId":"enableEventsFromFile","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSchema"},"examples":{"Enabled status":{"description":"Enabled status","$ref":"#/components/examples/enable_fileprocess"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"}},"/event/getEventsByComponent":{"get":{"tags":["Monitoring - Events"],"description":"Get event names by component.","operationId":"getEventNamesByComponent","parameters":[{"name":"query","in":"query","description":"Event component name","required":true,"schema":{"type":"string"},"examples":{"Policy":{"description":"Policy","value":"Policy"},"Nat":{"description":"Nat","value":"Nat"},"BFD":{"description":"BFD","value":"BFD"},"Nwpi":{"description":"Nwpi","value":"Nwpi"},"Security":{"description":"Security","value":"Security"},"Statistics":{"description":"Statistics","value":"Statistics"},"System":{"description":"System","value":"System"},"Control":{"description":"Control","value":"Control"},"OMP":{"description":"OMP","value":"OMP"},"VPN":{"description":"VPN","value":"VPN"},"PIM":{"description":"PIM","value":"PIM"},"App Route":{"description":"App Route","value":"App-Route"},"Software":{"description":"Software","value":"Software"},"Hardware":{"description":"Hardware","value":"Hardware"},"CloudExpress":{"description":"CloudExpress","value":"CloudExpress"},"cloudDock":{"description":"cloudDock","value":"cloudDock"},"Firmware":{"description":"Firmware","value":"Firmware"},"Bridge":{"description":"Bridge","value":"Bridge"},"OSPF":{"description":"OSPF","value":"OSPF"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentEventMapping"},"examples":{"Events":{"description":"Events","$ref":"#/components/examples/getEventsByComponent"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/event/listeners":{"get":{"tags":["Monitoring - Events"],"description":"Retrieve listener information","operationId":"getListenersInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Listeners":{"description":"Listeners","$ref":"#/components/examples/listeners"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/page":{"get":{"tags":["Monitoring - Events"],"description":"Get paginated events","operationId":"getPage_1","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"}}},{"name":"scrollId","in":"query","description":"Scroll ID","schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of alarms per page","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/page-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"},"post":{"tags":["Monitoring - Events"],"description":"Get paginated events","operationId":"postPage_1","parameters":[{"name":"scrollId","in":"query","description":"Scroll ID","schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of alarms per page","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"requestBody":{"description":"Event query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"},"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/page-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"}},"/event/query/fields":{"get":{"tags":["Monitoring - Events"],"description":"Get query fields","operationId":"getQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventQueryInputResponse"},"examples":{"Query fields":{"description":"Query fields","$ref":"#/components/examples/query_fields-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"}},"/event/query/input":{"get":{"tags":["Monitoring - Events"],"description":"Get event field details","operationId":"createEventsQueryConfig","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventQueryInputResponse"},"examples":{"Field details":{"description":"Field details","$ref":"#/components/examples/query_input-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"}},"/event/severity":{"get":{"tags":["Monitoring - Events"],"description":"Get alarms by severity","operationId":"getBySeverities","parameters":[{"name":"severity-level","in":"query","description":"Severity level","required":true,"schema":{"type":"array","items":{"type":"string"}},"examples":{"critical":{"description":"critical","value":"critical"},"major":{"description":"major","value":"major"},"minor":{"description":"minor","value":"minor"},"medium":{"description":"medium","value":"medium"}}},{"name":"deviceId","in":"query","description":"Device System IP","schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"Query","allowEmptyValue":true,"schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSeverityResponse"},"examples":{"Events":{"description":"Events","$ref":"#/components/examples/severity-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read"}},"/event/severity/summary":{"get":{"tags":["Monitoring - Events"],"description":"Get event severity histogram","operationId":"getSeverityHistogram","parameters":[{"name":"deviceId","in":"query","description":"Device system ip","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"Query","allowEmptyValue":true,"schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"Get events filter by system ip":{"description":"Get events filter by system ip","$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by site-id":{"description":"Get events filter by site-id","$ref":"#/components/examples/filter_by_sites"},"Get events filter by hours":{"description":"Get events filter by hours","$ref":"#/components/examples/filter_by_hours"},"Get events filter by severity":{"description":"Get events filter by severity","$ref":"#/components/examples/filter_by_severity-2"},"Get events filter between dates":{"description":"Get events filter between dates","$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","$ref":"#/components/examples/filter_by_type-2"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeveritySummary"},"examples":{"Severity":{"description":"Severity","$ref":"#/components/examples/severity_summary"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/event/types/keyvalue":{"get":{"tags":["Monitoring - Events"],"description":"Get event types.","operationId":"getEventTypesAsKeyValue","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleKeyValueMapping"},"examples":{"Response":{"description":"Response","$ref":"#/components/examples/types_keyvalue"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/featurecertificate/certificate":{"get":{"tags":["Configuration - Feature Certificate"],"description":"Get feature cert from cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getDeviceCertificate","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device feature cert":{"description":"Device feature cert","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"},"put":{"tags":["Configuration - Feature Certificate"],"description":"Upload feature cert for cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"installFeatureCertificate","requestBody":{"description":"Install feature cert request for cEdge","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature cert request":{"description":"Feature cert request"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/featurecertificate/devicecsr":{"get":{"tags":["Configuration - Feature Certificate"],"description":"Get CSR from cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getDeviceCsr","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device CSR":{"description":"Device CSR","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"},"put":{"tags":["Configuration - Feature Certificate"],"description":"Create CSR for cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"genDeviceCsr","requestBody":{"description":"CSR request for cEdge","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR request":{"description":"CSR request"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/featurecertificate/revoke":{"put":{"tags":["Configuration - Feature Certificate"],"description":"Revoke feature cert from cEdge device
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"revokeFeatureCertificate","requestBody":{"description":"Revoking feature cert request for cEdge","content":{"application/json":{"schema":{"type":"object"},"examples":{"Revoking feature cert request":{"description":"Revoking feature cert request"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/featurecertificate/syslogconfig":{"get":{"tags":["Configuration - Feature Certificate"],"description":"Get Feature CA state
Note: In a multitenant vManage system, this API is only available in the Provider and Provider-As-Tenant view.","operationId":"getFeatureCaState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature CA state":{"description":"Feature CA state","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/fedramp/dnssec/actions":{"get":{"tags":["Deployment Mode"],"description":"Request DNS-Sec actions","operationId":"requesDNSSecActions","parameters":[{"name":"action","in":"query","description":"DNS-Sec action","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DNS-Sec action status":{"description":"DNS-Sec action status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/fedramp/dnssec/config":{"post":{"tags":["Deployment Mode"],"description":"Configure DNS-Sec","operationId":"configureDNSSec","requestBody":{"description":"DNS sec config request","content":{"application/json":{"schema":{"type":"object"},"examples":{"DNS sec config request":{"description":"DNS sec config request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,FedRamp-write"}},"/fedramp/dnssec/status":{"get":{"tags":["Deployment Mode"],"description":"Get DNS-Sec status","operationId":"getDNSSecStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DNS-Sec status":{"description":"DNS-Sec status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/fedramp/status":{"post":{"tags":["Deployment Mode"],"description":"Set network deployment mode","operationId":"configFedrampMode","requestBody":{"description":"Network deployment mode","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network deployment mode":{"description":"Network deployment mode","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,FedRamp-write"}},"/fedramp/wazuh/actions":{"get":{"tags":["Deployment Mode"],"description":"Wazuh agent action","operationId":"requestWazuhActions","parameters":[{"name":"action","in":"query","description":"Wazhuh Action","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Wazhug agent action status":{"description":"Wazhug agent action status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/fedramp/wazuh/config":{"post":{"tags":["Deployment Mode"],"description":"Configure Wazuh agent","operationId":"configureWazuhClient","requestBody":{"description":"Wazhuh configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Wazhuh configuration request":{"description":"Wazhuh configuration request","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,FedRamp-write"}},"/fedramp/wazuh/status":{"get":{"tags":["Deployment Mode"],"description":"Get Wazuh agent status","operationId":"getWazuhAgentStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Wazhug agent status":{"description":"Wazhug agent status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,FedRamp-read"}},"/group":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve device group list","operationId":"listDeviceGroupList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/Group200"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/device":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve device groups","operationId":"listDeviceGroups","parameters":[{"name":"siteId","in":"query","description":"siteId","schema":{"type":"string"},"example":400}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GroupDevice200"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GroupDevice400"}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/devices":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve devices in group","operationId":"listGroupDevices","parameters":[{"name":"groupId","in":"query","description":"groupId","schema":{"type":"string"},"example":"none"},{"name":"ssh","in":"query","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GroupDevices200"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/map/devices":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve group devices for map","operationId":"listGroupDevicesForMap","parameters":[{"name":"groupId","in":"query","description":"groupId","schema":{"type":"string"},"example":"none"},{"name":"vpnId","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"Example":{"description":"Example","$ref":"#/components/examples/MapDevices"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/group/map/devices/links":{"get":{"tags":["Troubleshooting Tools - Device Group"],"description":"Retrieve devices in group for map","operationId":"listGroupLinksForMap","parameters":[{"name":"groupId","in":"query","description":"groupId","schema":{"type":"string"},"example":"none"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/MapDevicesLinks"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/health/devices":{"get":{"tags":["Monitoring - Health"],"description":"get the devices health properties","operationId":"getDevicesHealth","parameters":[{"name":"page","in":"query","description":"Page Number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Page Size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Sort By Property","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Sort Order","schema":{"type":"string"}},{"name":"startingDeviceId","in":"query","description":"Optional device ID to start first page","schema":{"type":"string"}},{"name":"siteId","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}},{"name":"group_id","in":"query","description":"Optional group ID to filter devices","schema":{"type":"string"}},{"name":"groupId","in":"query","description":"Optional group ID to filter devices","schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}},{"name":"reachable","in":"query","schema":{"type":"boolean"}},{"name":"controlStatus","in":"query","schema":{"type":"string"}},{"name":"personality","in":"query","schema":{"type":"string"}},{"name":"health","in":"query","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Optional site ID list to filter devices","schema":{"type":"string"}},{"name":"featureType","in":"query","schema":{"type":"string","enum":["cellular"]}},{"name":"corSaasStatus","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices health properties":{"description":"devices health properties","value":{"total_devices":3,"devices":[{"name":"vm3","personality":"vedge","uuid":"04a116f8-9a16-4bf6-9f1f-f58e2619312d","reachability":"reachable","longitude":"-122.777023","latitude":"37.666684","health":"green","qoe":10,"location":"lat: 37.666684, long: -122.777023","site_id":"3","system_ip":"169.254.10.10","device_type":"vedge","local_system_ip":"172.16.254.2","device_model":"vEdge Cloud","software_version":"20.6.0-231","cpu_load":1.32,"memory_utilization":25,"control_connections":3,"control_connections_up":3,"sdra_ipsec_anyconnect":120,"sdra_ipsec_soho":60,"sdra_ipsec_unknown":30,"sdra_sslvpn_anyconnect":0,"has_geo_data":true,"uptime_date":1629963840000,"device_groups":["No groups"],"connected_vmanages":["169.254.10.3"],"bfd_sessions_up":5,"bfd_sessions":5,"omp_peers":2,"omp_peers_up":2,"board_serial_number":"12345708","chassis_number":"04a116f8-9a16-4bf6-9f1f-f58e2619312d","vpn_ids":null}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,RBAC VPN-read,RBAC VPN-write"}},"/health/devices/overview":{"get":{"tags":["Monitoring - Health"],"description":"gets devices health overview","operationId":"getDevicesHealthOverview","parameters":[{"name":"vpn_id","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"Optional vpn ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices health overview":{"description":"devices health overview","value":{"good":3,"fair":3,"poor":0}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write,System-read"}},"/hsec/devices":{"get":{"tags":["Hsec"],"description":"Retrieve list of devices which are valid for fetch of HSEC license","operationId":"fetchDeviceDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHSECInstallDevicesPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/devices/install":{"get":{"tags":["Hsec"],"description":"Retrieve list of devices which has HSEC fetched","operationId":"InstallDeviceDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHSECInstallDevicesPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/download":{"post":{"tags":["Hsec"],"description":"Download SLAC Request file for CSSM","operationId":"downloadSlacRequestFile","requestBody":{"description":"Device List","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device":{"description":"Device","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device":{"description":"Device","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin,Software Upgrade-write"}},"/hsec/fetchaccounts":{"get":{"tags":["HSEC"],"description":"Authenticate User and Sync Licenses","operationId":"fetchSAVAAccounts","parameters":[{"name":"username","in":"query","schema":{"type":"string"}},{"name":"pwd","in":"query","schema":{"type":"string"}},{"name":"mode","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartLicensingfetchAccountsResp"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["HSEC"],"description":"Authenticate User and Sync Licenses","operationId":"fetchAccounts_1","requestBody":{"description":"Hsec License sync request payload","content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartLicensingfetchAccountsResp"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/hsec/testbedMode":{"get":{"tags":["HSEC"],"description":"Return testbed mode information staging or production","operationId":"testbedMode","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestbedMode"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/connect":{"get":{"tags":["Configuration - Ise Server"],"description":"Check if the configured ISE server is reachable","operationId":"connect_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials":{"get":{"tags":["Configuration - Ise Server"],"description":"Get Ise server credentials","operationId":"getIseServerCredentials","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IseServer"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Ise Server"],"description":"update Ise server credentials","operationId":"updateIseServerCredentials","requestBody":{"description":"Ise Server with possibly new values for properties","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IseServer"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Ise Server"],"description":"Add Ise server credentials","operationId":"addIseServerCredentials","requestBody":{"description":"Ise Server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IseServer"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/iseandpxgrid":{"delete":{"tags":["Configuration - Ise Server"],"description":"Delete PxGrid and Ise information on vManage. Also Deletes PxGrid Client on ISE","operationId":"deleteIseAndPxGridAccount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/pxgrid":{"get":{"tags":["Configuration - Ise Server"],"description":"Get PxGrid account","operationId":"getPxGridAccount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PxGridInfo"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Ise Server"],"description":"Delete PxGrid account information","operationId":"deletePxGrid","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/pxgrid/cert":{"get":{"tags":["Configuration - Ise Server"],"description":"Retrieves Pxgrid Certificate","operationId":"getPxgridCert","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Cert":{"description":"Cert","value":"-----BEGIN CERTIFICATE-----\r\nMIIF7zCCA9egAwIBAgIQZiToABE+v71LjsuIg3EjqTANBgkqhkiG9w0BAQ0FADCB\r\niTELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNh\r\nbiBKb3v/3QMfoLFz004vv7vBf4VcpQQ8Bc\r\nTATYW0iy5jt+YNgvZj2HjYiOhwpMalGqlhBJMgljgNmupReAccQyw01hbPIG9vBK\r\nxWMSk/AFVb1Ctv7Q3MUV/1mZyTM14TUZbtDd1/lxIHBR7LKhMJqcjOOcNBFlkdXO\r\n6BaP2RPL6dw2x92ddnRtzpAPfx2c1R51rELPpenX0SNLoS0=\r\n-----END CERTIFICATE-----\r\n"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/credentials/vsmart/sync":{"post":{"tags":["Configuration - Ise Server"],"description":"Send pxGrid and ISE server configuration to vSmarts","operationId":"syncVsmart","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VsmartSyncResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/pxgrid/activate":{"post":{"tags":["Configuration - Ise Server"],"description":"Activate pxGrid account","operationId":"accountActivate","requestBody":{"description":"description for pxgrid node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateBody"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/pxgrid/approve":{"put":{"tags":["Configuration - Ise Server"],"description":"Approve pxGrid account","operationId":"approve","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ise/pxgrid/create":{"post":{"tags":["Configuration - Ise Server"],"description":"Create pxGrid account","operationId":"accountCreate","requestBody":{"description":"name for pxgrid node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBody"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/jobs/batch":{"post":{"tags":["Jobs - Batch"],"description":"Batch processing multiple REST API calls","operationId":"batchExecute","requestBody":{"description":"Payload for executing multiple APIs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchFlow"},"examples":{"Batched API calls":{"description":"Batched API calls","value":"{\n \"data\": [\n {\n \"uri\": \"/dataservice/settings/configuration/proxyHttpServer\",\n \"method\": \"POST\",\n \"payload\": {\n \"proxy\": true,\n \"proxyIp\": \"64.102.255.47\",\n \"proxyPort\": \"80\",\n \"NoProxyList\": \"169.254.8.1|::1|localhost|127.0.0.1\"\n }\n },\n {\n \"uri\": \"/dataservice/settings/configuration/proxyHttpServer\",\n \"method\": \"PUT\",\n \"payload\": {\n \"proxy\": true,\n \"proxyIp\": \"64.102.255.47\",\n \"proxyPort\": \"80\",\n \"NoProxyList\": \"169.254.6.1|::1|localhost|127.0.0.1\"\n }\n }\n ],\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Batch API Response":{"description":"Batch API Response"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/localization/supportedLocales":{"get":{"tags":["Locale"],"description":"Get Supported locales","operationId":"Get Supported locales","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"locales":[{"code":"en_US","displayName":"English (US)"},{"code":"fr_CA","displayName":"French (Canadian)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/management/category":{"get":{"tags":["Management"],"description":"Get vManage resource category","operationId":"getCategory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage resource category":{"description":"vManage resource category","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/management/vManageResourceUtilization":{"get":{"tags":["Management"],"description":"Get vManage resource utilization","operationId":"getvManageResourceUtilization","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage resource utilization":{"description":"vManage resource utilization","value":{}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/attachDevices/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP attached devices","operationId":"Retrieve MDP attached devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Multidomain Policy"],"description":"Edit attached devices","operationId":"Edit attached devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"deviceList","content":{"application/json":{"schema":{"type":"object"},"examples":{"devices":{"description":"devices","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Multidomain Policy"],"description":"Share devices with MDP","operationId":"Attach devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"deviceList","content":{"application/json":{"schema":{"type":"object"},"examples":{"Devices":{"description":"Devices","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/detachDevices/{nmsId}":{"post":{"tags":["Configuration - Multidomain Policy"],"description":"Disconnect devices from mpd controller","operationId":"Detach devices","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"deviceList","content":{"application/json":{"schema":{"type":"object"},"examples":{"Onboard":{"description":"Onboard","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/devices/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP supported devices","operationId":"Retrieve MDP supported devices ","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/disconnect/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"disconnect from mpd controller","operationId":"disconnect from mdp","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"status":{"description":"status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/onboard":{"post":{"tags":["Configuration - Multidomain Policy"],"description":"Start MDP onboarding operation","operationId":"onboardMDP","requestBody":{"description":"Onboard","content":{"application/json":{"schema":{"type":"object"},"examples":{"onboarding-payload":{"description":"onboarding-payload","value":{"controllerUUID":"fc335c24-fb30-46bb-81ff-fda84264eb58","name":"sdwane2e","description":"sdwan24","requestStream":"request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","responseStream":"response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","otp":"CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0","uri":"10.10.10.1:24038"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"nmsId":{"description":"nmsId","value":{"nmsId":"fc335c24-fb30-46bb-81ff-fda84264eb58"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/onboard/status":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Get MDP onboarding status","operationId":"Get MDP onboarding status","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"status":"completed"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/onboard/{nmsId}":{"put":{"tags":["Configuration - Multidomain Policy"],"description":"update MDP onboarding document","operationId":"updateOnboardingPayload","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Onboard","content":{"application/json":{"schema":{"type":"object"},"examples":{"onboarding-payload":{"description":"onboarding-payload","value":{"controllerUUID":"fc335c24-fb30-46bb-81ff-fda84264eb58","name":"sdwane2e","description":"sdwan24","requestStream":"request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","responseStream":"response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","otp":"CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0","uri":"10.10.10.1:24038"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"nmsId":{"description":"nmsId","value":{"nmsId":"fc335c24-fb30-46bb-81ff-fda84264eb58"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"},"delete":{"tags":["Configuration - Multidomain Policy"],"description":"offboard the mdp application","operationId":"offboard","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/policies/mdpconfig":{"put":{"tags":["Configuration - Multidomain Policy"],"description":"Add internal policy from vmanage","operationId":"addInternalPolicy","requestBody":{"description":"addInternalPolicy","content":{"application/json":{"schema":{"type":"object"},"examples":{"mdpConfig-payload":{"description":"mdpConfig-payload","value":{"controllerUUID":"fc335c24-fb30-46bb-81ff-fda84264eb58","name":"sdwane2e","description":"sdwan24","requestStream":"request-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","responseStream":"response-sdwane2e-fc335c24-fb30-46bb-81ff-fda84264eb58","otp":"CB3313CD-0FE1-BAF3-6DFE-D4F797C35BF0","uri":"10.10.10.1:24038"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"deviceId":{"description":"deviceId","value":{"deviceId":"fc335c24-fb30-46bb-81ff-fda84264eb58"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/mdp/policies/mdpconfig/{deviceId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP ConfigObject","operationId":"Retrieve MDP ConfigObject","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"MdpConfig":{"description":"MdpConfig","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/mdp/policies/{nmsId}":{"get":{"tags":["Configuration - Multidomain Policy"],"description":"Retrieve MDP policies","operationId":"Retrieve MDP policies","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policies":{"description":"Policies","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Multidomain Policy"],"description":"update policy status","operationId":"update policy status","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"policyList","content":{"application/json":{"schema":{"type":"object"},"examples":{"policies":{"description":"policies","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/messaging/device/vmanage":{"get":{"tags":["Device - Messaging"],"description":"Create device vManage connection list","operationId":"createDeviceVmanageConnectionList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MessagingResp"}},"examples":{"Connection list":{"description":"Connection list","value":[{"deviceIP":"172.16.255.26","vmanages":["172.16.255.22"]}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/monitor/sdavccloudconnector/domain":{"get":{"tags":["SD AVC Domain-based App Rules"],"description":"Get SD AVC App Rules based on Domain for O365","operationId":"getCloudConnectorDomainAppRules","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD AVC App Rules based on Domain for O365":{"description":"SD AVC App Rules based on Domain for O365","value":{"header":{"generatedOn":"1717196694387","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-M365Domains"},"columns":[{"title":"Application Name","property":"appName","dataType":"string"},{"title":"Domain","property":"domainName","dataType":"string"},{"title":"Service Area","property":"serviceArea","dataType":"string"},{"title":"Service Instance","property":"serviceInstance","dataType":"string"},{"title":"Allow or Optimize","property":"allowOrOptimize","dataType":"string"},{"title":"Updated By","property":"updatedBy","dataType":"string"},{"title":"Last Updated","property":"lastUpdated","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"}],"fields":[{"property":"appName","dataType":"string"},{"property":"domainName","dataType":"string"},{"property":"serviceArea","dataType":"string"},{"property":"serviceInstance","dataType":"string"},{"property":"allowOrOptimize","dataType":"string"},{"property":"updatedBy","dataType":"string"},{"property":"lastUpdated","dataType":"string"}]},"data":[{"appName":"windows-azure","domainName":"informationprotection.azure.com","serviceInstance":"worldwide","serviceArea":"common"},{"appName":"ms-services","domainName":"dc.services.visualstudio.com","serviceInstance":"worldwide","serviceArea":"common"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/monitor/sdavccloudconnector/ipaddress":{"get":{"tags":["SD AVC IP Address based App Rules"],"description":"Get SD AVC App Rules based on IP Address for O365","operationId":"getCloudConnectorIpAddressAppRules","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD AVC App Rules based on IP Address for O365":{"description":"SD AVC App Rules based on IP Address for O365","value":{"header":{"generatedOn":"1717197416346","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-M365IPAddresses"},"columns":[{"title":"Application Name","property":"appName","dataType":"string"},{"title":"IP Address","property":"ip","dataType":"string"},{"title":"Port","property":"port","dataType":"string"},{"title":"L4 Protocol","property":"l4Protocol","dataType":"string"},{"title":"Service Area","property":"serviceArea","dataType":"string"},{"title":"Allow or Optimize","property":"allowOrOptimize","dataType":"string"},{"title":"Service Instance","property":"serviceInstance","dataType":"string"},{"title":"Updated By","property":"updatedBy","dataType":"string"},{"title":"Last Updated","property":"lastUpdated","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"}],"fields":[{"property":"appName","dataType":"string"},{"property":"ip","dataType":"string"},{"property":"port","dataType":"string"},{"property":"l4Protocol","dataType":"string"},{"property":"serviceArea","dataType":"string"},{"property":"allowOrOptimize","dataType":"string"},{"property":"serviceInstance","dataType":"string"},{"property":"updatedBy","dataType":"string"},{"property":"lastUpdated","dataType":"date"}]},"data":[{"appName":"ms-services","ip":"101.28.252.0/24","port":"N/A","l4Protocol":"TCP","serviceInstance":"china","serviceArea":"common","allowOrOptimize":"allow"},{"appName":"share-point","ip":"104.146.128.0/17","port":"N/A","l4Protocol":"TCP","serviceInstance":"worldwide","serviceArea":"sharepoint","allowOrOptimize":"optimize"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/monitor/sdavccloudconnector/webex":{"get":{"tags":["SD AVC Webex App Rules"],"description":"Get SD AVC App Rules for Webex","operationId":"getWebexAppData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"SD AVC App Rules for Webex":{"description":"SD AVC App Rules for Webex","value":{"header":{"generatedOn":"1717197352724","viewKeys":{"uniqueKey":[],"preferenceKey":"grid-Webex"},"columns":[{"title":"Application Name","property":"appName","dataType":"string"},{"title":"Service Area","property":"serviceArea","dataType":"string"},{"title":"IP Address","property":"ip","dataType":"string"},{"title":"Port","property":"port","dataType":"string"},{"title":"L4 Protocol","property":"l4Protocol","dataType":"string"},{"title":"Quality of Service","property":"qos","dataType":"string"},{"title":"Primary or Fallback","property":"primaryOrFallback","dataType":"string"},{"title":"Region","property":"region","dataType":"string"},{"title":"Updated By","property":"updatedBy","dataType":"string"},{"title":"Last Updated","property":"lastUpdated","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"}],"fields":[{"property":"appName","dataType":"string"},{"property":"serviceArea","dataType":"string"},{"property":"ip","dataType":"string"},{"property":"port","dataType":"string"},{"property":"l4Protocol","dataType":"string"},{"property":"qos","dataType":"string"},{"property":"primaryOrFallback","dataType":"string"},{"property":"region","dataType":"string"},{"property":"updatedBy","dataType":"string"},{"property":"lastUpdated","dataType":"date"}]},"data":[{"appName":"webex-meeting","ip":"114.29.192.0/19","port":"N/A","l4Protocol":"TCP","serviceArea":"meetings","qos":"default","primaryOrFallback":"default"},{"appName":"webex-meeting","ip":"128.177.36.0/24","port":"19560-65535","l4Protocol":"UDP","serviceArea":"calling","qos":"optimizemedia","primaryOrFallback":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/assignLicenses":{"post":{"tags":["SmartLicensing - Licenses"],"description":"Assign msla licenses to devices","operationId":"assignMslaLicensesToDevices","requestBody":{"description":"List of devices for assigning licenses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignMslaLicenses"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/devices":{"get":{"tags":["MSLA"],"description":"Retrieve list of devices and their subscription information","operationId":"getMSLADevices_1","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMslaDevicesPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MSLA"],"description":"Release licenses assigned to the devices","operationId":"releaseLicenses_1","requestBody":{"description":"List of devices for unassigning licenses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseLicensesRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/devices/{uuid}":{"get":{"tags":["SmartLicensing - Licenses"],"description":"Get licenses associated to device","operationId":"getLicenseByUuid_1","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceLicenses"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/licenses":{"get":{"tags":["SmartLicensing - Licenses"],"description":"Get all the licenses","operationId":"getMslaLicenses","parameters":[{"name":"uuid","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MslaLicenses"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/licenses/compliance":{"get":{"tags":["MSLA"],"description":"Retrieve list of devices and their subscription information","operationId":"getLicensesCompliance","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Status":{"description":"Status","value":{"data":{"complianceStatus":[{"complianceStatus":"compliant","reason":"sync complete"},{"complianceStatus":"Out Of Compliance","reason":"unassignedDevice"}],"status":"Out Of Compliance"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/licenses/sync":{"post":{"tags":["MSLA"],"description":"Retrieve MSLA subscription/licenses","operationId":"syncLicenses_1","requestBody":{"description":"Sync license","content":{"application/json":{"schema":{"type":"object"},"examples":{"Sync license":{"description":"Sync license","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription license":{"description":"Subscription license","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-write"}},"/msla/monitoring/licensedDeviceCount":{"get":{"tags":["SmartLicensing - Licenses"],"description":"Get licenses associated to device","operationId":"getDeviceDetailsForDashboard","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/monitoring/licensedDistributionDetails":{"get":{"tags":["SmartLicensing - Licenses"],"description":"Get all license distribution","operationId":"getLicenseDistributionDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseDistribution"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/monitoring/packagingDistributionDetails":{"get":{"tags":["SmartLicensing - Licenses"],"description":"Get all license distribution","operationId":"getPackagingDistributionDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackagingDistribution"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/msla/template":{"get":{"tags":["MSLA"],"description":"Retrieve all MSLA template","operationId":"getAllTemplate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"License Management-read"}},"/msla/template/licenses":{"post":{"tags":["MSLA"],"description":"Retrieve MSLA subscription/licenses","operationId":"getSubscriptions_1","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"License Management-write"}},"/msla/va/License":{"get":{"tags":["MSLA"],"description":"Retrieve MSLA subscription/licenses","operationId":"getSubscriptions","parameters":[{"name":"virtual_account_id","in":"query","description":"virtual_account_id","schema":{"type":"string"}},{"name":"licenseType","in":"query","description":"licenseType","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Subscription":{"description":"Subscription","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"License Management-read"}},"/multicloud/accounts":{"get":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"getAllCloudAccounts","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","schema":{"type":"string"}},{"name":"cloudGatewayEnabled","in":"query","description":"Multicloud cloud gateway enabled","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetAccounts"}},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\",\n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Accounts"],"description":"Add Cloud Account","operationId":"validateAccountAdd","requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccounts"},"examples":{"GCP Add Account request":{"description":"GCP Add Account request","value":[{"accountName":"pp-gcp","cloudGatewayEnabled":true,"cloudType":"GCP","description":"pp-test","gcpCredentials":{"value":{"auth_provider_x509_cert_url":"https://www.googleapis.com/test","auth_uri":"https://accounts.google.com/test","client_email":"gcp-pp@gcp.com","client_id":"1234","client_x509_cert_url":"https://www.googleapis.com/test","private_key":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCw7wLu5GWUYwV5\nA/NFvjXpz8fz2NpF2eBjC+6rLO4qxjxzXcZUGwsAFwzwT52n4D0WpLlSJNZOCtcSkK5beoPXUdPBd\nSTwn7uIrt5459tdsdfYkOIc=\n-----END PRIVATE KEY-----\n","private_key_id":"45678","project_id":"gcp-ppp-21471","token_uri":"https://oauth2.googleapis.com/test","type":"service_account"}},"serviceDiscoveryEnabled":false}]},"AWS Iam/AWS Iam GovCloud Add Account request":{"description":"AWS Iam/AWS Iam GovCloud Add Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsIamCredentials":{"roleArn":"arn101","externalId":"ext101"}}]},"AWS key/AWS key GovCloud Add Account request":{"description":"AWS key/AWS key GovCloud Add Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsKeyCredentials":{"apiKey":"key102","secretKey":"skey102"},"cloudGatewayEnabled":"true"}]},"Azure/Azure GovCloud Add Account request":{"description":"Azure/Azure GovCloud Add Account request","value":[{"cloudType":"AZURE","accountName":"azure_acct_102","description":"azure_acct_102 desc","azureCredentials":{"subscriptionId":"sub103","secretKey":"skey103","clientId":"clientid103","cloudTenantId":"clienttenant103"},"cloudGatewayEnabled":"true","azO365Enabled":"true"}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccountsResponse"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\",\n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/accounts/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get all Multicloud edge accounts","operationId":"getEdgeAccounts","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge accounts":{"description":"Edge accounts"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Authenticate edge account credentials","operationId":"validateEdgeAccountAdd","requestBody":{"description":"Multicloud edge account info","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Account info":{"description":"Edge Account info"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/accounts/edge/{accountId}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get edge account by account Id","operationId":"getEdgeAccountDetails","parameters":[{"name":"accountId","in":"path","description":"Edge Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Multicloud edge account","operationId":"updateEdgeAccount","parameters":[{"name":"accountId","in":"path","description":"Multicloud Edge Account Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud edge account info","content":{"application/json":{"schema":{"type":"object"},"examples":{"Account info":{"description":"Account info"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete edge account","operationId":"deleteEdgeAccount","parameters":[{"name":"accountId","in":"path","description":"Edge Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/accounts/edge/{accountId}/credentials":{"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Multicloud edge account credential","operationId":"validateEdgeAccountUpdateCredentials","parameters":[{"name":"accountId","in":"path","description":"Multicloud Edge Account Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud edge account info","content":{"application/json":{"schema":{"type":"object"},"examples":{"Account info":{"description":"Account info"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/accounts/{accountId}":{"get":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"getCloudAccountDetails","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccounts"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\",\n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"updateAccount","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutAccounts"},"examples":{"GCP Update Account request":{"description":"GCP Update Account request","value":{"accountName":"priypat3-gcp-01","description":"priypat3-individual","serviceDiscoveryEnabled":false,"accountId":"gcp-priypat3gcp01-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"cloudType":"GCP"}},"AWS/AWS GovCloud Update Account request":{"description":"AWS/AWS GovCloud Update Account request","value":{"accountId":"123aws","accountName":"pp-aws","cloudGatewayEnabled":"true","cloudType":"AWS","description":"pp-aws"}},"Azure/Azure GovCloud Update Account request":{"description":"Azure/Azure GovCloud Update Account request","value":{"accountId":"123abcc","accountName":"pp-azure","cloudGatewayEnabled":"true","cloudType":"AZURE","description":"pp-azure"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["MultiCloud - Accounts"],"description":"Obtain all accounts for all clouds","operationId":"deleteAccount","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/accounts/{accountId}/credentials":{"put":{"tags":["MultiCloud - Accounts"],"description":"Update Cloud Account Credentials","operationId":"validateAccountUpdateCredentials","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccounts"},"examples":{"GCP Update Account request":{"description":"GCP Update Account request","value":[{"accountName":"pp-gcp","cloudGatewayEnabled":true,"cloudType":"GCP","description":"pp-test","gcpCredentials":{"value":{"auth_provider_x509_cert_url":"https://www.googleapis.com/test","auth_uri":"https://accounts.google.com/test","client_email":"gcp-pp@gcp.com","client_id":"1234","client_x509_cert_url":"https://www.googleapis.com/test","private_key":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCw7wLu5GWUYwV5\nA/NFvjXpz8fz2NpF2eBjC+6rLO4qxjxzXcZUGwsAFwzwT52n4D0WpLlSJNZOCtcSkK5beoPXUdPBd\nSTwn7uIrt5459tdsdfYkOIc=\n-----END PRIVATE KEY-----\n","private_key_id":"45678","project_id":"gcp-ppp-21471","token_uri":"https://oauth2.googleapis.com/test","type":"service_account"}},"serviceDiscoveryEnabled":false}]},"AWS Iam/AWS Iam GovCloud Update Account request":{"description":"AWS Iam/AWS Iam GovCloud Update Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsIamCredentials":{"roleArn":"arn101","externalId":"ext101"}}]},"AWS key/AWS key GovCloud Update Account request":{"description":"AWS key/AWS key GovCloud Update Account request","value":[{"cloudType":"AWS","accountName":"aws_acct_102","description":"aws_acct_102 desc","awsKeyCredentials":{"apiKey":"key102","secretKey":"skey102"},"cloudGatewayEnabled":"true"}]},"Azure/Azure GovCloud Update Account request":{"description":"Azure/Azure GovCloud Update Account request","value":[{"cloudType":"AZURE","accountName":"azure_acct_102","description":"azure_acct_102 desc","azureCredentials":{"subscriptionId":"sub103","secretKey":"skey103","clientId":"clientid103","cloudTenantId":"clienttenant103"},"cloudGatewayEnabled":"true","azO365Enabled":"true"}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAccountsResponse"},"examples":{"GCP Account Details":{"description":"GCP Account Details","value":"[\n {\n \"accountName\": \"pp-gcp\",\n \"clientEmail\": \"pp@gcpClientEmail.com\",\n \"regionList\": {\n \"value\": [\n \"asia-east1\",\n \"asia-east2\",\n \"asia-northeast1\",\n \"asia-northeast2\",\n \"asia-northeast3\",\n \"asia-south1\",\n \"asia-south2\",\n \"asia-southeast1\",\n \"asia-southeast2\",\n \"australia-southeast1\",\n \"australia-southeast2\",\n \"europe-central2\",\n \"europe-north1\",\n \"europe-southwest1\",\n \"europe-west1\",\n \"europe-west2\",\n \"europe-west3\",\n \"europe-west4\",\n \"europe-west6\",\n \"europe-west8\",\n \"europe-west9\",\n \"northamerica-northeast1\",\n \"northamerica-northeast2\",\n \"southamerica-east1\",\n \"southamerica-west1\",\n \"us-central1\",\n \"us-east1\",\n \"us-east4\",\n \"us-east5\",\n \"us-west1\",\n \"us-west2\",\n \"us-west3\",\n \"us-west4\"\n ]\n },\n \"description\": \"pp-individual\",\n \"serviceDiscoveryEnabled\": false,\n \"accountId\": \"gcp-pp-nprd\",\n \"gcpBillingId\": \"\",\n \"cloudGatewayEnabled\": true,\n \"credType\": \"GCP\",\n \"cloudType\": \"GCP\",\n \"privateKeyId\": \"123456\",\n }\n]"},"Aws Account Details":{"description":"Aws Account Details","value":[{"accountName":"pp-aws","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]},"description":"AWS account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"aws-pp-nprd","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS"}]},"Aws GovCloud Account Details":{"description":"Aws GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["us-gov-west-1","us-gov-east-1"]},"description":"AWS govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"awsGovCloud-pp-nprd-68636","cloudGatewayEnabled":true,"credType":"AWS_KEY","cloudType":"AWS_GOVCLOUD"}]},"Azure Account Details":{"description":"Azure Account Details","value":[{"accountName":"pp-azure","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]},"description":"Azure account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azure-pp-nprd-68636","gcpBillingId":"","cloudGatewayEnabled":true,"credType":"AZURE","cloudType":"AZURE"}]},"Azure GovCloud Account Details":{"description":"Azure GovCloud Account Details","value":[{"accountName":"pp-awsGovCloud","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]},"description":"Azure govCloud account - pp-individual","serviceDiscoveryEnabled":false,"accountId":"azureGovCloud-ppgcp01-nprd-68636","cloudGatewayEnabled":true,"credType":"AZURE_KEY","cloudType":"AZURE_GOVCLOUD"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/audit":{"get":{"tags":["MultiCloud - General"],"description":"Call an audit with dry run","operationId":"auditDryRun","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudRegion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"examples":{"In Sync":{"description":"In Sync","value":{"auditStatus":"IN_SYNC","canFix":true,"auditReport":[]}},"Out Of Sync":{"description":"Out Of Sync","value":{"auditStatus":"OUT_OF_SYNC","canFix":true,"auditReport":[{"status":"IN_SYNC","reportType":"GCR","region":"us-west1","name":"S2C_GCR","details":[]},{"status":"IN_SYNC","reportType":"GCR","region":"us-west1","name":"S2S_GCR","details":[]},{"status":"IN_SYNC","reportType":"CGW_ROUTER","region":"global","details":[]},{"status":"IN_SYNC","reportType":"HOSTVPC","region":"global","details":[]},{"status":"IN_SYNC","reportType":"NCC_HUB","region":"global","name":"s2c-hub","details":[]},{"status":"OUT_OF_SYNC_DRY_RUN","reportType":"NCC_HUB","region":"global","name":"s2s-hub","details":["Spoke s2s-spoke in region us-west1 is missing."]},{"status":"IN_SYNC","reportType":"MAPPING","details":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - General"],"description":"Call an audit","operationId":"audit","requestBody":{"description":"Audit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditFix"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Billing Accounts","operationId":"getEdgeBillingAccounts","parameters":[{"name":"edgeType","in":"path","description":"Interconnect Provider","required":true,"schema":{"type":"string","enum":["EQUINIX"]}},{"name":"edgeAccountId","in":"path","description":"Interconnect Provider Account ID","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Billing Accounts":{"description":"Edge Billing Accounts","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/cloudRoutersAndAttachments":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get all Cloud Routers and their Attachments","operationId":"getCloudRoutersAndAttachments","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}},{"name":"network","in":"query","description":"Network","schema":{"type":"string"}},{"name":"connectivityGatewayName","in":"query","description":"Connectivity Gateway Name","schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","description":"Cloud Gateway Name","schema":{"type":"string"}},{"name":"state","in":"query","description":"State","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud Router":{"description":"Cloud Router","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/cloudgateway":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateways","operationId":"getCgws","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Multicloud account id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Multicloud region","schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","description":"Multicloud cloud gateway name","schema":{"type":"string"}},{"name":"connectivityState","in":"query","description":"Multicloud connectivity state","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudGatewayListResponse"}},"examples":{"Azure Cgw list":{"description":"Azure Cgw list","value":[{"resourceGroupName":"azure-rgp","cloudGatewayName":"az-test","accountName":"ramL","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"virtualRouterAsn":"65515","vhubName":"az-test","description":"","vwanName":"azure-vwan","connectivityStateUpdateTs":1655141135729,"accountId":"8b188c39-f358-4db6-a44f-84068541233a","cloudGatewayId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","cloudType":"AZURE","customSettings":false,"region":"westus2","connectivityState":"initialized","cloudGatewaySolution":"vhub","settings":{"softwareImageId":"17.6.01","skuScaleUnit":2,"ipSubnetPool":"10.0.0.0/16","instanceSize":2},"status":"normal","vpns":[],"connectedSites":1}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - CloudGateway"],"description":"Create cloud gateway","operationId":"createCgw","requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudGatewayPost"},"examples":{"GCP CGW Create request":{"description":"GCP CGW Create request","value":{"accountId":"gcp-project-nprd-312512","cloudType":"GCP","region":"us-west4","cloudGatewayName":"gcp-test","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"GCP post request","s2sPermitted":false,"mrfRouterRole":"border","siteName":"SITE_1","configGroupSettings":{"configGroupName":"CG_1","configGroupId":"d0846e2c-a977-46fa-8acb-0e387a30eadf"}}},"AWS/AWS GovCloud CGW create request":{"description":"AWS/AWS GovCloud CGW create request","value":{"accountId":"238112874124","cloudType":"AWS","region":"us-east-1","cloudGatewayName":"aws-test","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"AWS/AWS_GOVCLOUD post request","mrfRouterRole":"border","siteName":"SITE_1","configGroupSettings":{"configGroupName":"CG_1","configGroupId":"d0846e2c-a977-46fa-8acb-0e387a30eadf"}}},"Azure/Azure GovCloud CGW create request":{"description":"Azure/Azure GovCloud CGW create request","value":{"accountId":"81k99acb9-1a58-b3b6-214f-840623g789a0","cloudType":"AZURE","region":"westus2","cloudGatewayName":"azure-test","mrfRouterRole":"border","siteName":"SITE_1","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299 C8K-53349F28-AB44-70C5-260B-096581250519"],"description":"AZURE/AZURE_GOVCLOUD post request","azureProperties":{"resourceGroupName":"azureTestRGP","resourceGroupSource":"azure","vwanName":"azureTestVwan","vwanSource":"azure","vhubName":"azureTestVhub","vhubSource":"toBeCreated","nvaSource":"toBeCreated"},"configGroupSettings":{"configGroupName":"CG_1","configGroupId":"d0846e2c-a977-46fa-8acb-0e387a30eadf"}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/config-group":{"post":{"tags":["MultiCloud - CloudGateway"],"summary":"Initiate a config group creation for a cloud gateway.","description":"API to initiate a config group creation for a cloud gateway.","operationId":"createCloudGatewayConfigGroup","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Gateway Config Group Creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiCloudGatewaysConfiggroupBody"},"examples":{"Cloud Gateway Config Group Creation":{"description":"Cloud Gateway Config Group Creation","value":{"configGroupName":"CGW_Config_Group","configGroupSolution":"sdwan"}}}}},"required":true},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCgwConfigGroupResponse"},"examples":{"Cloud Gateway Config Group Creation Response":{"description":"Cloud Gateway Config Group Creation Response","value":{"id":"9f4bb392-8255-46cd-a849-1aea7ccbad9a","name":"test_cg","description":"test_cg Config Group","source":"MULTICLOUD_AZURE","solution":"sdwan","lastUpdatedBy":"system","lastUpdatedOn":1712732936141,"createdBy":"system","createdOn":1712732936141,"profiles":[{"id":"5329eb9c-084e-40da-ad17-3304c1922634","name":"test_cg_AZURE_transport","solution":"sdwan","type":"transport","description":null,"lastUpdatedBy":"system","lastUpdatedOn":1712732936112,"createdBy":"system","createdOn":1712732935034,"profileParcelCount":2},{"id":"e578e626-3517-4bcc-b802-aecc4a7e85ba","name":"test_cg_AZURE_system","solution":"sdwan","type":"system","description":null,"lastUpdatedBy":"system","lastUpdatedOn":1712732935020,"createdBy":"system","createdOn":1712732931425,"profileParcelCount":9}],"version":1,"state":null,"devices":[],"numberOfDevices":0,"numberOfDevicesUpToDate":0,"origin":"user","topology":null,"fullConfigCli":false,"iosConfigCli":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/nvaSecurityRules/{cloudGatewayName}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get NVA Security Rules","operationId":"getNvaSecurityRules","parameters":[{"name":"cloudGatewayName","in":"path","description":"Multicloud cloud gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NvaRulesResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - CloudGateway"],"description":"Update NVA Security Rules","operationId":"updateNvaSecurityRules","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Update NVA security Rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NvaRulesListRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/nvas":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Network Virtual Appliances","operationId":"getAzureNetworkVirtualAppliances","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string"}},{"name":"vhubName","in":"query","required":true,"schema":{"type":"string"}},{"name":"vhubSource","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NvasResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/nvasku":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get Azure NVA SKUs","operationId":"getAzureNvaSkuResources","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NvaSkuListResponse"},"examples":{"NVA Skus":{"description":"NVA Skus","value":[{"accountId":"112948124124","accountName":"test_account_name","cloudType":"AZURE","nvaSkuId":"ciscosdwan","nvaSkuName":"ciscosdwan","versionList":[["17.4.20201218","17.6.01","17.7.01"]],"scaleValueList":[[{"scaleUnit":10,"instanceType":"Standard_D4_v2","instanceCount":2},{"scaleUnit":2,"instanceType":"Standard_D4_v2","instanceCount":2},{"scaleUnit":4,"instanceType":"Standard_D4_v2","instanceCount":2}]]}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/resource":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Resource of CGW","operationId":"getCgwOrgResources","parameters":[{"name":"cloudGatewayName","in":"query","description":"Multicloud cloud gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CgwResourceResponse"}},"examples":{"Get CGW Resource":{"description":"Get CGW Resource","value":{"resourceType":"CGW","resourceId":"/subscriptions/9b188cb9-f358-4db6-a44f-8406854789a0/resourceGroups/uxtestrg","creationDate":"Not-Available","details":{"vwanName":"uxabc","vhubName":"AzureCGW","devices":[{"uuid":"C8K-f64c775a-f93a-4c6b-ac54-57448bdc304b","publicIp":"[1.2.193.149]"},{"uuid":"C8K-f64ca-f93a-4c6b-ac54-57448bdc304b","publicIp":"[13.78.223.149]"}],"virtualRouterAsn":"65275"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/resourceGroups":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Resource Groups","operationId":"getAzureResourceGroups","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Multicloud account id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResourceGroupsResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vhubs":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Virtual HUBs","operationId":"getAzureVirtualHubs","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string"}},{"name":"vwanName","in":"query","required":true,"schema":{"type":"string"}},{"name":"vwanSource","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VhubsListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vnetsNoofAttached":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Virtual HUBs","operationId":"getAzureVirtualVnetsAttached","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsVnetAttached"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vpn-gateways":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Vpn Gateways","operationId":"getAzureVpnGateways","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string"}},{"name":"vhubName","in":"query","required":true,"schema":{"type":"string"}},{"name":"vhubSource","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VpnGatewayResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/vwans":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Discover Azure Virtual WANS","operationId":"getAzureVirtualWans","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"query","required":true,"schema":{"type":"string"}},{"name":"resourceGroupSource","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VwanListResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/{cloudGatewayName}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway by name","operationId":"getCgwDetails","parameters":[{"name":"cloudGatewayName","in":"path","description":"Multicloud cloud gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudGatewayAdjusted"},"examples":{"Get GCP CGW ":{"description":"Get GCP CGW ","value":{"cloudGatewayName":"gcp-test","accountName":"gcp-dev","devices":["C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1","C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B","C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"description":"","cloudProviderMgmtReference":"NA","connectivityStateUpdateTs":1654905819730,"s2sPermitted":true,"accountId":"gcp-project-nprd-31900","cloudProviderAsn":0,"sshKeyName":"","tunnelCidrBlocks":[],"cloudGatewayId":"s2c-hub-gcp-test, s2s-hub-gcp-test","cloudType":"GCP","customSettings":true,"cloudGatewaySolution":"gcp","region":"us-west4","connectivityState":"Successful","routeTableCount":"NA","settings":{"softwareImageId":"cisco-c8k-17-05-01a-cisco-public","instanceSize":"n1-standard-4","ipSubnetPool":"10.0.0.0/16","networkTier":"STANDARD"},"status":"error","vpns":[{"vpnId":"9"}],"connectedSites":0,"tunnels":[{"tunnelId":"C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-0D92AF4F-EA3C-3D40-4781-BD5B4112B05B::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1::9","status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}]}},"Get AWS/AWS GovCloud CGW ":{"description":"Get AWS/AWS GovCloud CGW ","value":{"cloudGatewayName":"aws-test","accountName":"aws-dev","devices":["C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C","C8K-C516558F-45CA-3486-38FD-5D0306E05999"],"description":"","cloudProviderMgmtReference":"","connectivityStateUpdateTs":1655144961158,"accountId":"759589527992","cloudProviderAsn":64520,"tunnelCidrBlocks":[],"cloudGatewayId":"tgw-0b6ac1173825c3663","cloudType":"AWS","customSettings":true,"cloudGatewaySolution":"tgw_tvpc","region":"us-east-1","connectivityState":"Successful","routeTableCount":"2","settings":{"softwareImageId":"Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4","instanceSize":"c5.large","ipSubnetPool":"11.0.0.0/16"},"status":"normal","vpns":[{"vpnId":"9"}],"connectedSites":2,"tunnels":[{"tunnelId":"C8K-C516558F-45CA-3486-38FD-5D0306E05999::9","tunnelInnerIps":["169.254.0.12/30","169.254.0.16/30"],"status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-BF4B09D2-1C07-8634-753D-5DE2F5D6B15C::9","tunnelInnerIps":["169.254.0.4/30","169.254.0.8/30"],"status":"DOWN","statusMessage":"NotAvailable","outerIpAddr":"NotAvailable","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}]}},"Get Azure/Azure GovCloud CGW":{"description":"Get Azure/Azure GovCloud CGW","value":{"resourceGroupName":"azure-rgp","cloudGatewayName":"az-test","accountName":"ramL","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-53349F28-AB44-70C5-260B-096581250519"],"virtualRouterAsn":"65515","vhubName":"az-test","description":"","vwanName":"azure-vwan","connectivityStateUpdateTs":1655141135729,"accountId":"8b188c39-f358-4db6-a44f-84068541233a","cloudGatewayId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","cloudType":"AZURE","customSettings":false,"region":"westus2","connectivityState":"initialized","cloudGatewaySolution":"vhub","settings":{"softwareImageId":"17.6.01","skuScaleUnit":2,"ipSubnetPool":"10.0.0.0/16","instanceSize":2},"status":"normal","vpns":[],"connectedSites":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - CloudGateway"],"description":"Update cloud gateway","operationId":"updateCgw","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payloads for updating Cloud Gateway based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCgw"},"examples":{"GCP CGW CGW update":{"description":"GCP CGW CGW update","value":{"cloudType":"GCP","accountId":"gcp-project-nprd-31900","region":"us-west4","s2sPermitted":true,"mrfRouterRole":"border","deviceChanges":{"devicesAdded":["C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"devicesDeleted":[]}}},"AWS/AWS GovCloud CGW update":{"description":"AWS/AWS GovCloud CGW update","value":{"cloudType":"AWS","mrfRouterRole":"border","settings":{"tunnelCount":3}}},"AZURE/AZURE GovCloud CGW update":{"description":"AZURE/AZURE GovCloud CGW update","value":{"cloudType":"AZURE","accountId":"8b188c39-f358-4db6-a44f-84068541233a","region":"westus2","cloudGatewayName":"az-test","mrfRouterRole":"border","devices":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-D4821270-27FF-A1B0-B902-12A321E3A550"],"description":"","resourceGroupName":"test-resource-group","vhubId":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/az-test","settings":{"cloudType":"AZURE","name":"AZURE_CUSTOM_SETTINGS","ipSubnetPool":"10.0.0.0/16","skuScaleUnit":4,"softwareImageId":"17.6.01"}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["MultiCloud - CloudGateway"],"description":"Delete cloud gateway","operationId":"deleteCgw","parameters":[{"name":"cloudGatewayName","in":"path","description":"Multicloud cloud gateway name","required":true,"schema":{"type":"string"}},{"name":"deleteAllResources","in":"query","schema":{"type":"string","default":"true"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/{cloudGatewayName}/site":{"get":{"tags":["MultiCloud - BranchConnect"],"description":"Get sites attached to CGW","operationId":"getCgwAttachedSites","parameters":[{"name":"cloudGatewayName","in":"path","description":"Name of Cloud Gateway to attach site","required":true,"schema":{"type":"string"}},{"name":"systemIp","in":"query","description":"System Ip of Branch Device","schema":{"type":"string"}},{"name":"siteId","in":"query","description":"Site Id","schema":{"type":"string"}},{"name":"color","in":"query","description":"color","schema":{"type":"string"}},{"name":"vpnTunnelStatus","in":"query","description":"Tunnel status of device","schema":{"type":"string"}},{"name":"solution","in":"query","description":"Solution of branch device","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSitesResponse"},"examples":{"Sites":{"description":"Sites","value":{"uuid":"C8K-a165f574-e75e-11ec-8fea-0242ac120002","siteId":"10","hostname":"Branch-10","systemIp":"1.1.1.10","interface":"GigabitEthernet2","color":"red","privateIp":"10.11.2.248","publicIp":"3.109.26.54","attached":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - BranchConnect"],"description":"Update tunnel scaling and accelerated vpn parameter for a branch endpoint","operationId":"tunnelScaling","parameters":[{"name":"cloudGatewayName","in":"path","description":"Name of Cloud Gateway to attach site","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Site Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelScalingRequestPayload"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - BranchConnect"],"description":"Attach sites to Cloud Gateway","operationId":"attachSites","parameters":[{"name":"cloudGatewayName","in":"path","description":"Name of Cloud Gateway to attach site","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Site Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachSitesRequestPayload"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["MultiCloud - BranchConnect"],"description":"Detach sites from cloud gateway","operationId":"detachSites_1","parameters":[{"name":"cloudGatewayName","in":"path","description":"Name of Cloud Gateway to attach site","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Site Information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachSitesRequestPayload"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateway/{cloudType}/gateways/device-chassis-numbers":{"get":{"tags":["MultiCloud - CloudGateway"],"summary":"Get available devices to use for Cloud Gateway or query by Config Group Id.","description":"API to retrieve available devices or devices associated to a config group.","operationId":"getAvailableDevicesOrByCGId","parameters":[{"name":"cloudType","in":"path","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"config-group-id","in":"query","description":"Multicloud config group id","schema":{"type":"string"}},{"name":"device-solution-type","in":"query","description":"Multicloud device solution type","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse200"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgateways/{cloudType}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get sites with connectivity to the cloud by cloud type","operationId":"getCloudGateways","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CloudGatewayListResponse"}},"examples":{" List of CGWs per cloudType ":{"description":" List of CGWs per cloudType ","value":[{"cloudGatewayName":"gcp-test","cloudGatewayId":"s2c-hub-gcptest, s2s-hub-gcptest","description":"","cloudType":"GCP","accountId":"gcp-project-nprd-31900","accountName":"gcp-dev","region":"us-west2","customSettings":true,"status":"normal"},{"cloudGatewayName":"gcp-test-west-4","cloudGatewayId":"s2c-hub-gcptest, s2s-hub-gcptest","description":"","cloudType":"GCP","accountId":"gcp-project-nprd-3190","accountName":"gcp-dev","region":"us-west4","customSettings":true,"status":"normal"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgatewaysetting/{cloudGatewayName}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway custom setting by cloud gateway name","operationId":"getCgwCustomSettingDetails","parameters":[{"name":"cloudGatewayName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSettings"},"examples":{"GCP Custom Custom Settings":{"description":"GCP Custom Custom Settings","value":{"cloudType":"GCP","instanceSize":"n1-standard-4","cgwCustomSettingName":"GCP_CUSTOM_SETTING_gcp-test","networkTier":"STANDARD","ipSubnetPool":"10.0.0.0/16","softwareImageId":"cisco-c8k-17-05-01a-cisco-public"}},"AWS/AWS_GOVCLOUD Custom Settings":{"description":"AWS/AWS_GOVCLOUD Custom Settings","value":{"cloudType":"AWS","ipSubnetPool":"10.0.0.0/16","instanceSize":"c5.large","cgwCustomSettingName":"AWS_CUSTOM_SETTING_aws-test","softwareImageId":"Cisco-C8K-17.04.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1-ami-012fee29ab1f5f2c3.4"}},"AZURE/AZURE_GOVCLOUD Custom Settings":{"description":"AZURE/AZURE_GOVCLOUD Custom Settings","value":{"cloudType":"AZURE","ipSubnetPool":"10.0.0.0/16","skuScaleUnit":2,"cgwCustomSettingName":"AZURE_CUSTOM_SETTING_azure-test","softwareImageId":"17.6.01"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/cloudgatewaytype":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get cloud gateway types for specified cloudType","operationId":"getCgwTypes","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/connected-sites/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get sites with connectivity to the interconnect gateways by edge type","operationId":"getCloudConnectedSites_1","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Interconnect Gateway Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect connected sites":{"description":"Interconnect connected sites","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/connected-sites/{cloudType}":{"get":{"tags":["MultiCloud - General"],"description":"Get sites with connectivity to the cloud by cloud type","operationId":"getCloudConnectedSites","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectedSitesResponse"},"examples":{"Connected Device list":{"description":"Connected Device list","value":[{"uuid":"C8K-CA0D4066-0011-5A4E-D2F9-0F5E77BE2091","host-name":"gcp2","system-ip":"6.6.2.2","local-system-ip":"6.6.2.2","site-id":"5","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655169353069,"version":"17.06.02.0.2786","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"},{"uuid":"C8K-A24CE0EB-D7D4-6920-0129-F7BAB204252C","host-name":"gcp1","system-ip":"6.6.1.1","local-system-ip":"6.6.1.1","site-id":"5","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655166680400,"version":"17.06.02.0.2786","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"},{"uuid":"C8K-D4821270-27FF-A1B0-B902-12A321E3A550","host-name":"az1","system-ip":"5.1.5.5","local-system-ip":"5.1.5.5","site-id":"5","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655170239795,"version":"17.06.01a.0.298","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"},{"uuid":"C8K-2F69B355-2B3D-2801-EB48-F44789422299","host-name":"az2","system-ip":"5.6.6.6","local-system-ip":"5.6.6.6","site-id":"6","device-model":"vedge-C8000V","device-type":"vedge","reachability":"reachable","lastupdated":1655170234517,"version":"17.06.01a.0.298","bfdSessionsUp":2,"bfdSessions":4,"status":"normal","statusBfd":"warning"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/connectivity/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Connectivity details","operationId":"getEdgeConnectivityDetails","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"connectivityName","in":"query","description":"Connectivity Name","schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Connectivity Type","schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Interconnect Gateway name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IC-GW Connectivity":{"description":"IC-GW Connectivity","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Interconnect connectivity","operationId":"updateEdgeConnectivity","requestBody":{"description":"Edge connectivity","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge connectivity":{"description":"Edge connectivity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Interconnect connectivity","operationId":"createEdgeConnectivity","requestBody":{"description":"Edge connectivity","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge connectivity":{"description":"Edge connectivity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivity/edge/{connectionName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Interconnect connectivity","operationId":"deleteEdgeConnectivity","parameters":[{"name":"connectionName","in":"path","description":"Edge connectivity name","required":true,"schema":{"type":"string"}},{"name":"deleteCloudResources","in":"query","description":"Delete Cloud Resources","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivity/edge/{connectivityName}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Connectivity by name","operationId":"getEdgeConnectivityDetailByName","parameters":[{"name":"connectivityName","in":"path","description":"IC-GW connectivity name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"IC-GW Connectivity Name":{"description":"IC-GW Connectivity Name","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivitygateway":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get all Connectivity Gateways","operationId":"getConnectivityGateways","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Cloud Connectivity Type","schema":{"type":"string"}},{"name":"connectivityGatewayName","in":"query","description":"Connectivity Gateway Name","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}},{"name":"network","in":"query","description":"Network","schema":{"type":"string"}},{"name":"state","in":"query","description":"State","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}},{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge gateways":{"description":"Edge gateways","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Connectivity gateway","operationId":"createConnectivityGateway","requestBody":{"description":"Connectivity gateway","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connectivity gateway":{"description":"Connectivity gateway"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete all Connectivity Gateways in local DB","operationId":"cleanUpAllConnectivityGatewaysInLocalDB","parameters":[{"name":"deletionType","in":"query","description":"Deletion Type","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Connectivity Gateway","operationId":"deleteConnectivityGateway","parameters":[{"name":"cloudProvider","in":"path","description":"Cloud Provider","required":true,"schema":{"type":"string"}},{"name":"connectivityGatewayName","in":"path","description":"Connectivity gateway name","required":true,"schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Cloud Connectivity Type","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/connectivitygatewaycreationoptions":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get connectivity gateway creation options","operationId":"getConnectivityGatewayCreationOptions","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"connectivityType","in":"query","description":"Cloud Connectivity Type","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connectivity Gateway Creation options":{"description":"Connectivity Gateway Creation options","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/corenetworkpolicy":{"get":{"tags":["MultiCloud - General"],"description":"Get AWS Cloudwan core network policy","operationId":"getCwanCoreNetworkPolicy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoreNetworkPolicyResponse"},"examples":{"Core Network Policy Response":{"description":"Core Network Policy Response","value":"{\n\"coreNetworkId\": \"core-network-0008d82310d17b86b\",\n\"policyVersionId\": 19,\n\"policyAlias\": \"LIVE, LATEST\",\n\"description\": \"Core Network Policy\",\n\"createdAt\": \"Dec.16, 2022 04:16 UTC\",\n\"changeSetState\": \"EXECUTION_SUCCEEDED\",\n\"policyData\": { \"version\": \"2021.12\" }\"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/dashboard/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get interconnect edge gateway dashboard info","operationId":"getDashboardEdgeInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Dashboard edge info":{"description":"Dashboard edge info"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/device":{"get":{"tags":["MultiCloud - General"],"description":"Get available WAN edge devices","operationId":"getWanDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanEdgeDevicesResponse"},"examples":{"List of available WAN devices":{"description":"List of available WAN devices","value":[{"configuredHostname":"aws-test2","deviceModel":"vedge-C8000V","uuid":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1","configuredSystemIP":"9.1.1.3","isPaygUuid":false},{"configuredHostname":"aws-test","deviceModel":"vedge-C8000V","uuid":"C8K-1FCEF03D-1091-497B-3BA1-7FD24C4CE957","configuredSystemIP":"9.1.1.2","isPaygUuid":false}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/devicelink/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Device Links","operationId":"getDeviceLinks","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"deviceLinkName","in":"query","description":"Device Link Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Links":{"description":"Device Links","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Device Link","operationId":"updateDeviceLink","requestBody":{"description":"Device Link","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Link":{"description":"Device Link"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Device Link","operationId":"createDeviceLink","requestBody":{"description":"Device Link","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Link":{"description":"Device Link"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devicelink/edge/portspeed/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get supported port speed for Device Link","operationId":"getDlPortSpeed","parameters":[{"name":"edgeType","in":"path","description":"Interconnect Provider","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"port-speed":{"description":"port-speed","value":"{100, 200}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devicelink/edge/{deviceLinkName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Device Link","operationId":"deleteDeviceLink","parameters":[{"name":"deviceLinkName","in":"path","description":"Device Link Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devicelink/metroSpeed/edge":{"post":{"tags":["Configuration - Multi Cloud"],"description":"Get Device Link Metro Speed based on device link config","operationId":"getDeviceLinkMetroSpeed","requestBody":{"description":"Device Link","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device Link":{"description":"Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"cisco_dev","deviceLinkName":"test","bandwidth":"50","deviceList":[{"deviceName":"test-dev-0"},{"deviceName":"test-dev-1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"dlMetroBandwidth":{"description":"dlMetroBandwidth","value":1000}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/devices/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get cloud devices by cloud type","operationId":"getCloudDevices_1","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Edge Gateway Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud devices":{"description":"Cloud devices","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/devices/{cloudType}":{"get":{"tags":["MultiCloud - General"],"description":"Get cloud devices by cloud type","operationId":"getCloudDevices","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInfoExtendedResponse"},"examples":{"Device list for cloudType":{"description":"Device list for cloudType","value":[{"cloudGatewayName":"az-test","uuid":"C8K-2F69B355-2B3D-2801-EB48-F44789422299","host-name":"az2","system-ip":"5.6.6.6","local-system-ip":"5.6.6.6","site-id":"6","configuredSystemIP":"5.6.6.6","device-model":"vedge-C8000V","device-type":"vedge","configStatusMessage":"Out of Sync","reachability":"reachable","version":"17.06.01a.0.298","lastupdated":1655168711688,"uptime-date":1655165580000,"status":"normal"},{"cloudGatewayName":"az-test","uuid":"C8K-D4821270-27FF-A1B0-B902-12A321E3A550","host-name":"az1","system-ip":"5.1.5.5","local-system-ip":"5.1.5.5","site-id":"5","configuredSystemIP":"5.1.5.5","device-model":"vedge-C8000V","device-type":"vedge","configStatusMessage":"In Sync","reachability":"reachable","version":"17.06.01a.0.298","lastupdated":1655168712505,"uptime-date":1655164800000,"status":"normal"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/edge/{edgeType}/device":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get available WAN edge devices","operationId":"getEdgeWanDevices","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge devices":{"description":"Edge devices"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/gateway/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateways","operationId":"getIcgws","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}},{"name":"regionId","in":"query","description":"Region Id","schema":{"type":"string"}},{"name":"resourceState","in":"query","description":"Resource State","schema":{"type":"string"}},{"name":"edgeGatewayName","in":"query","description":"Edge gateway name","schema":{"type":"string"}},{"name":"billingAccountId","in":"query","description":"billing Account Id","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateways":{"description":"Interconnect Gateways","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Interconnect Gateway","operationId":"createIcgw","requestBody":{"description":"Interconnect Gateway","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway":{"description":"Interconnect Gateway"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateway/edge/setting/{edgeGatewayName}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateway custom setting by Interconnect Gateway name","operationId":"getIcgwCustomSettingDetails","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway custom setting":{"description":"Interconnect Gateway custom setting","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateway/edge/types":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateway type for specified Edge Provider","operationId":"getIcgwTypes","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway type":{"description":"Interconnect Gateway type","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateway/edge/{edgeGatewayName}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Gateway by name","operationId":"getIcgwDetails","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Gateway":{"description":"Interconnect Gateway","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Interconnect Gateway","operationId":"updateIcgw","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Interconnect Gateway","operationId":"deleteIcgw","parameters":[{"name":"edgeGatewayName","in":"path","description":"Edge gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/gateways/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get sites with connectivity to the interconnect gateways by edge type","operationId":"getEdgeGateways","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Gateways":{"description":"Edge Gateways","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/hostvpc":{"get":{"tags":["MultiCloud - Tagging"],"description":"Get all Host VPCs","operationId":"getHostVpcs","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"accountIds","in":"query","description":"Multicloud cloud gateway enabled","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"untagged","in":"query","description":"Multicloud cloud gateway enabled","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HostVpcsResponse"}},"examples":{"AWS VPCs":{"description":"AWS VPCs","value":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1"}]},"Azure VNETs":{"description":"Azure VNETs","value":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","resourceGroups":"test-rg"}]},"GCP VPCs":{"description":"GCP VPCs","value":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/hostvpc/tags":{"get":{"tags":["MultiCloud - Tagging"],"description":"Get VPC Tags","operationId":"getVpcTags","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"tagName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HostVpcTagResponse"}},"examples":{"AWS VPC Tags":{"description":"AWS VPC Tags","value":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1","tag":"test-tag"}]},"Azure VNET Tags":{"description":"Azure VNET Tags","value":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","resourceGroups":"test-rg","tag":"test-tag","interconnectTag":"No"}]},"GCP VPC Tags":{"description":"GCP VPC Tags","value":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3","tag":"test-tag","interconnectTag":"No"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - Tagging"],"description":"Edit VPCs for a Tag","operationId":"editTag","requestBody":{"description":"Payload for updating VPCs for a Tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostVpcTagPut"},"examples":{"Edit AWS Tag":{"description":"Edit AWS Tag","value":{"tagName":"test-tag","interconnectTag":false,"hostVpcs":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1","id":"vpc-0fd1fbce44f9db86b","label":"vpc-0fd1fbce44f9db86b","interconnectTag":"No"},{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-089a6f8af08dacbf1","hostVpcName":"test-vpc-2","id":"vpc-089a6f8af08dacbf1","label":"vpc-089a6f8af08dacbf1","interconnectTag":"No"}]}},"Edit Azure Tag":{"description":"Edit Azure Tag","value":{"tagName":"test-azure-tag","interconnectTag":false,"vnets":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","vpcName":"test-vnet-1","resourceGroups":"test-rg","id":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","label":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","interconnectTag":"No","tag":"test-azure-tag"},{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-2","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-2","vpcName":"test-vnet-2","resourceGroups":"test-rg","id":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-2","label":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-2","interconnectTag":"No","tag":"test-azure-tag"}]}},"Edit GCP Tag":{"description":"Edit GCP Tag","value":{"tagName":"test-gcp-tag","interconnectTag":false,"hostVpcs":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3","tag":"test-tag","interconnectTag":"No","id":"8360972143511967399","label":"8360972143511967399"},{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"2261865283189378184","hostVpcName":"test-vpc-4","tag":"test-tag","interconnectTag":"No","id":"2261865283189378184","label":"2261865283189378184"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Tagging"],"description":"Tag a VPC","operationId":"hostVpcTagging","requestBody":{"description":"Payload for tagging a VPC","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HostVpcTagPost"},"examples":{"Tag an AWS VPC":{"description":"Tag an AWS VPC","value":{"tagName":"test-tag","interconnectTag":false,"hostVpcs":[{"accountId":"999293417507","accountName":"test-aws-account","region":"us-west-2","cloudType":"AWS","hostVpcId":"vpc-0fd1fbce44f9db86b","hostVpcName":"test-vpc-1","id":"vpc-0fd1fbce44f9db86b","label":"vpc-0fd1fbce44f9db86b"}]}},"Tag an Azure VNET":{"description":"Tag an Azure VNET","value":{"tagName":"test-azure-tag","interconnectTag":false,"vnets":[{"accountId":"9e222d34-9f20-4a2f-9c01-e507193dabb","accountName":"test-azure-account","region":"us-west-2","cloudType":"AZURE","vnetId":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","vnetKey":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1","vpcName":"test-vnet-1","resourceGroups":"test-rg","id":"/subscriptions/9e222d34-9f20-4a2f-9c01-e507193dabb4/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet-1","label":"9e222d34-9f20-4a2f-9c01-e507193dabb4/test-rg/test-vnet-1"}]}},"Tag a GCP VPC":{"description":"Tag a GCP VPC","value":{"tagName":"test-gcp-tag","interconnectTag":false,"hostVpcs":[{"accountId":"gcp-test-1234","accountName":"test-gcp-account","region":"us-west-3","cloudType":"GCP","hostVpcId":"8360972143511967399","hostVpcName":"test-vpc-3","tag":"test-tag","interconnectTag":"No","id":"8360972143511967399","label":"8360972143511967399"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/hostvpc/tags/rebalanceVnets":{"post":{"tags":["MultiCloud - Tagging"],"description":"Tag a VPC","operationId":"rebalanceVnets","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","required":true,"schema":{"type":"string"}},{"name":"tagName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/hostvpc/tags/{tagName}":{"delete":{"tags":["MultiCloud - Tagging"],"description":"Delete a Tag","operationId":"unTag","parameters":[{"name":"tagName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/imagename/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge provider supported images","operationId":"getSupportedEdgeImageNames","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge provider images":{"description":"Edge provider images"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/instancesize":{"get":{"tags":["MultiCloud - Global Settings"],"description":"Get Transit VPC supported size","operationId":"getSupportedInstanceSize","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"accountId","in":"query","schema":{"type":"string"}},{"name":"cloudRegion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InstanceSizeResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/instancesize/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge provider supported size","operationId":"getSupportedEdgeInstanceSize","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge provider size":{"description":"Edge provider size"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/interconnect/accounts":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get Interconnect provider accounts.","description":"API to retrieve Interconnect provider accounts.","operationId":"getInterconnectAccounts","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectAccount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Add an Interconnect provider account to vManage.","description":"API to associate an Interconnect provider account to vManage.","operationId":"addInterconnectAccount","requestBody":{"description":"Request Payload for Multicloud Interconnect Accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"},"examples":{"Interconnect Megaport Account":{"description":"Interconnect Megaport Account","value":{"edgeType":"MEGAPORT","edgeAccountName":"interconnect-mp-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Megaport account","megaportCredentials":{"username":"cisco@megaport.com","password":"XXXXX"}}},"Interconnect Equinix Account":{"description":"Interconnect Equinix Account","value":{"edgeType":"EQUINIX","edgeAccountName":"interconnect-eq-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Equinix account","equinixCredentials":{"clientId":"abcd-1234","clientSecret":"XXXX-XXXX-XXXX"}}}}}},"required":true},"responses":{"200":{"description":"Interconnect Provider Account Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/accounts/{interconnect-account-id}":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get associated Interconnect provider account by id.","description":"API to retrieve associated Interconnect provider account details by id.","operationId":"getInterconnectAccount","parameters":[{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Provider Account Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Edit associated Interconnect provider account name and description.","description":"API to edit associated Interconnect provider account name and description.","operationId":"updateInterconnectAccount","parameters":[{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"},"examples":{"Interconnect Megaport Account":{"description":"Interconnect Megaport Account","value":{"edgeType":"MEGAPORT","edgeAccountName":"interconnect-mp-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Megaport account","megaportCredentials":{"username":"cisco@megaport.com","password":"XXXXX"}}},"Interconnect Equinix Account":{"description":"Interconnect Equinix Account","value":{"edgeType":"EQUINIX","edgeAccountName":"interconnect-eq-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Equinix account","equinixCredentials":{"clientId":"abcd-1234","clientSecret":"XXXX-XXXX-XXXX"}}}}}},"required":true},"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Delete Interconnect provider account from vManage.","description":"API to disassociate Interconnect provider account from vManage.","operationId":"deleteInterconnectAccount","parameters":[{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/accounts/{interconnect-account-id}/credentials":{"put":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Edit associated Interconnect provider account credentials.","description":"API to edit associated Interconnect provider account credentials.","operationId":"updateInterconnectAccountCredentials","parameters":[{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Accounts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"},"examples":{"Interconnect Megaport Account":{"description":"Interconnect Megaport Account","value":{"edgeType":"MEGAPORT","edgeAccountName":"interconnect-mp-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Megaport account","megaportCredentials":{"username":"cisco@megaport.com","password":"XXXXX"}}},"Interconnect Equinix Account":{"description":"Interconnect Equinix Account","value":{"edgeType":"EQUINIX","edgeAccountName":"interconnect-eq-account-name","edgeAccountId":"ABCD-1234-CDEF","description":"This is my Equinix account","equinixCredentials":{"clientId":"abcd-1234","clientSecret":"XXXX-XXXX-XXXX"}}}}}},"required":true},"responses":{"200":{"description":"Interconnect Provider Account Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectAccount"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/audit":{"get":{"tags":["Multicloud Interconnect - Resource Audit"],"summary":"Get audit report for resources.","description":"API to generate audit report for resources.","operationId":"getAuditReport","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"connection-type","in":"query","description":"Interconnect connectivity type","schema":{"type":"string"}},{"name":"cloud-type","in":"query","description":"Cloud provider type","schema":{"type":"string"}},{"name":"device-links","in":"query","description":"Interconnect Equinix device link enabled","schema":{"type":"string","default":"false"}},{"name":"refresh","in":"query","description":"Interconnect Audit Refresh Option","schema":{"type":"string","default":"true"}}],"responses":{"200":{"description":"Audit Report Get Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditReport"},"examples":{"Interconnect Audit In-Sync":{"description":"Interconnect Audit In-Sync","value":{"auditStatus":"IN_SYNC","auditReport":[{"status":"IN_SYNC","errString":"","reportType":"Edge Gateway","resourceName":"MY-ICGW-1","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"}]}},"Interconnect Audit Out-Of-Sync":{"description":"Interconnect Audit Out-Of-Sync","value":{"auditStatus":"OUT_OF_SYNC","auditReport":[{"status":"IN_SYNC","errString":"","reportType":"Edge Gateway","resourceName":"MY-ICGW-1","region":"Equinix SY1, Sydney, NSW, Australia : Sydney"},{"status":"OUT_OF_SYNC_DRY_RUN","errString":"BGP Status down","reportType":"Edge Connection","resourceName":"test-az-conn-1","region":"New York Primary - New York - NY - USA"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/gcr-and-attachments":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Google Cloud Router and Attachments.","description":"API to get Google Cloud Router and Attachments.","operationId":"getGoogleCloudRouterAndAttachments","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectivity-gateway-name","in":"query","schema":{"type":"string"}},{"name":"cloud-gateway-name","in":"query","schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"network","in":"query","schema":{"type":"string"}},{"name":"resource-state","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Google Cloud Router and Attachments Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20010"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vhubs":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Azure Virtual Hubs.","description":"API to retrieve Azure Virtual Hubs.","operationId":"getAzVirtualHubs","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string"}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","description":"Azure cloud resource group name","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}},{"name":"vwan-name","in":"query","schema":{"type":"string"}},{"name":"tag-name","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vwans":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Azure Virtual Wans.","description":"API to retrieve Azure Virtual Wans.","operationId":"getAzVirtualWans","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string"}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","description":"Azure cloud resource group name","required":true,"schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}},{"name":"vwan-name","in":"query","description":"Vwan Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Azure Virtual Wan Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2009"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Create an Azure Virtual Wan.","description":"API to create an Azure Virtual Wan..","operationId":"createAzVirtualWan","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string"}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Azure Vwan","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AzureVirtualWan"},"examples":{"Interconnect Azure VWAN":{"description":"Interconnect Azure VWAN","value":{"cloudType":"AZURE","accountId":"cloud-account-id","accountName":"my-cloud-account-name","name":"my-vwan-name","description":"string","region":"My Azure Region","resourceGroupName":"az-resource-group","tagList":[{"name":"string","value":"mytag"}],"virtualWanType":"optional vwan type","allowBranchToBranchTraffic":false,"vnetTovnetTrafficEnabled":false}}}}},"required":true},"responses":{"200":{"description":"Azure Virtual Wan Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2009"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vwans/{vwan-name}":{"delete":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Delete an Azure Virtual Wan.","description":"API to delete an Azure Virtual Wan.","operationId":"deleteAzVirtualWan","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"vwan-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","description":"Azure cloud resource group name","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get all Cloud Connectivity Gateways.","description":"API to retrieve all Cloud Connectivity Gateways.","operationId":"getCloudConnectivityGateways","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloud-account-id","in":"query","required":true,"schema":{"type":"string"}},{"name":"connectivity-gateway-name","in":"query","schema":{"type":"string"}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}},{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"region","in":"query","schema":{"type":"string"}},{"name":"network","in":"query","schema":{"type":"string"}},{"name":"resource-state","in":"query","description":"resource state","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2008"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Create a Cloud Connectivity Gateway.","description":"API to create a Cloud Connectivity Gateway such as Direct Connect Gateway, Express Route Circuit or Google Cloud routers.","operationId":"addCloudConnectivityGateway","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Cloud Connectivity Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudConnectivityGateway"},"examples":{"AWS Direct Connect Gateway":{"description":"AWS Direct Connect Gateway","value":"{\n\t\"gatewayName\": \"resource-name\",\n\t\"description\": \"This is my resource\",\n\t\"cloudType\": \"AWS\",\n\t\"cloudAccountId\": \"ABCD-1234-CDEF\",\n\t\"region\": \"My AWS region\",\n\t\"cloudGatewayName\": \"my-mc-cloud-gateway\",\n\t\"awsConnectivityGateway\": {\n\t\t\"awsConnectivityType\": \"DIRECT_CONNECT_GATEWAY\",\n\t\t\"directConnectGateway\": {\n\t\t\t\"amazonSideAsn\": 64515,\n\t\t}\n\t}\n}"},"AWS Virtual Private Gateway":{"description":"AWS Virtual Private Gateway","value":"{\n\t\"gatewayName\": \"resource-name\",\n\t\"description\": \"This is my resource\",\n\t\"cloudType\": \"AWS\",\n\t\"cloudAccountId\": \"ABCD-1234-CDEF\",\n\t\"region\": \"My AWS region\",\n\t\"cloudGatewayName\": \"my-mc-cloud-gateway\",\n\t\"awsConnectivityGateway\": {\n\t\t\"awsConnectivityType\": \"VIRTUAL_PRIVATE_GATEWAY\",\n\t\t\"virtualPrivateGateway\": {\n\t\t\t\"availabilityZone\": \"\",\n\t\t\t\"vpgType\": \"ipsec.1\",\n\t\t\t\"amazonSideAsn\": 64515\n\t\t},\n\t}\n}"},"AWS Transit Gateway":{"description":"AWS Transit Gateway","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AWS","cloudAccountId":"ABCD-1234-CDEF","region":"My AWS region","cloudGatewayName":"my-mc-cloud-gateway","awsConnectivityGateway":{"awsConnectivityType":"TRANSIT_GATEWAY","transitGateway":{"amazonSideAsn":64515}}}},"AZURE Express Route Circuit":{"description":"AZURE Express Route Circuit","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AZURE","cloudAccountId":"ABCD-1234-CDEF","region":"My Azure region","azureConnectivityGateway":{"azureConnectivityType":"EXPRESS_ROUTE_CIRCUIT","expressRouteCircuit":{"resourceGroupName":"az-resource-group","allowClassicOperations":true,"globalReachEnabled":true,"bandwidthInGbps":200,"sku":{"name":"resource-name","tier":"STANDARD","family":"METERED_DATA"},"serviceProviderProperties":{"serviceProviderName":"Equinix","peeringLocation":"New York","bandwidthInMbps":200}}}}},"AZURE Express Route Gateway":{"description":"AZURE Express Route Gateway","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AZURE","cloudAccountId":"ABCD-1234-CDEF","region":"My Azure region","azureConnectivityGateway":{"azureConnectivityType":"EXPRESS_ROUTE_GATEWAY","expressRouteGateway":{"resourceGroupName":"az-resource-group","vHubId":"vhub-1234"}}}},"AZURE Virtual Network Gateway":{"description":"AZURE Virtual Network Gateway","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"AZURE","cloudAccountId":"ABCD-1234-CDEF","region":"My Azure region","azureConnectivityGateway":{"azureConnectivityType":"VIRTUAL_NETWORK_GATEWAY","virtualNetworkGateway":{"virtualNetworkGatewayType":"EXPRESS_ROUTE","enableBgp":true,"subnet":"192.168.10.0/24","publicIPAddress":"198.18.0.34/30","sku":{"name":"resource-name","tier":"STANDARD","capacity":100}}}}},"Google Cloud Router and Attachments":{"description":"Google Cloud Router and Attachments","value":{"gatewayName":"resource-name","description":"This is my resource","cloudType":"GCP","cloudAccountId":"ABCD-1234-CDEF","region":"My GCP region","gcpConnectivityGateway":{"gcConnectivityType":"GCR_ATTACHMENT","routerInfo":{"name":"resource-name","region":"My GCP region","network":"my-vpc-network","attachmentDetails":[{"name":"resource-name","region":"My GCP region","secondaryZone":true}]}}}}}}},"required":true},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Delete Cloud Connectivity Gateways by type.","description":"API to delete Cloud Connectivity Gateways by type.","operationId":"deleteCloudConnectivityGateways","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways/create-options":{"get":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Get Cloud Connectivity Gateway create Options.","description":"API to retrieve Cloud Connectivity Gateway create options.","operationId":"getCloudConnectivityGatewayCreateOptions","parameters":[{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string"}},{"name":"cloud-account-id","in":"query","required":true,"schema":{"type":"string"}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Cloud Connectivity Gateway Create Options Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20014"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways/{connectivity-gateway-name}":{"delete":{"tags":["Multicloud Interconnect - Cloud Resource Management"],"summary":"Delete a Cloud Connectivity Gateway.","description":"API to delete a Cloud Connectivity Gateway.","operationId":"deleteCloudConnectivityGateway","parameters":[{"name":"connectivity-gateway-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"cloud-type","in":"path","description":"Cloud Provider Type","required":true,"schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"connectivity-gateway-type","in":"query","description":"Cloud Connectivity Gateway Type","schema":{"type":"string","enum":["DIRECT_CONNECT_GATEWAY","VIRTUAL_PRIVATE_GATEWAY","TRANSIT_GATEWAY","VIRTUAL_INTERFACES","EXPRESS_ROUTE_CIRCUIT","GCR_ATTACHMENT"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/colors/{tunnel-type}":{"get":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Get supported Colors for Interconnect tunnel type.","description":"API to retrieve supported Colors for Interconnect tunnel type.","operationId":"getInterconnectColors","parameters":[{"name":"tunnel-type","in":"path","description":"Interconnect Loopback Tunnel Type","required":true,"schema":{"type":"string","enum":["loopbackTransit","loopbackCgw"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2002"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/connections/tags":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get configured Interconnect host VPC/VNET mapping tags.","description":"API to retrieve configured Interconnect host VPC/VNET mapping tags.","operationId":"getInterconnectMappingTags","parameters":[{"name":"cloud-type","in":"query","description":"Cloud provider type","required":true,"schema":{"type":"string"}},{"name":"cloud-account-id","in":"query","description":"Cloud account id","required":true,"schema":{"type":"string"}},{"name":"resource-group","in":"query","description":"Azure cloud resource group name","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2002"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/device-links":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get Interconnect provider Device-Link.","description":"API to retrieve Interconnect provider Device-Link.","operationId":"getInterconnectDeviceLinks","parameters":[{"name":"device-link-name","in":"query","description":"Interconnect Device Link name","schema":{"type":"string"}},{"name":"interconnect-type","in":"query","description":"Interconnect Provider Type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"refresh","in":"query","description":"Retrieve Interconnect Device-Link from provider enabled","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Interconnect Device-Link Get Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Add an Interconnect Device-Link to vManage.","description":"API to create a Device-Link in vManage.","operationId":"addInterconnectDeviceLink","requestBody":{"description":"Request Payload for Multicloud Interconnect Device Links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"},"examples":{"Interconnect Equinix Device Link":{"description":"Interconnect Equinix Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"ABCD-1234-CDEF","edgeAccountName":"interconnect-account-name","deviceLinkName":"my-device-link","subnet":"20.10.0.0/16","bandwidth":"100","deviceList":[{"deviceName":"ICGW_1"},{"deviceName":"ICGW_2"}]}}}}},"required":true},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/connectivity/device-links/{device-link-name}":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get Interconnect provider Device-Link.","description":"API to retrieve Interconnect provider Device-Link.","operationId":"getInterconnectDeviceLink","parameters":[{"name":"device-link-name","in":"path","description":"Interconnect Device Link name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Device-Link Get Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Update an Interconnect Device-Link to vManage.","description":"API to update a Device-Link in vManage.","operationId":"updateInterconnectDeviceLink","parameters":[{"name":"device-link-name","in":"path","description":"Interconnect Device Link name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Device Links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"},"examples":{"Interconnect Equinix Device Link":{"description":"Interconnect Equinix Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"ABCD-1234-CDEF","edgeAccountName":"interconnect-account-name","deviceLinkName":"my-device-link","subnet":"20.10.0.0/16","bandwidth":"100","deviceList":[{"deviceName":"ICGW_1"},{"deviceName":"ICGW_2"}]}}}}},"required":true},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Delete Interconnect provider Device-Link.","description":"API to Delete Interconnect provider Device-Link.","operationId":"deleteInterconnectDeviceLink","parameters":[{"name":"device-link-name","in":"path","description":"Interconnect Device Link name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/dashboard":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get Multicloud Interconnect dashboard view.","description":"API to retrieve Multicloud Interconnect dashboard view.","operationId":"getInterconnectDashboard","responses":{"200":{"description":"Interconnect Dashboard Response.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDashboard"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/entitlement/licenses":{"get":{"tags":["Multicloud Interconnect - Entitlement"],"summary":"Get Interconnect Licenses","description":"API to retrieve Interconnect licences","operationId":"getInterconnectLicenses","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"query","required":true,"schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}},{"name":"product-type","in":"query","description":"Interconnect License Product Type","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectLicense"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get all Interconnect Gateways.","description":"API to retrieve all Interconnect Gateways from vManage.","operationId":"getInterconnectGateways","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"interconnect-account-id","in":"query","description":"Interconnect provider account id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Interconnect Region","schema":{"type":"string"}},{"name":"region-id","in":"query","description":"Interconnect Region Id","schema":{"type":"string"}},{"name":"interconnect-gateway-name","in":"query","description":"Interconnect Gateway Name","schema":{"type":"string"}},{"name":"resource-state","in":"query","description":"Interconnect Resource State","schema":{"type":"string"}},{"name":"interconnect-billing-account-id","in":"query","description":"Interconnect Billing Account Id","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"All Interconnect Gateways .","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectGatewayExtended"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Create an Interconnect gateway in an Interconnect provider.","description":"API to create an Intercoonect gateway in an Interconnect provider.","operationId":"createInterconnectGateway","requestBody":{"description":"Request Payload for Multicloud Interconnect Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"},"examples":{"Interconnect Megaport Gateways":{"description":"Interconnect Megaport Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"mp-gateway-name","description":"This is my Megaport gateway","region":"Cologix TOR1, Toronto, ON, Canada : Toronto","regionId":"10","siteName":"My_Megaport_Site","deviceUuid":"C8K-f7f6c42c-409d-11eb-9562-005056841be8","settings":{"instanceSize":"Small","softwareImageId":"C8000v 17.09.01a"},"mrfSettings":{"mrfRouterRole":"border","mrfTransportGateway":false}}},"Interconnect Equinix Gateways - MRF Enabled":{"description":"Interconnect Equinix Gateways - MRF Enabled","value":"{\n\t\"edgeType\": \"EQUINIX\",\n\t\"edgeAccountId\": \"ABCD-1234-CDEF\",\n\t\"edgeGatewayName\": \"eq-gateway-name\",\n\t\"description\": \"This is my Equinix Gateway\",\n\t\"region\": \"NY Metro\",\n\t\"regionId\": \"10\",\n\t\"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n\t\"siteName\": \"My_Equinix_Site\",\n\t\"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n\t\"mrfSettings\": {\n\t\t\"mrfRouterRole\": \"edge\",\n\t\t\"mrfTransportGateway\": false\n\t}\n\t\"settings\": {\n\t\t\"instanceSize\": \"Small\",\n\t\t\"softwareImageId\": \"CSR1000v 17.03.03\"\n\t}\n}"}}}},"required":true},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/config-group":{"post":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Initiate a config group creation for an Interconnect gateway.","description":"API to initiate a config group creation for an Interconnect gateway.","operationId":"createInterconnectGatewayConfigGroup","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Gateway Config Group Creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewaysConfiggroupBody"},"examples":{"Interconnect Gateway Config Group Creation":{"description":"Interconnect Gateway Config Group Creation","value":{"configGroupName":"ICGW_Config_Group"}}}}},"required":true},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/image-names":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get Interconnect Gateway software image versions supported by an Interconnect Provider.","description":"API to retrieve Interconnect Gateway software image versions supported by an Interconnect Provider.","operationId":"getInterconnectGatewayImageNames","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2005"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/instance-sizes":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get Interconnect Gateway instance sizes supported by an Interconnect provider.","description":"API to retrieve Interconnect Gateway instance sizes supported by an Interconnect provider.","operationId":"getInterconnectGatewayInstanceSizes","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2004"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/push-config":{"post":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Initiate a configuration push for an Interconnect gateway.","description":"API to initiate a configuration push for an Interconnect gateway.","operationId":"pushInterconnectGatewayConfig","requestBody":{"description":"Request Payload for Multicloud Interconnect Gateway Configuration Push","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewaysPushconfigBody"},"examples":{"Interconnect Gateway Configuration Push":{"description":"Interconnect Gateway Configuration Push","value":{"edgeType":"MEGAPORT","edgeGatewayName":"icgw-name"}}}}},"required":true},"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/types":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get supported Interconnect Gateway solution types.","description":"API to retrieve the supported Interconnect Gateway solution types.","operationId":"getInterconnetGatewayTypes","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/{interconnect-gateway-name}":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get Interconnect Gateway Information.","description":"API to retrieve the Interconnect Gateway Information from vManage.","operationId":"getInterconnectGateway","parameters":[{"name":"interconnect-gateway-name","in":"path","description":"Interconnect gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Gateway Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Edit Interconnect Gateway Information.","description":"API to update the Interconnect Gateway Information in vManage.","operationId":"updateInterconnectGateway","parameters":[{"name":"interconnect-gateway-name","in":"path","description":"Interconnect gateway name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"},"examples":{"Interconnect Megaport Gateways":{"description":"Interconnect Megaport Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"mp-gateway-name","description":"This is my Megaport gateway","region":"Cologix TOR1, Toronto, ON, Canada : Toronto","regionId":"10","siteName":"My_Megaport_Site","deviceUuid":"C8K-f7f6c42c-409d-11eb-9562-005056841be8","settings":{"instanceSize":"Small","softwareImageId":"C8000v 17.09.01a"},"mrfSettings":{"mrfRouterRole":"border","mrfTransportGateway":false}}},"Interconnect Equinix Gateways - MRF Enabled":{"description":"Interconnect Equinix Gateways - MRF Enabled","value":"{\n\t\"edgeType\": \"EQUINIX\",\n\t\"edgeAccountId\": \"ABCD-1234-CDEF\",\n\t\"edgeGatewayName\": \"eq-gateway-name\",\n\t\"description\": \"This is my Equinix Gateway\",\n\t\"region\": \"NY Metro\",\n\t\"regionId\": \"10\",\n\t\"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n\t\"siteName\": \"My_Equinix_Site\",\n\t\"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n\t\"mrfSettings\": {\n\t\t\"mrfRouterRole\": \"edge\",\n\t\t\"mrfTransportGateway\": false\n\t}\n\t\"settings\": {\n\t\t\"instanceSize\": \"Small\",\n\t\t\"softwareImageId\": \"CSR1000v 17.03.03\"\n\t}\n}"}}}},"required":true},"responses":{"200":{"description":"Interconnect Gateway Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Delete an Interconnect gateway.","description":"API to delete an Interconnect Gateway from an Interconnect provider.","operationId":"deleteInterconnectGateway","parameters":[{"name":"interconnect-gateway-name","in":"path","description":"Interconnect gateway name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Process ID Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/gateways/{interconnect-gateway-name}/settings":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get configured custom settings for an Interconnect gateway","description":"API to retrieve the custom settings specified for an Interconnect Gateway","operationId":"getInterconnectGatewayCustomSettings","parameters":[{"name":"interconnect-gateway-name","in":"path","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"query","description":"Interconnect Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Gateway Custom Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewaySettings"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/ip-transit":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get Interconnect ip transit supported by an Interconnect provider.","description":"API to retrieve Interconnect ip transit in MB supported by an Interconnect provider.","operationId":"getInterconnectIpTransit","parameters":[{"name":"interconnect-service-type","in":"query","description":"Interconnect Service Type","required":true,"schema":{"type":"string"}},{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20016"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/service-sw-package":{"get":{"tags":["Multicloud Interconnect - Service Sw package types"],"summary":"Get Interconnect Services software package Types Information.","description":"API to retrieve the Interconnect Services Sw Package Types Information from vManage.","operationId":"getInterconnectServiceSwPkg","parameters":[{"name":"interconnect-provider-name","in":"query","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"query","description":"Interconnect account id","required":true,"schema":{"type":"string"}},{"name":"interconnect-service-type","in":"query","required":true,"schema":{"type":"string"}},{"name":"interconnect-service-vendor-name","in":"query","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"All Interconnect Services types and locations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20015"},"examples":{"Service Software packages":{"description":"Service Software packages","value":{"swPackages":[{"name":"PA-100","packageCode":"PA100","serviceSwVersion":[{"version":"10.1.3","imageName":"PaloAlto-VM-Series-10.1.3-9554"}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/services":{"get":{"tags":["Multicloud Interconnect - Services"],"summary":"Get Interconnect Services Information.","description":"API to retrieve the Interconnect Services Information from vManage.","operationId":"getInterconnectServices","parameters":[{"name":"interconnect-service-vendor-name","in":"query","required":true,"schema":{"type":"string"}},{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-service-type","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"All Interconnect Services","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectService"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/settings/global":{"get":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Get global settings for an Interconnect provider type","description":"API to retrieve global settings for an Interconnect provider type.","operationId":"getInterconnectGlobalSettings","parameters":[{"name":"interconnect-type","in":"query","description":"Interconnect provider type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGlobalSettings"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Edit global settings for an Interconnect provider.","description":"API to update global settings for an Interconnect provider.","operationId":"updateInterconnectGlobalSettings","requestBody":{"description":"Request Payload for Multicloud Interconnect Global Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGlobalSettings"},"examples":{"Interconnect Global Settings":{"description":"Interconnect Global Settings","value":{"edgeType":"MEGAPORT","softwareImageId":"C8000v 17.09.01a","instanceSize":"Small","loopbackTunnelColor":"private3","loopbackCgwColor":"private5","bgpAsn":65000,"multicloudSystemSettings":{"useConfigurationGroup":true}}}}}},"required":true},"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Multicloud Interconnect - Global Settings"],"summary":"Add global settings for an Interconnect provider.","description":"API to add global settings for an Interconnect provider.","operationId":"addInterconnectGlobalSettings","requestBody":{"description":"Request Payload for Multicloud Interconnect Global Settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGlobalSettings"},"examples":{"Interconnect Global Settings":{"description":"Interconnect Global Settings","value":{"edgeType":"MEGAPORT","softwareImageId":"C8000v 17.09.01a","instanceSize":"Small","loopbackTunnelColor":"private3","loopbackCgwColor":"private5","bgpAsn":65000,"multicloudSystemSettings":{"useConfigurationGroup":true}}}}}},"required":true},"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/sshkeys":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get ssh keys for Interconnect provider.","description":"Get ssh keys for Interconnect provider.","operationId":"getInterconnectSshKeys","parameters":[{"name":"interconnect-provider-name","in":"query","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"query","description":"Interconnect account id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Service Ssh Keys in provider account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20016"},"examples":{"Service Ssh Keys":{"description":"Service Ssh Keys","value":{"sshKeys":[{"keyName":"service-ssh-key","keyType":"RSA","keyValue":"ssh-rsa xxxxxxxxxxxxxxxxxxxxxxxxxxxx"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/types":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get supported Multicloud Interconnect providers.","description":"API to retrieve list of supported Interconnect provider Types.","operationId":"getInterconnectTypes","responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/widget":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get all Interconnect widgets","description":"API to retrieve all Interconnect widgets.","operationId":"getAllInterconnectWidgets","responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectWidget"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/billing-accounts":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get billing accounts for Interconnect provider type and account.","description":"API to retrieve billing accounts for an Interconnect provider type and account.","operationId":"getInterconnectBillingAccounts","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2001"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/cloud/{cloud-type}/connectivity/connections/partner-ports":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get supported partner regions for an Interconnect provider.","description":"API to retrieve supported partner regions for an Interconnect provider.","operationId":"getInterconnectPartnerPorts","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider Type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}},{"name":"cloud-type","in":"path","description":"Cloud provider type","required":true,"schema":{"type":"string"}},{"name":"connect-type","in":"query","description":"Interconnect connection connect type","schema":{"type":"string"}},{"name":"vxc-permitted","in":"query","description":"Interconnect connection cross connect enabled","schema":{"type":"string"}},{"name":"authorization-key","in":"query","description":"Cloud connectivity gateway service/pairing key","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Interconnect connection provider sync enabled","schema":{"type":"string","default":"false"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2006"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/connectivity/connections/{connection-type}/port-speeds":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get supported port speeds for an Interconnect connectivity.","description":"API to retrieve supported port speeds for an Interconnect connectivity.","operationId":"getInterconnectPortSpeeds","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider Type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"path","description":"Interconnect provider account id","required":true,"schema":{"type":"string"}},{"name":"connection-type","in":"path","description":"Interconnect connectivity type","required":true,"schema":{"type":"string"}},{"name":"cloud-type","in":"query","description":"Cloud provider type","schema":{"type":"string"}},{"name":"cloud-account-id","in":"query","description":"Cloud account id","schema":{"type":"string"}},{"name":"connect-type","in":"query","description":"Interconnect connection connect type","schema":{"type":"string"}},{"name":"connect-subtype","in":"query","description":"Interconnect connection connect sub-type","schema":{"type":"string"}},{"name":"connectivity-gateway-name","in":"query","description":"Cloud connectivity gateway name","schema":{"type":"string"}},{"name":"partner-port","in":"query","description":"Interconnect cloud onRamp partner port location name","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2007"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/locations":{"get":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Get list of available regions for an Interconnect provider and account.","description":"API to retrieve list of available regions for an Interconnect provider and account.","operationId":"getInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"path","description":"Interconnect account id","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Interconnect provider location","schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Provider Location List.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectLocations"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Update available regions for an Interconnect provider and account.","description":"API to retrieve and update the available regions for an Interconnect provider and account.","operationId":"updateInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"path","description":"Interconnect account id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Provider Location List.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectLocations"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Delete stored regions for an Interconnect provider and account.","description":"API to delete the stored regions for an Interconnect provider and account from vManage.","operationId":"deleteInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-account-id","in":"path","description":"Interconnect account id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/config-group/{config-group-id}/topology":{"get":{"tags":["Multicloud Interconnect - General"],"summary":"Get current Multicloud Interconnect topology for the Config Group.","description":"API to retrieve current Multicloud Interconnect topology for the Config Group.","operationId":"getInterconnectConfigGroupTopology","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"config-group-id","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Config-Group Topology Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20013"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Multicloud Interconnect - General"],"summary":"Update Multicloud Interconnect topology for the Config Group.","description":"API to update current Multicloud Interconnect topology for the Config Group.","operationId":"updateInterconnectConfigGroupTopology","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"config-group-id","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Interconnect Config-Group Topology Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20013"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/connectivity/device-links/metro-speed":{"post":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get metro speed for Device-Link by Device-Link Configuration.","description":"API to get metro speed for Device-Link by Device-Link Configuration.","operationId":"getInterconnectDeviceLinkMetroSpeed","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Device Links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectDeviceLink"},"examples":{"Interconnect Equinix Device Link":{"description":"Interconnect Equinix Device Link","value":{"edgeType":"EQUINIX","edgeAccountId":"ABCD-1234-CDEF","edgeAccountName":"interconnect-account-name","deviceLinkName":"my-device-link","subnet":"20.10.0.0/16","bandwidth":"100","deviceList":[{"deviceName":"ICGW_1"},{"deviceName":"ICGW_2"}]}}}}},"required":true},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20012"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/connectivity/device-links/port-speeds":{"get":{"tags":["Multicloud Interconnect - Connectivity"],"summary":"Get supported port speeds for Device-Link by Interconnect provider.","description":"API to get supported port speeds for Device-Link by Interconnect provider.","operationId":"getInterconnectDeviceLinkPortSpeeds","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse20011"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/gateways/device-chassis-numbers":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get available devices to use for Interconnect Gateway or query by Config Group Id.","description":"API to retrieve available devices or devices associated to a config group.","operationId":"getAvailableDevicesOrByCGId_1","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"config-group-id","in":"query","description":"Config Group Id","schema":{"type":"string"}},{"name":"device-solution-type","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse2003"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/gateways/devices":{"get":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Get available Interconnect Gateway devices.","description":"API to retrieve available Interconnect Gateway devices.","operationId":"getInterconnectGatewayDevices","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect Provider Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse2003"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/locations":{"delete":{"tags":["Multicloud Interconnect - Accounts"],"summary":"Delete stored regions for an Interconnect provider type.","description":"API to delete the stored regions for an Interconnect provider type from vManage.","operationId":"deleteAllInterconnectLocationInfo","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/monitoring/connected-sites":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get Interconnect devices by Interconnect type for monitoring.","description":"API to retrieve Interconnect devices by Interconnect type for monitoring.","operationId":"getMonitoringInterconnectConnectedSites","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-gateway-name","in":"query","description":"Interconnect Gateway Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectConnectedSite"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/monitoring/devices":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get an Interconnect devices by Interconnect type for monitoring.","description":"API to retrieve Interconnect devices by Interconnect type for monitoring.","operationId":"getMonitoringInterconnectDevices","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}},{"name":"interconnect-gateway-name","in":"query","description":"Interconnect Gateway Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDeviceInfoExtended"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/monitoring/gateways":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get an Interconnect gateways by Interconnect type for monitoring.","description":"API to retrieve Interconnect gateways by Interconnect type for monitoring.","operationId":"getMonitoringInterconnectGateways","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectGatewayMonitoring"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interconnect/{interconnect-type}/widget":{"get":{"tags":["Multicloud Interconnect - Monitoring"],"summary":"Get an Interconnect widget for Interconnect type.","description":"API to retrieve an Interconnect widget for an Interconnect type.","operationId":"getInterconnectWidget","parameters":[{"name":"interconnect-type","in":"path","description":"Interconnect provider type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectWidget"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/interfacecolor":{"get":{"tags":["MultiCloud - BranchConnect"],"description":"Get WAN interface colors","operationId":"getWanInterfaceColors","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceColorResponse"}},"examples":{"Interface Colors":{"description":"Interface Colors","value":["default","red","green"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/license/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get License Info for Edge Gateways/Connections","operationId":"getLicenses","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT"]}},{"name":"accountId","in":"query","description":"Edge Account Id","schema":{"type":"string"}},{"name":"productType","in":"query","description":"product Type","schema":{"type":"string","enum":["GATEWAY","CONNECTION","AWSHC"]}},{"name":"refresh","in":"query","description":"Refresh License Cache from Megaport","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Licenses":{"description":"Licenses","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/locations/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Locations","operationId":"getEdgeLocationsInfo","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}},{"name":"accountId","in":"query","description":"Edge Account Id","schema":{"type":"string"}},{"name":"region","in":"query","description":"Region","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge locations":{"description":"Edge locations"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete edge account","operationId":"deleteEdgeAccount_1","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/locations/edge/{edgeType}/accountId/{accountId}":{"put":{"tags":["Configuration - Multi Cloud"],"description":"Update Edge Locations","operationId":"updateEdgeLocationsInfo","parameters":[{"name":"edgeType","in":"path","description":"Edge Type","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"],"default":"MEGAPORT"}},{"name":"accountId","in":"path","description":"Edge Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge locations":{"description":"Edge locations"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/loopbackCGWColor/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Loopback CGW supported colors","operationId":"getSupportedLoopbackCgwColors","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Loopback CGW colors":{"description":"Edge Loopback CGW colors"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/loopbacktransportcolor/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Edge Loopback Tunnel supported colors","operationId":"getSupportedLoopbackTransportColors","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Loopback Tunnel colors":{"description":"Edge Loopback Tunnel colors","value":{"loopbackTunnelColor":["mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/map":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get Mapping details for cloudType","operationId":"getMappingMatrix","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetMapResponse"}},"examples":{"Get map Response":{"description":"Get map Response","value":[{"srcType":"vpn","srcId":"140","destType":"tag","destId":"A14-sf-oregon-test-50","conn":"enabled"},{"srcType":"tag","srcId":"140","destType":"vpn","destId":"A14-sf-oregon-test-50","conn":"enabled"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Mapping"],"description":"Enable Mapping for cloudType","operationId":"processMapping","requestBody":{"description":"Payloads for enable mapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostMapRequest"},"examples":{"Post Map":{"description":"Post Map","value":{"cloudType":"GCP","connMatrix":[{"conn":"enabled","destId":"tag1","destType":"tag","srcId":"100","srcType":"vpn"},{"conn":"enabled","destId":"vpn","destType":"tag","srcId":"100","srcType":"tag"}]}},"Post UnMap":{"description":"Post UnMap","value":{"cloudType":"GCP","connMatrix":[{"conn":"disabled","destId":"tag1","destType":"tag","mapped":[],"outstandingMapping":[],"srcId":"100","srcType":"vpn","unmapped":[{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-011df81d-760e-47e2-b930-cc8eaaff773d::100"},{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-6c832624-b47c-491e-bd95-b5b4b86981ec::100"}]},{"conn":"disabled","destId":"100","destType":"vpn","srcId":"tag1","srcType":"tag"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/defaults":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get default mapping values","operationId":"getDefaultMappingValues","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapDefaults"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/status":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get mapping status","operationId":"getMappingStatus","parameters":[{"name":"cloudType","in":"query","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapStatus"}},"examples":{"Get Map Status":{"description":"Get Map Status","value":{"srcType":"tag","srcId":"tag1","destType":"vpn","destId":"100","mapped":[{"srcType":"vpc","srcId":"4382130894513720959","destType":"vpn","destId":"100","tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","destRegion":"us-west3","sourceTag":"tag2","sourceRegion":"global","cloudType":"GCP"},{"srcType":"vpc","srcId":"4382120894513720959","destType":"vpn","destId":"100","tunnelId":"C8K-8FBB3-B624-1929-22C0-0C55E7DD6858::100","destRegion":"us-west3","sourceTag":"tag2","sourceRegion":"global","cloudType":"GCP"}],"outstandingMapping":[],"unmapped":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/summary":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get mapping summary","operationId":"getMappingSummary","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"vpnTunnelStatus","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MapSummary"}},"examples":{"Get GCP Map Summary":{"description":"Get GCP Map Summary","value":{"region":"us-west2","accountName":"pp-acc","cloudType":"GCP","cloudGatewayName":"cgw1-gcp","cloudGatewaySolution":"gcp","cloudProviderMgmtReference":"NA","connectivityState":"Successful","connectivityStateUpdateTs":"1660614410162","additionalDetails":[{"Account ID":"gcp-abc-10202"},{"WAN VPC Name":"wan-209overlayfi"},{"Site To Cloud VPC Name":"s2c-209overlayfi"},{"Site To Site VPC Name":"s2s-209overlayfi"},{"WAN VPC ID":"5949753400137042430"},{"Site To Cloud VPC ID":"4899470889371257287"},{"Site To Site VPC ID":"3797334272073222570"},{"Site To Cloud Primary GCR Name":"s2c-cr-cgw1-gcp-209overlayfi-0"},{"Site To Cloud NCC Spoke Name":"cgw1-gcp-209overlayfi-s2c-spoke"},{"Site To Cloud NCC Hub Name":"s2c-hub-209overlayfi"},{"Site To Site NCC Hub Name":"s2s-hub-209overlayfi"}],"devices":[{"uuid":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858","systemIp":"101.1.1.9","reachability":"reachable"},{"uuid":"C8K-4ABB877C-519B-5186-B271-5698961952F4","systemIp":"101.1.1.7","reachability":"reachable"},{"uuid":"C8K-495C4EB7-0813-01F2-06E1-2BFBE1C15965","systemIp":"101.1.1.6","reachability":"reachable"}],"status":"normal,","connectedSites":"1,","vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.42","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"},{"tunnelId":"C8K-4ABB877C-519B-5186-B271-5698961952F4::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.40","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}],"tags":[{"tag":"tag1"}],"hostVpcs":[{"hostVpcId":"4382130894513720959","accountId":"gcp-pp-nprd-10202","tag":"tag1"},{"hostVpcId":"5752708641463555655","accountId":"gcp-pp-nprd-10202","tag":"tag1"}],"operState":""}},"Get AWS Map Summary":{"description":"Get AWS Map Summary","value":{"region":"us-west-1","accountName":"sdwan-pp","cloudType":"AWS","cloudGatewayName":"awstest","cloudGatewaySolution":"tgw_tvpc","cloudProviderMgmtReference":"arn:aws:networkma380167:global-network","connectivityState":"Successful","connectivityStateUpdateTs":"1661542265017","additionalDetails":[{"Account ID":"845888380167"},{"Transit Gateway ID":"tgw-0dd6167696ff9"},{"TGW Route Table Count":"2"},{"Transit VPC ID":"vpc-09f7ce0e792d78e73"},{"Transit VPC Name":"awscgwtest"}],"devices":[{"uuid":"C8K-09f782-bc71-4f91-9673-cfeea2f8f235","systemIp":"203.1.1.1","reachability":"reachable"}],"status":"normal","connectedSites":1,"vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-09f76182-bc71-4f91-9673-cfeea2f8f235::100","tunnelInnerIps":["169.254.0.76/30","169.254.0.80/30"],"status":"DOWN","statusMessage":"IPSEC IS DOWN","outerIpAddr":"52.53.91.70","acceptedRouteCount":0,"lastStatusChangeTimestamp":"1660986000"}],"tags":[{"tag":"tagtest"}],"hostVpcs":[{"hostVpcId":"vpc-0445ecc99eecdf","accountId":"845888380167","tag":"tagtest"}],"operState":""}},"Get Azure Map Summary":{"description":"Get Azure Map Summary","value":{"region":"westcentralus","accountName":"pp-azure","cloudType":"AZURE","cloudGatewayName":"AzureCGW","connectivityState":"Successful","connectivityStateUpdateTs":"16606410162","additionalDetails":[{"Account ID":"aws-pp-nprd-10202"},{"WAN VPC Name":"wan-209overlayfi"},{"Site To Cloud VPC Name":"s2c-209overlayfi"},{"Site To Site VPC Name":"s2s-209overlayfi"},{"WAN VPC ID":"5949753400137042430"},{"Site To Cloud VPC ID":"4899470889371257287"},{"Site To Site VPC ID":"3797334272073222570"},{"Site To Cloud Primary GCR Name":"s2c-cr-cgw1-gcp-209overlayfi-0"},{"Site To Cloud NCC Spoke Name":"cgw1-gcp-209overlayfi-s2c-spoke"},{"Site To Cloud NCC Hub Name":"s2c-hub-209overlayfi"},{"Site To Site NCC Hub Name":"s2s-hub-209overlayfi"}],"devices":[{"uuid":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858","systemIp":"101.1.1.9","reachability":"reachable"},{"status":"normal"},{"connectedSites":1}],"vpns":[{"vpnId":"100"}],"tunnels":[{"tunnelId":"C8K-5DE8FBB3-B624-1929-22C0-0C55E7DD6858::100","status":"UP","statusMessage":"","outerIpAddr":"10.0.0.42","acceptedRouteCount":0,"lastStatusChangeTimestamp":"NotAvailable"}],"tags":[{"tag":"tag1"}],"hostVpcs":[{"hostVpcId":"4382130894513720959","accountId":"gcp-shabshargcp-nprd-10202","tag":"tag1"}],"operState":""}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/tags":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get cloud gateway types for specified cloudType","operationId":"getMappingTags","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/map/tags/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get default Interconnect mapping tag values","operationId":"getEdgeMappingTags","parameters":[{"name":"cloudType","in":"query","description":"Cloud type","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE"]}},{"name":"accountId","in":"query","description":"Cloud Account Id","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interconnect Cloud Tags":{"description":"Interconnect Cloud Tags","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/map/vpns":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get default mapping values","operationId":"getMappingVpns","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapVpnsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/mapping/{cloudType}":{"get":{"tags":["MultiCloud - Mapping"],"description":"Get associated mappings to the CGW","operationId":"getCgwAssociatedMappings","parameters":[{"name":"cloudType","in":"path","description":"Multicloud provider type","required":true,"schema":{"type":"string"}},{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}},{"name":"siteUuid","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CgwVpnsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/partnerports/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get partner ports","operationId":"getPartnerPorts","parameters":[{"name":"edgeType","in":"query","description":"Edge type","schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"accountId","in":"query","description":"Edge Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"connectType","in":"query","description":"Connect Type filter","schema":{"type":"string"}},{"name":"vxcPermitted","in":"query","description":"VXC Permitted on the port","schema":{"type":"string"}},{"name":"authorizationKey","in":"query","description":"authorization Key","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge Partners ":{"description":"Edge Partners ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get supported port speed","operationId":"getPortSpeed","parameters":[{"name":"edgeType","in":"path","description":"Interconnect Provider","required":true,"schema":{"type":"string","enum":["MEGAPORT","EQUINIX"]}},{"name":"edgeAccountId","in":"path","description":"Interconnect Provider Account ID","required":true,"schema":{"type":"string"}},{"name":"connectivityType","in":"path","description":"Interconnect Connectivity Type","required":true,"schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Service Provider","schema":{"type":"string","enum":["AWS","AZURE","GCP"]}},{"name":"cloudAccountId","in":"query","description":"Cloud Service Provider Account ID","schema":{"type":"string"}},{"name":"connectType","in":"query","description":"Connection Type filter","schema":{"type":"string"}},{"name":"connectSubType","in":"query","description":"Connection Sub-Type filter","schema":{"type":"string"}},{"name":"connectivityGateway","in":"query","description":"Connectivity Gateway","schema":{"type":"string"}},{"name":"partnerPort","in":"query","description":"partnerPort","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"port-speed":{"description":"port-speed","value":"{100, 200}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/pushCgwConfig":{"post":{"tags":["MultiCloud - CloudGateway"],"description":"Push configuration to devices of CGW","operationId":"pushCgwCfg","requestBody":{"description":"Push configuration to devices of CGW","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushCgwConfig"},"examples":{"Push Cgw Config to devices":{"description":"Push Cgw Config to devices","value":{"cloudGatewayName":"cgw-test","cloudType":"GCP"}},"Post UnMap":{"description":"Post UnMap","value":{"cloudType":"GCP","connMatrix":[{"conn":"disabled","destId":"tag1","destType":"tag","mapped":[],"outstandingMapping":[],"srcId":"100","srcType":"vpn","unmapped":[{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-011df81d-760e-47e2-b930-cc8eaaff773d::100"},{"cloudType":"GCP","destId":"3889358374498280098","destRegion":"global","destTag":"tag1","destType":"vpc","sourceRegion":"us-west1","srcId":"100","srcType":"vpn","tunnelId":"C8K-6c832624-b47c-491e-bd95-b5b4b86981ec::100"}]},{"conn":"disabled","destId":"100","destType":"vpn","srcId":"tag1","srcType":"tag"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/regions":{"get":{"tags":["MultiCloud - General"],"description":"Obtain all supported Cloud Service Provider (CSP) types","operationId":"getCloudRegions","parameters":[{"name":"cloudType","in":"query","schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetRegions"}},"examples":{"GCP Regions":{"description":"GCP Regions","value":[{"cloudType":"GCP","regionList":{"value":["asia-east1","asia-east2","asia-northeast1","asia-northeast2","asia-northeast3","asia-south1","asia-south2","asia-southeast1","asia-southeast2","australia-southeast1","australia-southeast2","europe-central2","europe-north1","europe-southwest1","europe-west1","europe-west2","europe-west3","europe-west4","europe-west6","europe-west8","europe-west9","northamerica-northeast1","northamerica-northeast2","southamerica-east1","southamerica-west1","us-central1","us-east1","us-east4","us-east5","us-west1","us-west2","us-west3","us-west4"]}}]},"Aws Regions":{"description":"Aws Regions","value":[{"cloudType":"AWS","regionList":{"value":["af-south-1","eu-north-1","ap-south-1","eu-west-3","eu-west-2","eu-south-1","eu-west-1","ap-northeast-3","ap-northeast-2","me-south-1","ap-northeast-1","sa-east-1","ca-central-1","ap-east-1","ap-southeast-1","ap-southeast-2","eu-central-1","ap-southeast-3","us-east-1","us-east-2","us-west-1","us-west-2"]}}]},"Aws GovCloud Regions":{"description":"Aws GovCloud Regions","value":[{"cloudType":"AWS_GOVCLOUD","regionList":{"value":["us-gov-west-1","us-gov-east-1"]}}]},"Azure Regions":{"description":"Azure Regions","value":[{"cloudType":"AZURE","regionList":{"value":["eastus","eastus2","southcentralus","westus2","westus3","australiaeast","southeastasia","northeurope","swedencentral","uksouth","westeurope","centralus","southafricanorth","centralindia","eastasia","japaneast","koreacentral","canadacentral","francecentral","germanywestcentral","norwayeast","switzerlandnorth","brazilsouth","eastus2euap","centralusstage","eastusstage","eastus2stage","northcentralusstage","southcentralusstage","westusstage","westus2stage","asia","asiapacific","australia","brazil","canada","europe","france","germany","global","india","japan","korea","norway","southafrica","switzerland","uae","uk","unitedstates","unitedstateseuap","eastasiastage","southeastasiastage","northcentralus","westus","jioindiawest","uaenorth","centraluseuap","westcentralus","southafricawest","australiacentral","australiacentral2","australiasoutheast","japanwest","jioindiacentral","koreasouth","southindia","westindia","canadaeast","francesouth","germanynorth","norwaywest","switzerlandwest","ukwest","uaecentral","brazilsoutheast"]}}]},"Azure GovCloud Regions":{"description":"Azure GovCloud Regions","value":[{"cloudType":"AZURE_GOVCLOUD","regionList":{"value":["usgovvirginia","global","usgovarizona","usdodcentral","usdodeast","usgoviowa","usgovtexas"]}}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/settings/edge/global":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get edge global settings","operationId":"getEdgeGlobalSettings","parameters":[{"name":"edgeType","in":"query","description":"Edge type","required":true,"schema":{"type":"string","enum":["MP","EQ"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global setting":{"description":"Global setting"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Multi Cloud"],"description":"Update edge global settings for Edge provider","operationId":"updateEdgeGlobalSettings","requestBody":{"description":"Global setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global setting":{"description":"Global setting"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Multi Cloud"],"description":"Add global settings for Edge provider","operationId":"addEdgeGlobalSettings","requestBody":{"description":"Global setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global setting":{"description":"Global setting"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/settings/global":{"get":{"tags":["MultiCloud - Global Settings"],"description":"Get global settings","operationId":"getGlobalSettings","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"},"examples":{"GCP Global settings":{"description":"GCP Global settings","value":{"cloudGatewaySolution":"gcp","cloudType":"GCP","name":"GCP_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"cisco-c8k-17-07-01a-cisco-public","instanceSize":"n1-standard-4","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","cgwBgpAsnOffset":64520,"mapTvpc":true,"networkTier":"STANDARD","orgBgpAsn":64530,"policyManagement":false,"serviceDirPollTimer":1200,"tunnelType":"ipsec","multicloudSystemSettings":{"useConfigurationGroup":true}}},"Aws Global settings":{"description":"Aws Global settings","value":{"cloudGatewaySolution":"tgw_tvpc","cloudType":"AWS","name":"AWS_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1","instanceSize":"c5.xlarge","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","accountId":"999293417507","cgwBgpAsnOffset":64520,"mapTvpc":true,"programDefaultRoute":true,"region":"us-west-1","tunnelType":"ipsec","tunnelCount":1,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Aws GovCloud Global settings":{"description":"Aws GovCloud Global settings","value":{"cloudGatewaySolution":"tgw_tvpc","cloudType":"AWS_GOVCLOUD","name":"AWS__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1","instanceSize":"c5.large","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","accountId":"not available","cgwBgpAsnOffset":64520,"mapTvpc":true,"programDefaultRoute":true,"region":"us-gov-west-1","tunnelType":"ipsec","tunnelCount":1,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Azure Global settings":{"description":"Azure Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE","name":"AZURE_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":2,"enableDefRouteAdvertize":false,"enableMonitoring":false,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Azure GovCloud Global settings":{"description":"Azure GovCloud Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE_GOVCLOUD","name":"AZURE__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":4,"multicloudSystemSettings":{"useConfigurationGroup":true}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - Global Settings"],"description":"Update global settings","operationId":"updateGlobalSettings","requestBody":{"description":"Payload for updating Global Settings based on CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"},"examples":{"GCP Global settings":{"description":"GCP Global settings","value":{"cloudGatewaySolution":"gcp","cloudType":"GCP","name":"GCP_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"cisco-c8k-17-07-01a-cisco-public","instanceSize":"n1-standard-4","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","cgwBgpAsnOffset":64520,"mapTvpc":true,"networkTier":"STANDARD","orgBgpAsn":64530,"policyManagement":false,"serviceDirPollTimer":1200,"tunnelType":"ipsec","multicloudSystemSettings":{"useConfigurationGroup":true}}},"Aws Global settings":{"description":"Aws Global settings","value":{"cloudGatewaySolution":"tgw_tvpc","cloudType":"AWS","name":"AWS_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1","instanceSize":"c5.xlarge","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","accountId":"999293417507","cgwBgpAsnOffset":64520,"mapTvpc":true,"programDefaultRoute":true,"region":"us-west-1","tunnelType":"ipsec","tunnelCount":1,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Aws GovCloud Global settings":{"description":"Aws GovCloud Global settings","value":{"cloudGatewaySolution":"tgw_tvpc","cloudType":"AWS_GOVCLOUD","name":"AWS__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1","instanceSize":"c5.large","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","accountId":"not available","cgwBgpAsnOffset":64520,"mapTvpc":true,"programDefaultRoute":true,"region":"us-gov-west-1","tunnelType":"ipsec","tunnelCount":1,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Azure Global settings":{"description":"Azure Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE","name":"AZURE_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":2,"enableDefRouteAdvertize":false,"enableMonitoring":false,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Azure GovCloud Global settings":{"description":"Azure GovCloud Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE_GOVCLOUD","name":"AZURE__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":4,"multicloudSystemSettings":{"useConfigurationGroup":true}}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["MultiCloud - Global Settings"],"description":"Add global settings","operationId":"addGlobalSettings","requestBody":{"description":"Responses for get Global Settings based CloudType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSettings"},"examples":{"GCP Global settings":{"description":"GCP Global settings","value":{"cloudGatewaySolution":"gcp","cloudType":"GCP","name":"GCP_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"cisco-c8k-17-07-01a-cisco-public","instanceSize":"n1-standard-4","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","cgwBgpAsnOffset":64520,"mapTvpc":true,"networkTier":"STANDARD","orgBgpAsn":64530,"policyManagement":false,"serviceDirPollTimer":1200,"tunnelType":"ipsec","multicloudSystemSettings":{"useConfigurationGroup":true}}},"Aws Global settings":{"description":"Aws Global settings","value":{"cloudGatewaySolution":"tgw_tvpc","cloudType":"AWS","name":"AWS_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1","instanceSize":"c5.xlarge","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","accountId":"999293417507","cgwBgpAsnOffset":64520,"mapTvpc":true,"programDefaultRoute":true,"region":"us-west-1","tunnelType":"ipsec","tunnelCount":1,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Aws GovCloud Global settings":{"description":"Aws GovCloud Global settings","value":{"cloudGatewaySolution":"tgw_tvpc","cloudType":"AWS_GOVCLOUD","name":"AWS__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":true,"softwareImageId":"Cisco-C8K-17.05.01a-42cb6e93-8d9d-490b-a73c-e3e56077ffd1","instanceSize":"c5.large","intraTagComm":true,"ipSubnetPool":"10.0.0.0/16","accountId":"not available","cgwBgpAsnOffset":64520,"mapTvpc":true,"programDefaultRoute":true,"region":"us-gov-west-1","tunnelType":"ipsec","tunnelCount":1,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Azure Global settings":{"description":"Azure Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE","name":"AZURE_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":2,"enableDefRouteAdvertize":false,"enableMonitoring":false,"multicloudSystemSettings":{"useConfigurationGroup":true}}},"Azure GovCloud Global settings":{"description":"Azure GovCloud Global settings","value":{"cloudGatewaySolution":"vhub","cloudType":"AZURE_GOVCLOUD","name":"AZURE__GOVCLOUD_GLOBAL_SETTING","enableAutoCorrect":true,"enablePeriodicAudit":false,"intraTagComm":false,"ipSubnetPool":"21.0.0.0/16","softwareImageId":"17.7.01","orgBgpAsn":64512,"skuScaleUnit":4,"multicloudSystemSettings":{"useConfigurationGroup":true}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/site":{"get":{"tags":["MultiCloud - BranchConnect"],"description":"Get available sites","operationId":"getSites","parameters":[{"name":"color","in":"query","description":"color","schema":{"type":"string"}},{"name":"attached","in":"query","description":"Get attached Sites","schema":{"type":"string"}},{"name":"solution","in":"query","description":"Solution of branch device","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSitesResponse"},"examples":{"Sites":{"description":"Sites","value":{"uuid":"C8K-a165f574-e75e-11ec-8fea-0242ac120002","siteId":"10","hostname":"Branch-10","systemIp":"1.1.1.10","interface":"GigabitEthernet2","color":"red","privateIp":"10.11.2.248","publicIp":"3.109.26.54","attached":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/sshkeys":{"get":{"tags":["MultiCloud - General"],"description":"Get ssh keyList for cloud type","operationId":"getSshKeyList","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"cloudRegion","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SshKeyList"}},"examples":{"sshKeyList":{"description":"sshKeyList","value":[{"sshKeyName":"pp-newkp-oregon"},{"sshKeyName":"pp-newkp-oregon-2"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/statistics/interface/aggregation":{"post":{"tags":["MultiCloud - General"],"description":"Get aggregated data based on input query and filter. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_28","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats Query String":{"description":"Stats Query String","value":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse2001"},"examples":{"Aggregated Search Result":{"description":"Aggregated Search Result","value":{"data":[{"latency":0.6404125644631974}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/swimages":{"get":{"tags":["MultiCloud - Global Settings"],"description":"Get software image list","operationId":"getSupportedSoftwareImageList","parameters":[{"name":"cloudType","in":"query","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"accountId","in":"query","schema":{"type":"string"}},{"name":"cloudRegion","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SwImagesResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/telemetry":{"post":{"tags":["MultiCloud - General"],"description":"Reports telemetry data","operationId":"telemetry","requestBody":{"description":"telemetry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelemetryRequests"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Taskid"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/tunnels/{cloudType}":{"get":{"tags":["MultiCloud - CloudGateway"],"description":"Get the tunnels for cloudType","operationId":"getTunnelNames","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]}},{"name":"cloudGatewayName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetTunnelsResponse"}},"examples":{"Get Tunnels":{"description":"Get Tunnels","value":{"101.1.1.9":{"hostname":"gcp1109","tunnels":["GigabitEthernet2"]},"101.1.1.7":{"hostname":"gcp1107","tunnels":["GigabitEthernet2"]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/types":{"get":{"tags":["MultiCloud - General"],"description":"Obtain all supported Cloud Service Provider (CSP) types","operationId":"getCloudTypes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"List of CloudTypes":{"description":"List of CloudTypes","value":["AWS","AWS_GOVCLOUD","GCP","AZURE","AZURE_GOVCLOUD"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/types/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get edge types","operationId":"getEdgeTypes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud types":{"description":"Cloud types"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vhubs":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Virtual Hubs","operationId":"getVHubs","parameters":[{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}},{"name":"vWanName","in":"query","description":"VWan Name","schema":{"type":"string"}},{"name":"vNetTags","in":"query","description":"VNet Tags","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Azure Virtual WANs":{"description":"Azure Virtual WANs","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vwan":{"post":{"tags":["Configuration - Multi Cloud"],"description":"Create Virtual WAN","operationId":"createVirtualWan","requestBody":{"description":"Virtual WAN","content":{"application/json":{"schema":{"type":"object"},"examples":{"Virtual WAN":{"description":"Virtual WAN"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vwan/{cloudProvider}/{vWanName}":{"delete":{"tags":["Configuration - Multi Cloud"],"description":"Delete Virtual Wan","operationId":"deleteVirtualWan","parameters":[{"name":"cloudProvider","in":"path","description":"Cloud Provider","required":true,"schema":{"type":"string"}},{"name":"vWanName","in":"path","description":"Virtual Wan name","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/vwans":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Virtual Wans","operationId":"getVWans","parameters":[{"name":"accountId","in":"query","description":"Account Id","schema":{"type":"string"}},{"name":"cloudType","in":"query","description":"Cloud Type","schema":{"type":"string"}},{"name":"resourceGroup","in":"query","description":"Resource Group","schema":{"type":"string"}},{"name":"refresh","in":"query","description":"Refresh","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Azure Virtual WANs":{"description":"Azure Virtual WANs","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/multicloud/widget":{"get":{"tags":["MultiCloud - General"],"description":"Get All cloud widgets","operationId":"getAllCloudWidgets","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Widgets"},"examples":{"Widgets":{"description":"Widgets","value":{"cloudType":"AWS","cgwStatus":{"name":"Cloud Gateway","count":0,"statusList":[{"name":"Cloud Gateway","count":0,"status":"normal","message":"Cloud Gateways"},{"name":"Cloud Gateway","count":0,"status":"warning","message":"Cloud Gateways with warning"},{"name":"Cloud Gateway","count":0,"status":"error","message":"Cloud Gateways with error"}]},"cgwDeviceStatus":{"name":"Cloud Gateway Device","count":0,"unreachableCount":0,"statusList":[{"name":"Cloud Gateway Device","count":0,"status":"normal","message":"Cloud Gateway devices"},{"name":"Cloud Gateway Device","count":0,"status":"error","message":"Cloud Gateway devices with errors"}]},"cgwSitesStatus":{"name":"Cloud Gateway Sites","count":0,"statusList":[{"name":"Cloud Gateway Sites","count":0,"status":"error","message":"Cloud Gateway Sites with error"},{"name":"Cloud Gateway Sites","count":0,"status":"warning","message":"Cloud Gateway Sites with warning"},{"name":"Cloud Gateway Sites","count":0,"status":"normal","message":"Cloud Gateway Sites"}]},"cloudGatewaySolution":"tgw_tvpc","numAccounts":0,"numVpns":0,"numTags":0,"numVpcs":0,"numTunnels":0,"cgwDeviceSiteIds":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/widget/edge":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get All Interconnect Edge widgets ","operationId":"getAllEdgeWidgets","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge widget":{"description":"Edge widget","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/widget/edge/{edgeType}":{"get":{"tags":["Configuration - Multi Cloud"],"description":"Get Interconnect Edge widget by edge type","operationId":"getEdgeWidget","parameters":[{"name":"edgeType","in":"path","description":"Edge type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge widget":{"description":"Edge widget","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/multicloud/widget/{cloudType}":{"get":{"tags":["MultiCloud - General"],"description":"Get cloud widget by cloud type","operationId":"getCloudWidget","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudWidget"},"examples":{"Widget":{"description":"Widget","value":{"cloudType":"AWS","cgwStatus":{"name":"Cloud Gateway","count":0,"statusList":[{"name":"Cloud Gateway","count":0,"status":"normal","message":"Cloud Gateways"},{"name":"Cloud Gateway","count":0,"status":"warning","message":"Cloud Gateways with warning"},{"name":"Cloud Gateway","count":0,"status":"error","message":"Cloud Gateways with error"}]},"cgwDeviceStatus":{"name":"Cloud Gateway Device","count":0,"unreachableCount":0,"statusList":[{"name":"Cloud Gateway Device","count":0,"status":"normal","message":"Cloud Gateway devices"},{"name":"Cloud Gateway Device","count":0,"status":"error","message":"Cloud Gateway devices with errors"}]},"cgwSitesStatus":{"name":"Cloud Gateway Sites","count":0,"statusList":[{"name":"Cloud Gateway Sites","count":0,"status":"error","message":"Cloud Gateway Sites with error"},{"name":"Cloud Gateway Sites","count":0,"status":"warning","message":"Cloud Gateway Sites with warning"},{"name":"Cloud Gateway Sites","count":0,"status":"normal","message":"Cloud Gateway Sites"}]},"cloudGatewaySolution":"tgw_tvpc","numAccounts":0,"numVpns":0,"numTags":0,"numVpcs":0,"numTunnels":0,"cgwDeviceSiteIds":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/multicloud/{cloudType}/config-group/{config-group-id}/topology":{"get":{"tags":["MultiCloud - General"],"summary":"Get current Multicloud MultiCloud topology for the Config Group.","description":"API to retrieve current Multicloud MultiCloud topology for the Config Group.","operationId":"getMultiCloudConfigGroupTopology","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string"}},{"name":"config-group-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"MultiCloud Config-Group Topology Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["MultiCloud - General"],"summary":"Update Multicloud topology for the Config Group.","description":"API to update current MultiCloud topology for the Config Group.","operationId":"updateMultiCloudConfigGroupTopology","parameters":[{"name":"cloudType","in":"path","required":true,"schema":{"type":"string"}},{"name":"config-group-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"MultiCloud Config-Group Topology Response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/network/connectionssummary":{"get":{"tags":["Device - Network"],"description":"Retrieve vManage control status","operationId":"getVmanageControlStatus","parameters":[{"name":"isCached","in":"query","description":"Is cached flag","schema":{"type":"boolean","default":false}},{"name":"vpnId","in":"query","description":"VPN Id","schema":{"type":"array","items":{"$ref":"#/components/schemas/VPNID"}}},{"name":"site-id","in":"query","description":"Optional site ID to filter devices","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage control status":{"description":"vManage control status","value":{"data":[{"name":"vSmart","count":2,"detailsURL":"/dataservice/device/reachable?personality=vsmart","status":"error","statusList":[{"name":"vSmart","status":"error","message":"Number of devices down","detailsURL":"/dataservice/device/unreachable?personality=vsmart","count":0}]},{"name":"WAN Edge","count":5,"detailsURL":"/dataservice/device/reachable?personality=vedge","status":"error","statusList":[{"name":"vEdge","status":"error","message":"Number of devices down","detailsURL":"/dataservice/device/unreachable?personality=vedge","count":0}]},{"name":"vBond","count":1,"detailsURL":"/dataservice/device/reachable?personality=vbond","status":"error","statusList":[{"name":"vBond","status":"error","message":"Number of devices down","detailsURL":"/dataservice/device/unreachable?personality=vbond","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,RBAC VPN-read"}},"/network/issues/rebootcount":{"get":{"tags":["Device - Network"],"description":"Retrieve reboot count","operationId":"getRebootCount","parameters":[{"name":"isCached","in":"query","description":"Is cached flag","required":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Reboot count":{"description":"Reboot count","value":{"data":[{"type":"Reboot count","name":"Reboot","showTitle":false,"count":3,"detailView":"dialog","detailsURL":"dataservice/device/reboothistory/details","status":"error"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/network/issues/summary":{"get":{"tags":["Device - Network"],"description":"Retrieve network issues summary","operationId":"getNetworkIssuesSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network issues":{"description":"Network issues","value":{"data":[{"type":"Status summary","name":"Status summary","showTitle":false,"count":3,"detailView":"dialog","statusList":[{"status":"Crashes","name":"Crashes","detailView":"dialog","detailsURL":"dataservice/device/crashlog/details","color":"fa7c7d","icon":"images/device/device-error.png","count":0},{"status":"Reboots","name":"Reboots","detailView":"dialog","detailsURL":"dataservice/device/reboothistory/details","color":"f2ce60","icon":"images/device/device-warning.png","count":3},{"status":"Hardware errors","name":"Hardware errors","detailView":"dialog","detailsURL":"dataservice/device/hardware/errors","color":"f2ce60","icon":"images/device/device-warning.png","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,System-read"}},"/network/status":{"get":{"tags":["Device - Network"],"description":"Retrieve network status summary","operationId":"getNetworkStatusSummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Network status":{"description":"Network status","value":{"header":{"generatedOn":1635483849920},"data":[{"type":"vSmart","name":"vSmart","image":"images/vsmart.png","count":3,"detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart","statusList":[{"status":"error","name":"Error","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=error","color":"fa7c7d","icon":"images/device/device-error.png","count":0},{"status":"warning","name":"Warning","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=warning","color":"f2ce60","icon":"images/device/device-warning.png","count":0},{"status":"normal","name":"Normal","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=normal","color":"b0e276","icon":"images/device/device-normal.png","count":3},{"status":"new","name":"Discovered device","detailView":"dialog","detailsURL":"/dataservice/device?personality=vsmart&status=new","color":"7c8afa","icon":"images/device/device-new.png","count":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,System-read"}},"/networkdesign":{"get":{"tags":["Configuration - Network Design"],"description":"Get existing network design","operationId":"getNetworkDesign","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design":{"description":"Network design","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"},"put":{"tags":["Configuration - Network Design"],"description":"Edit network segment","operationId":"editNetworkDesign","parameters":[{"name":"id","in":"query","description":"Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network design payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design template":{"description":"Network design template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write,Device Inventory > Edge-write"},"post":{"tags":["Configuration - Network Design"],"description":"Create network design","operationId":"createNetworkDesign","requestBody":{"description":"Network design payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"User":{"description":"User","value":{"dc":[{"name":"DC4","segments":["c952c18b-30b3-4f0b-b985-494693d7adfb"],"deviceProfiles":[{"deviceProfileName":"ASR1001","deviceModel":"vedge-ASR-1001-X","deviceTemplateID":"","deviceProfileId":"","circuits":["07dce48b-3c7d-46c0-ac91-36f0d64d61e7"]}]}],"showDeviceProfileHelpText":true,"globalParameters":[{"templateType":"aaa","gTemplateClass":"vedge","isUsed":false},{"templateType":"cisco_snmp","gTemplateClass":"cedge","isUsed":false},{"templateType":"omp-vedge","gTemplateClass":"vedge","isUsed":false},{"templateType":"banner","gTemplateClass":"vedge","isUsed":false},{"templateType":"ntp","gTemplateClass":"vedge","isUsed":false},{"templateType":"snmp","gTemplateClass":"vedge","isUsed":false},{"templateType":"cisco_bfd","gTemplateClass":"cedge","isUsed":false},{"templateType":"cisco_ntp","gTemplateClass":"cedge","isUsed":false},{"templateType":"cedge_global","gTemplateClass":"cedge","isUsed":false},{"templateType":"cisco_logging","gTemplateClass":"cedge","isUsed":false},{"templateType":"bfd-vedge","gTemplateClass":"vedge","isUsed":false},{"templateType":"cedge_aaa","gTemplateClass":"cedge","isUsed":false},{"templateType":"logging","gTemplateClass":"vedge","isUsed":false},{"templateType":"cisco_omp","gTemplateClass":"cedge","isUsed":false},{"templateType":"cisco_banner","gTemplateClass":"cedge","isUsed":false}],"customizedProfiles":[]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"id":"07c1e0a1-d28a-4372-b819-0f1ab5fc8e39"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write"}},"/networkdesign/attachment":{"post":{"tags":["Configuration - Network Design"],"description":"Attach network design","operationId":"pushNetworkDesign","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/networkdesign/circuit":{"get":{"tags":["Configuration - Circuits"],"description":"Get network circuits","operationId":"getCircuits","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuits":{"description":"Network circuits","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"post":{"tags":["Configuration - Circuits"],"description":"Create network circuits","operationId":"createCircuit","requestBody":{"description":"Network circuit","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuit":{"description":"Network circuit","value":{"type":"private","color":"biz-internet"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network circuit Id":{"description":"Network circuit Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/networkdesign/circuit/{id}":{"delete":{"tags":["Configuration - Circuits"],"description":"Delete network circuits","operationId":"deleteCircuit","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/networkdesign/global/parameters":{"get":{"tags":["Configuration - Network Design"],"description":"Get global parameter templates","operationId":"getGlobalParameters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Global parameters":{"description":"Global parameters","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/global/template/{templateId}":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Get global template","operationId":"getGlobalTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design template":{"description":"Network design template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"},"put":{"tags":["Configuration - Network Design Templates"],"description":"Edit global template","operationId":"editGlobalTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network design template":{"description":"Network design template"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/networkdesign/lock/edit":{"post":{"tags":["Configuration - Network Design"],"description":"Acquire edit lock","operationId":"acquireEditLock","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Lock Id":{"description":"Lock Id","value":{"id":"nd_edit-96c1ff5a-44fa-4316-ad15-cc820347f7d3"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write"}},"/networkdesign/mytest/{name}":{"get":{"tags":["Configuration - Network Design"],"description":"Get all device templates for this feature template","operationId":"runMyTest","parameters":[{"name":"name","in":"path","description":"Test bane","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/attachment/{profileId}":{"post":{"tags":["Configuration - Network Design"],"description":"Attach to device profile","operationId":"pushDeviceProfileTemplate","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/networkdesign/profile/feature":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Generate device profile template list","operationId":"getDeviceProfileFeatureTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"}},"/networkdesign/profile/lock/{profileId}":{"post":{"tags":["Configuration - Network Design"],"description":"Get the service profile config for a given device profile id","operationId":"acquireAttachLock","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/networkdesign/profile/status":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration status","operationId":"getDeviceProfileConfigStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config status":{"description":"Device config status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/status/{profileId}":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration status by profile Id","operationId":"getDeviceProfileConfigStatusByProfileId","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config status":{"description":"Device config status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/task/count":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration task count","operationId":"getDeviceProfileTaskCount","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config task count":{"description":"Device config task count","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/task/status":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration task status","operationId":"getDeviceProfileTaskStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config task status":{"description":"Device config task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/task/status/{profileId}":{"get":{"tags":["Configuration - Network Design"],"description":"Get device profile configuration status by profile Id","operationId":"getDeviceProfileTaskStatusByProfileId","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config task status":{"description":"Device config task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/template":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Generate profile template list","operationId":"generateProfileTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/networkdesign/profile/template/{templateId}":{"get":{"tags":["Configuration - Network Design Templates"],"description":"Get device profile template","operationId":"getDeviceProfileTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device profile template":{"description":"Device profile template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"},"put":{"tags":["Configuration - Network Design Templates"],"description":"Edit device profile template","operationId":"editDeviceProfileTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device profile template":{"description":"Device profile template"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/networkdesign/serviceProfileConfig/{profileId}":{"get":{"tags":["Configuration - Network Design"],"description":"Get the service profile config for a given device profile id","operationId":"getServiceProfileConfig","parameters":[{"name":"profileId","in":"path","description":"Device profile Id","required":true,"schema":{"type":"string"}},{"name":"deviceModel","in":"query","description":"Device model","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device profile":{"description":"Device profile","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/notifications/rule":{"put":{"tags":["Monitoring - Alarms Notification"],"description":"Update notification rule","operationId":"updateNotificationRule","parameters":[{"name":"ruleId","in":"query","description":"Rule Id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Notification rule","content":{"application/json":{"schema":{"type":"object"},"examples":{"Notification rule":{"description":"Notification rule","value":{"notificationRuleName":"testwebhook","severity":"Medium","alarmName":"BFD_Node_Up","accountDetails":"noreply@cisco.com","webHookEnabled":true,"webhookUsername":"admin","webhookPassword":"admin","webhookUrl":"https://localhost:8444","updatedBy":"admin","devicesAttached":"1712133e-0246-4281-8152-3317b796d2bc","emailThreshold":5,"accountDetailsArray":["noreply@cisco.com"]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"},"post":{"tags":["Monitoring - Alarms Notification"],"description":"Add notification rule","operationId":"createNotificationRule","requestBody":{"description":"Notification rule","content":{"application/json":{"schema":{"type":"object"},"examples":{"Notification rule":{"description":"Notification rule","value":{"notificationRuleName":"testwebhook","severity":"Medium","alarmName":"BFD_Node_Up","accountDetails":"noreply@cisco.com","webHookEnabled":true,"webhookUsername":"admin","webhookPassword":"admin","webhookUrl":"https://localhost:8444","updatedBy":"admin","devicesAttached":"1712133e-0246-4281-8152-3317b796d2bc","emailThreshold":5,"accountDetailsArray":["noreply@cisco.com"]}}}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object"},"examples":{"Notification rule":{"description":"Notification rule","value":"{\n \"accountDetails\": \"noreply@cisco.com\",\n \"accountDetailsArray\": [\n \"noreply@cisco.com\"\n ]\n \"alarmName\": \"BFD_Node_Up\",\n \"devicesAttached\": \"1712133e-0246-4281-8152-3317b796d2bc\",\n \"emailEnabled\": true,\n \"emailThreshold\": 5,\n \"notificationRuleName\": \"testwebhook\",\n \"severity\": \"Medium\",\n \"updatedBy\": \"admin\",\n \"webHookEnabled\": true,\n \"webhookPassword\": \"admin\",\n \"webhookUrl\": \"https://localhost:8444\",\n \"webhookUsername\": \"admin\",\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/notifications/rules":{"get":{"tags":["Monitoring - Alarms Notification"],"description":"Get all rules or specific notification rule by its Id ","operationId":"getNotificationRule","parameters":[{"name":"ruleId","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsRulesResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read"},"delete":{"tags":["Monitoring - Alarms Notification"],"description":"Delete notification rule","operationId":"deleteNotificationRule","parameters":[{"name":"ruleId","in":"query","description":"Rule Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/onboard/delete-devices":{"post":{"summary":"Delete Manual Onboard Device details","description":"Delete Manual Onboard Device details","operationId":"deleteDevices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDetails"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/onboard/details":{"post":{"summary":"Add Manual Onboard Device details","description":"Add Manual Onboard Device details","operationId":"addDevices","requestBody":{"description":"On board Device details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceDetailsData"}}},"required":true},"responses":{"201":{"description":"item created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing item already exists"}}}},"/onboard/devices":{"get":{"summary":"GET Manual Onboard Device details","description":"GET Manual Onboard Device details","operationId":"getDevices","parameters":[{"name":"status","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Details"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"summary":"Manual Onboard added Device details","description":"Manual Onboard added Device details","operationId":"manualOnboardDevices","requestBody":{"description":"On board Devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceDetailsData"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"parentTaskId":"sd_routing_device_onboard-6f1fafdf-3389-457e-b6a6-f756f1644efa"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/onboard/supportedlist":{"post":{"summary":"Manual Onboard Supported Device features","description":"Manual Onboard Supported Device features","operationId":"getSupportedFeatures","requestBody":{"description":"Manual Onboard Supported Device","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportedResponse"}}}},"201":{"description":"item created"},"400":{"description":"invalid input, object invalid"},"409":{"description":"an existing item already exists"}}}},"/opentaccase/authcode":{"get":{"tags":["Tools - TAC Cases"],"description":"Gets Access Token for SSO Logjn","operationId":"oauthAccess","parameters":[{"name":"code","in":"query","schema":{"type":"string"}},{"name":"redirect","in":"query","schema":{"type":"string"}},{"name":"isRefreshNeeded","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Access Token":{"description":"Access Token","value":{"access_token":"emQHZjOpma4gfco2c14BShVrdAqQ","refresh_token":"6cGDKZhHbYRR1ySrVpeKVmtIBSJifPopC8k5NeXVRW","id_token":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjJNc1VCbzE3Rnl4QVpMUVhGVHpqQVdoX2htcyJ9.eyJzdWIiOiJzaG9hYmFzdSIsImF1ZCI6InZtYW5hZ2Vfc2NtX2NsaWVudCIsImp0aSI6IlNKa1pKYWNsNkE4SVJ6UlBOTTFNbkMiLCJpc3MiOiJodHRwczovL2Nsb3Vkc3NvLXRlc3QuY2lzY28uY29tIiwiaWF0IjoxNjQ5ODM1ODcyLCJleHAiOjE2NDk4MzYxNzIsInBpLnNyaSI6Ikp4N1dJcmp4U1hDdFJuZ0hiT2tQRzhyV0MtYy4uVm45ZyIsImFjciI6InN0ZG5vbWZhIn0.IErZIsHsytpseCO1ReE-Y1i37bST3NPDnbHRiBInO8xhM6L0cbb7f7OhvWnKTSTaFQ_n-qDcG9iqCPZsNBGVX_e88L48S39QTn8OKndNfOmbmqZwkl5chno_6zUgXK-TsVWBKov3jEH2tC0TWRApIl0q9JGXkbrIzWh0qDnEhdk0aMtQf0WyhYvxAjR6W5ErzcqvZOiYBcWcfL4oRzr8wf2kULv1Z9V69aKIucA_Sxs3HflgamqzUaRVafeJW2rtJcnM4hHVMRZ5rjRtVj7KJz1xiZs9AyVuBceaF_XFEmzLrHiEbeNfPdCX0DVZl39uJNO9Z0Fe9wdj3Kq-TEa-VQ","token_type":"Bearer","expires_in":3599}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Tools-write"}},"/opentaccase/getClientID":{"get":{"tags":["Tools - TAC Cases"],"description":"Gets vManage Client ID","operationId":"getClientID","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Access Token":{"description":"Access Token","value":"{ client_id: xxxxxxxxx}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Tools-write"}},"/opentaccase/scmwidget/{var}":{"get":{"tags":["Tools - TAC Cases"],"description":"Proxy API for SCM Widget","operationId":"getCall","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"banner.json (Files needed by scm to load widget )":{"description":"banner.json (Files needed by scm to load widget )","value":{"statusCode":"SUCCESS","webexCategoriesList":[{"categoryHeader":"Meetings","category":"Joining a meeting","techId":"81","techName":"Cloud and Hybrid Products","subTechId":"3604","subTechName":"Webex joining a meeting","problemCodeDescription":"Configuration Assistance","problemCode":"CONFIG_ASSISTANCE","labelKey":"webexcategory.joiningameeting.tooltip","customerActivity":"Configuration","containerType":"W","type":"webex","enableVA":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Tools-write"},"post":{"tags":["Tools - TAC Cases"],"description":"Prxoy API for SCM Widget","operationId":"postCall","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"getAuthCodeUrl.json (Files needed by scm to load widget )":{"description":"getAuthCodeUrl.json (Files needed by scm to load widget )","value":"{CSRFTOKEN: \"1da3fee1-18c9-4cfd-a8ff-8fe28aafbbd7\",\napixAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=48cvgdjcuf72je6x37ztbv52&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fcase%2F\",\nlogoutURL: \"https://www-stage.cisco.com/autho/logout.html\",\nmaxAppReload: 5 ,\nmuleAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=f7371b79ebeb4c0f8a5a0052120c2efa&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fmule\",\nrmaAuthCodeURL: \"https://cloudsso-test.cisco.com/as/authorization.oauth2?client_id=b69k7tfhs45wf59yfpcdu98c&response_type=code&redirect_uri=https%3A%2F%2F172.18.47.167%2Fauthcode%2Frmaapi\",\nstatus: \"SUCCESS\",\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Tools-write"},"delete":{"tags":["Tools - TAC Cases"],"description":"Proxy API for SCM Widget","operationId":"deleteCall","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"banner.json (Files needed by scm to load widget )":{"description":"banner.json (Files needed by scm to load widget )","value":"{\"clientTrxId\":\"SCM-1650876738048-shoabasu\",\"errorMessages\":null,\"responseOut\":\"2022-04-25T08:52:19.369Z\",\"requestId\":\"02e8c630-c475-11ec-a61b-005056bc2cda\",\"recordCount\":1,\"\"responseDetails\":{\"draftNumber\":\"9010540440\"},\"messageId\":null,\"eventLog\":null,\"eventResult\":null,\"statusCode\":\"SUCCESS\"}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Tools-write"}},"/partner":{"get":{"tags":["Partner - Registration"],"description":"Get all NMS partners","operationId":"getPartners","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerListRes"},"examples":{"Partners":{"description":"Partners","value":[{"name":"DNAC-test","partnerId":"dnac-test","type":"dnac","id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5","description":"dnac-test","owner":"admin","registrationDate":"1632900123277","devicesAttached":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"}},"/partner/aci/policy":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get ACI definitions","operationId":"getACIDefinitions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACI policy":{"description":"ACI policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"}},"/partner/aci/policy/dscpmapping/{partnerId}":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get DSCP policy","operationId":"getDscpMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"DSCP policy":{"description":"DSCP policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"},"post":{"tags":["Partner - ACI Policy Builder"],"description":"Create an ACI definition entry","operationId":"createDscpMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"ACI definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACI definition":{"description":"ACI definition","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Action Id":{"description":"Action Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write"},"delete":{"tags":["Partner - ACI Policy Builder"],"description":"Delete DSCP mapping","operationId":"deleteDscpMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Action Id":{"description":"Action Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write"}},"/partner/aci/policy/events/{partnerId}":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get ACI events","operationId":"getEvents_1","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}},{"name":"starttime","in":"query","description":"Start time","schema":{"type":"integer","format":"int64"}},{"name":"endtime","in":"query","description":"End time","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"ACI events":{"description":"ACI events","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"}},"/partner/aci/policy/prefixmapping/{partnerId}":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get prefix mapping","operationId":"getDataPrefixMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Prefix mapping":{"description":"Prefix mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-writeAppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"},"post":{"tags":["Partner - ACI Policy Builder"],"description":"Create data prefix mapping","operationId":"setDataPrefixMappings","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Prefix definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Prefix definition":{"description":"Prefix definition","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Action Id":{"description":"Action Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,AppRoute Policy-write,Traffic Data Policy-write"}},"/partner/aci/policy/sequences":{"get":{"tags":["Partner - ACI Policy Builder"],"description":"Get data prefix sequence","operationId":"getDataPrefixSequences","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Data prefix sequence":{"description":"Data prefix sequence","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,AppRoute Policy-read,AppRoute Policy-write,Traffic Data Policy-read,Traffic Data Policy-write"}},"/partner/dnac/sda/config/{partnerId}":{"post":{"tags":["Partner - DNAC SDA API"],"description":"Create SDA enabled device","operationId":"createSDAConfig","parameters":[{"name":"partnerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device SDA configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaConfigRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaDeviceConfigRes"},"examples":{"Device template push Id":{"description":"Device template push Id","value":{"id":"push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Integration Management-write"}},"/partner/dnac/sda/device/{partnerId}":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get SDA enabled devices","operationId":"getSDAEnabledDevices","parameters":[{"name":"partnerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaDevicesRes"},"examples":{"Devices list":{"description":"Devices list","value":{"header":{"generatedOn":1649645769219},"data":[{"uuid":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","deviceId":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","reachability":"reachable","status":"normal","personality":"vedge","device-type":"normal","device-model":"C8000v","version":"17.06.01.0.1422","site-id":"500","platform":"x86_64","device-os":"next","state":"green","chassis-serial-number":"SSI130300YK","host-name":"vm5","system-ip":"172.16.255.15","serialNumber":"12345712","templateStatus":"Success","validity":"valid","configuredAaaUser":["admin"],"wanInterfaces":["GigabitEthernet1"],"discoveredDeviceInterfaces":["GigabitEthernet8","GigabitEthernet1","GigabitEthernet2"],"registrationDate":"1632900123277","devicesAttached":0,"loopback":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write"}},"/partner/dnac/sda/device/{partnerId}/{uuid}":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get SDA enabled devices detail","operationId":"getDeviceDetails","parameters":[{"name":"partnerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaDevicesRes"},"examples":{"Device detail list":{"description":"Device detail list","value":{"header":{"generatedOn":1649645769219},"data":[{"uuid":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","deviceId":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f","reachability":"reachable","status":"normal","personality":"vedge","device-type":"normal","device-model":"C8000v","version":"17.06.01.0.1422","site-id":"500","platform":"x86_64","device-os":"next","state":"green","chassis-serial-number":"SSI130300YK","host-name":"vm5","system-ip":"172.16.255.15","serialNumber":"12345712","templateStatus":"Success","validity":"valid","configuredAaaUser":["admin"],"wanInterfaces":["GigabitEthernet1"],"discoveredDeviceInterfaces":["GigabitEthernet8","GigabitEthernet1","GigabitEthernet2"],"registrationDate":"1632900123277","devicesAttached":0,"loopback":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write"}},"/partner/dnac/sda/netconfconfig/{partnerId}":{"post":{"tags":["Partner - DNAC SDA API"],"description":"Create SDA enabled device from Netconf","operationId":"createSDAConfigFromNetconf","parameters":[{"name":"partnerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device SDA configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaConfigRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaDeviceConfigRes"},"examples":{"Device template push Id":{"description":"Device template push Id","value":{"id":"push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Integration Management-write"}},"/partner/dnac/sda/site/{partnerId}":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get SDA Sites for Partner","operationId":"getSitesForPartner","parameters":[{"name":"partnerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdaSitesRes"},"examples":{"Sites":{"description":"Sites","value":{"header":{"generatedOn":1649645769219},"data":[{"partnerId":"dnac-test","sites":["400"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write,Integration Management-read,Integration Management-write"}},"/partner/dnac/sda/vpn":{"get":{"tags":["Partner - DNAC SDA API"],"description":"Get Overlay VPN list","operationId":"getOverlayVPNList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnListRes"},"examples":{"VPN list":{"description":"VPN list","value":{"header":{"generatedOn":1649645769219},"data":[{"vpnId":"33","vpnType":"configuredVPN"},{"vpnId":"0","vpnType":"vmanageVPN"},{"vpnId":"512","vpnType":"vmanageVPN"},{"vpnId":"65528","vpnType":"vmanageVPN"},{"vpnId":"Mgmt-intf","vpnType":"vmanageVPN"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"DNAC SDA-read,DNAC SDA-write,Integration Management-read,Integration Management-write"}},"/partner/vpn":{"get":{"tags":["Partner - Registration"],"description":"Get all VPNs","operationId":"getVPNList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnListRes"},"examples":{"VPN list":{"description":"VPN list","value":{"header":{"generatedOn":1649645769219},"data":[{"vpnId":"1","vpnType":"configuredVPN"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"}},"/partner/wcm/netconf/{nmsId}":{"post":{"tags":["Partner - WCM Configs"],"description":"Push device configs","operationId":"pushNetconfConfigs","parameters":[{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Netconf configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WcmNetconfConfigRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WcmNetconfConfigRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Integration Management-write"}},"/partner/{partnerType}":{"get":{"tags":["Partner - Registration"],"description":"Get NMS partners by partner type","operationId":"getPartnersByPartnerType","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerListRes"},"examples":{"Partners":{"description":"Partners","value":[{"name":"DNAC-test","partnerId":"dnac-test","type":"dnac","id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5","description":"dnac-test","owner":"admin","registrationDate":"1632900123277","devicesAttached":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"},"post":{"tags":["Partner - Registration"],"description":"Register NMS partner","operationId":"registerPartner","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterPartnerRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterPartnerRes"},"examples":{"Partner Id":{"description":"Partner Id","value":{"id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/partner/{partnerType}/map/{nmsId}":{"get":{"tags":["Partner - Registration"],"description":"List mapped devices for the partner","operationId":"getPartnerDevices","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerDevicesRes"},"examples":{"Devices":{"description":"Devices","value":"{\"devices\": [{ \"uuid\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"deviceId\": \"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f\", \"reachability\": \"reachable\", \"status\": \"normal\", \"personality\": \"vedge\", \"device-type\": \"normal\", \"device-model\": \"C8000v\", \"version\": \"17.06.01.0.1422\", \"site-id\": \"500\", \"platform\": \"x86_64\", \"device-os\": \"next\", \"state\": \"green\", \"chassis-serial-number\": \"SSI130300YK\", \"host-name\": \"vm5\", \"system-ip\": \"172.16.255.15\", \"serialNumber\": \"12345712\", \"templateStatus\": \"Success\", \"validity\": \"valid\", \"configuredAaaUser\": [\"admin\"], \"wanInterfaces\": [\"GigabitEthernet1\"], \"discoveredDeviceInterfaces\": [\"GigabitEthernet8\",\"GigabitEthernet1\"\"GigabitEthernet2\"], \"registrationDate\": \"1632900123277\", \"devicesAttached\": 0, \"loopback\": []}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write,Policy Configuration-write"},"post":{"tags":["Partner - Registration"],"description":"Map devices for the partner","operationId":"mapDevices","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"List of devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapDevicesRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"},"delete":{"tags":["Partner - Registration"],"description":"Unmap all devices for the partner","operationId":"unmapDevices","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/partner/{partnerType}/unmap/{nmsId}":{"post":{"tags":["Partner - Registration"],"description":"Unmap a set of devices for the partner","operationId":"deleteDeviceMapping","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"List of devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapDevicesRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/partner/{partnerType}/{nmsId}":{"get":{"tags":["Partner - Registration"],"description":"Get NMS partners by partner type and Id","operationId":"getPartner","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerRes"},"examples":{"Partners":{"description":"Partners","value":[{"name":"DNAC-test","partnerId":"dnac-test","type":"dnac","id":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5","description":"dnac-test","owner":"admin","registrationDate":"1632900123277","devicesAttached":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-read,Integration Management-write"},"put":{"tags":["Partner - Registration"],"description":"Update NMS partner details","operationId":"updatePartner","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePartnerRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"},"delete":{"tags":["Partner - Registration"],"description":"Delete NMS partner","operationId":"deletePartner","parameters":[{"name":"partnerType","in":"path","required":true,"schema":{"type":"string"}},{"name":"nmsId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"},"examples":{"Status":{"description":"Status","value":{"status":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Integration Management-write"}},"/policy/wani/recommendation/process":{"post":{"tags":["Wani Recommendations"],"summary":"Apply recommendation to a centralized policy","description":"Applies recommendations to a centralized policy ","operationId":"applyWaniRecommendation","parameters":[{"name":"key","in":"query","description":"Key from vAnalytics to retrieve recommendation json","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRecommendationRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/refreshtoken/{regionBaseUri}/{clientId}":{"get":{"tags":["Monitoring - SecureX Integration"],"description":"Get Access Token for SecureX Ribbon","operationId":"getSecureXRefreshToken","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/resourcepool/resource/vpn":{"get":{"tags":["Resource - Pool"],"description":"Get tenant device vpn resource","operationId":"getResources","parameters":[{"name":"tenantId","in":"query","description":"Tenant Organization Name","required":true,"schema":{"type":"string"}},{"name":"tenantVpn","in":"query","description":"Tenant Vpn Number","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Resources":{"description":"Resources","value":{"resourcePoolDataType":"vpn","tenantId":"Tenant Organization Name","tenantVpn":2,"deviceVpn":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Resource - Pool"],"description":"Create Vpn resource pool and return tenant device vpn","operationId":"createResources","requestBody":{"description":"create resources from resource pool","content":{"application/json":{"schema":{"type":"object"},"examples":{"Resources":{"description":"Resources","value":"{\n\t\"resourcePoolDataType\": \"vpn\",\n\t\"tenantId\": \"Tenant Organization Name\",\n\t\"tenantVpn\": 2,\n} "}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Resources":{"description":"Resources","value":{"resourcePoolDataType":"vpn","tenantId":"Tenant Organization Name","tenantVpn":2,"deviceVpn":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Resource - Pool"],"description":"Delete tenant device vpn and release the resource","operationId":"deleteResources","parameters":[{"name":"tenantId","in":"query","description":"Tenant Organization Name","required":true,"schema":{"type":"string"}},{"name":"tenantVpn","in":"query","description":"Tenant Vpn Number","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/restore/import":{"post":{"tags":["Scheduled Backup Restore"],"description":"Submit a previously backed up file and import the data and apply it to the configuraion database","operationId":"importScheduledBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/restore/remoteimport":{"post":{"tags":["Scheduled Backup Restore"],"description":"Remote import backup from a remote URL and import the data and apply it to the configuraion database","operationId":"remoteImportBackup","requestBody":{"description":"ImportBackupInfo Payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"ImportBackupInfo Payload":{"description":"ImportBackupInfo Payload","value":"{\r\n \"importName\": \"import 20.15 vmanage release\",\r\n \"srcHost\": \"10.0.105.32\",\r\n \"description\": \"optional description here\",\r\n \"backupSrcUrl\": \"https://10.0.105.32:8443/scheduled/backupdata/ondemand_f34d0b2f-a079-40ce-b2f5-192d068bd136_070220-234236.tar.gz\",\r\n \"user\": \"admin\",\r\n \"password\": \"password\"\r\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/schedule/create":{"post":{"tags":["Scheduled Backup Restore"],"description":"create backup scheduler config-db and statstics database with startDateTime and persist to config-db","operationId":"scheduleBackup","requestBody":{"description":"schedule request information","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats setting":{"description":"Stats setting","value":"{\r\n \"scheduleName\": \"testScheduleName\",\r\n \"destination\": {\r\n \"backupDest\": \"local\",\r\n \"vmVersion\": \"20.15\",\r\n \"backupDir\": \"/backup\",\r\n \"backupTTLInDays\": 20,\r\n \"backupStorageInGB\": 30,\r\n \"numOfReplica\": 1\r\n },\r\n \"status\": \"ACTIVE\",\r\n \"startDateTime\": 1709032922321,\r\n \"endDateTime\": 1709464622321,\r\n \"backupDurationInHour\": 5,\r\n \"backup_storage\": 300,\r\n \"retryCount\": 3,\r\n \"numOfReplica\": 2\r\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/schedule/list":{"get":{"tags":["Scheduled Backup Restore"],"description":"Get a schedule record for backup by scheduler id","operationId":"listSchedules","parameters":[{"name":"limit","in":"query","description":"size","schema":{"type":"integer","format":"int64","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get backup schedule ":{"description":"Get backup schedule ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/schedule/{schedulerId}":{"get":{"tags":["Scheduled Backup Restore"],"description":"Get a schedule record for backup by scheduler id","operationId":"getScheduleRecordForBackup","parameters":[{"name":"schedulerId","in":"path","description":"scheduler id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Get backup schedule ":{"description":"Get backup schedule ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Scheduled Backup Restore"],"description":"Delete a schedule record for backup in vManage by scheduler id","operationId":"deleteSchedule","parameters":[{"name":"schedulerId","in":"path","description":"scheduler id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Delete backup scheduler job ":{"description":"Delete backup scheduler job ","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sdavc/cloudconnector":{"get":{"tags":["SD AVC Cloud Connector"],"description":"Get SD_AVC Cloud Connector Config","operationId":"getCloudConnector","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["SD AVC Cloud Connector"],"description":"Disable SD_AVC Cloud Connector","operationId":"disableCloudConnector","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["SD AVC Cloud Connector"],"description":"Enable SD_AVC Cloud Connector","operationId":"enableCloudConnector","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sdavc/cloudconnector/status":{"get":{"tags":["SD AVC Cloud Connector"],"description":"Get SD_AVC Cloud Connector Status","operationId":"getCloudConnectorStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sdavc/customapps":{"get":{"tags":["System - Container"],"description":"Displays the user-defined applications","operationId":"getCustomApp","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Custom applications":{"description":"Custom applications","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sdavc/protocol-pack":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get all protocol packs details","operationId":"getAllProtocolPacks","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":[{"file-name":"pp-adv-cat8k-179.1a-46-64.0.0.pack","version":"64.0.0","device-version":"179.1a","nbar-engine-version":"46","device-model":"cat8k","license-type":"adv","is-latest":false,"is-upload-confirmed-by-user":true,"numeric-version":64,"uploaded-by-user-name":"system-uploaded","system-pack-type":"base","upload-source":"system-uploaded","last-updated-time":1706824339984,"created-time":1706293228793,"upload-confirmed-time":1706293228847},{"file-name":"pp-adv-cat8k-1712.1a-49-68.0.0.pack","version":"68.0.0","device-version":"1712.1a","nbar-engine-version":"49","device-model":"cat8k","license-type":"adv","is-latest":true,"is-upload-confirmed-by-user":true,"numeric-version":68,"uploaded-by-user-name":"system-uploaded","system-pack-type":"default","upload-source":"system-uploaded","last-updated-time":1706824341120,"created-time":1706293230093,"upload-confirmed-time":1706293230158},{"file-name":"pp-adv-cat8k-179.1a-46-68.0.0.pack","version":"68.0.0","device-version":"179.1a","nbar-engine-version":"46","device-model":"cat8k","license-type":"adv","is-latest":true,"is-upload-confirmed-by-user":true,"numeric-version":68,"uploaded-by-user-name":"system-uploaded","system-pack-type":"default","upload-source":"system-uploaded","last-updated-time":1706824343168,"created-time":1706293231384,"upload-confirmed-time":1706293231430}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}}},"/sdavc/protocol-pack/base":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get all base protocol pack details","operationId":"getBaseSystemPack","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":[{"file-name":"pp-adv-cat8k-179.1a-46-64.0.0.pack","version":"64.0.0","device-version":"179.1a","nbar-engine-version":"46","device-model":"cat8k","license-type":"adv","is-latest":false,"is-upload-confirmed-by-user":true,"numeric-version":64,"uploaded-by-user-name":"system-uploaded","system-pack-type":"base","upload-source":"system-uploaded","last-updated-time":1706824339984,"created-time":1706293228793,"upload-confirmed-time":1706293228847}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0006","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/all-devices":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get all device compliance details","operationId":"getAllSDAVCDevice","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"devices":[{"uuid":"C8K-3657252c-96a4-4e4c-8860-270dec1f07d7","hostName":"vm1","siteId":"100","systemIp":"172.16.255.11","deviceModel":"vedge-C8000V","softwareVersion":"17.12.03.0.3419","currentProtocolPackVersion":68,"currentProtocolPackName":"pp-adv-cat8k-1712.1a-49-68.0.0.pack","lastUpgradeStatus":"Success","lastUpgradeStatusMessage":null,"isCompatible":true,"isAVCEnabled":true,"isDeviceReachable":true}],"count":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}}},"/sdavc/protocol-pack/compliance/custom-application":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get All Custom Applications","operationId":"getCustomApplicationList","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"applications":[{"applicationName":"custom-app-1","applicationNumericId":"2502","applicationSDAVCId":null},{"applicationName":"custom-app-2","applicationNumericId":"3547","applicationSDAVCId":null},{"applicationName":"custom-app-3","applicationNumericId":"3658","applicationSDAVCId":null}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0014","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/device/noncompliant":{"post":{"tags":["Protocol Pack Compliance"],"description":"Get all non compliant devices for given protocol pack and selected device or entire network","operationId":"getNonCompliantDevicesForProtocolPack","requestBody":{"description":"Request Payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompliantDeviceRequest"},"examples":{"All Devices and selective protocol pack":{"description":"All Devices and selective protocol pack","value":{"devices":[],"protocolPackName":"pp-adv-cat8k-1712.1a-49-68.0.0.pack"}},"All Devices and Default Protocol Pack":{"description":"All Devices and Default Protocol Pack","value":{"devices":[],"protocolPackName":null}},"Selective Devices and Selective Protocol Pack":{"description":"Selective Devices and Selective Protocol Pack","value":{"devices":["172.16.255.11","172.16.255.12"],"protocolPackName":"pp-adv-cat8k-1712.1a-49-68.0.0.pack"}},"Selective Devices and Default Protocol Pack":{"description":"Selective Devices and Default Protocol Pack","value":{"devices":["172.16.255.11","172.16.255.12"],"protocolPackName":null}}}}},"required":true},"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"devices":[{"uuid":"C8K-3657252c-96a4-4e4c-8860-270dec1f07d7","hostName":"vm1","siteId":"100","systemIp":"172.16.255.11","deviceModel":"vedge-C8000V","softwareVersion":"17.12.03.0.3419","currentProtocolPackVersion":68,"currentProtocolPackName":"pp-adv-cat8k-1712.1a-49-68.0.0.pack","lastUpgradeStatus":"Success","lastUpgradeStatusMessage":null,"isCompatible":true,"isAVCEnabled":true,"isDeviceReachable":true}],"count":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0015","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/device/noncompliant/{protocolPackName}":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get all non compliant devices for given protocol pack","operationId":"getNonCompliantDevicesForProtocolPack_1","parameters":[{"name":"protocolPackName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"devices":[{"uuid":"C8K-3657252c-96a4-4e4c-8860-270dec1f07d7","hostName":"vm1","siteId":"100","systemIp":"172.16.255.11","deviceModel":"vedge-C8000V","softwareVersion":"17.12.03.0.3419","currentProtocolPackVersion":68,"currentProtocolPackName":"pp-adv-cat8k-1712.1a-49-68.0.0.pack","lastUpgradeStatus":"Success","lastUpgradeStatusMessage":null,"isCompatible":true,"isAVCEnabled":true,"isDeviceReachable":true}],"count":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0015","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/device/status/{uuid}":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get device compliance task status","operationId":"getDeviceComplianceStatus","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Scheduled Response":{"description":"Scheduled Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"scheduled","message":"Task scheduled"}},"In Progress Response":{"description":"In Progress Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"in_progress","message":"Task is in progress"}},"Success Response":{"description":"Success Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"success","message":"Success"}},"Failure Response":{"description":"Failure Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"failure","message":"Task Failed"}},"Not Started Response":{"description":"Not Started Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"not_started","message":"The task has not started yet"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0010","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/initiate-device-compliance":{"post":{"tags":["Protocol Pack Compliance"],"description":"Initiate device compliance task","operationId":"initiateDeviceCompliance","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"taskExtraKey":"vIPtela Inc Regression","uuid":"4840d575-25bf-4d05-9f44-017854e4457b","status":"scheduled","taskId":"sdavc_check_device_compliance-4840d575-25bf-4d05-9f44-017854e4457b","message":"Check Device Compliances initiated for : vIPtela Inc Regression","protocolPackName":"vIPtela Inc Regression"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0012","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/initiate-policy-compliance":{"post":{"tags":["Protocol Pack Compliance"],"description":"Initiate policy compliance task","operationId":"initiatePolicyCompliance","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"taskExtraKey":"68.0.0","uuid":"860f1d98-2ede-4ff4-ae84-f6192d1aa2ac","status":"scheduled","taskId":"sdavc_check_policy_compliance-860f1d98-2ede-4ff4-ae84-f6192d1aa2ac","message":"Check Policy Compliances initiated for : 68.0.0","protocolPackName":"pp-adv-cat8k-179.1a-46-68.0.0.pack","protocolPackVersion":"68.0.0","initial-task-delay-in-second":0}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0011","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/new-application/{deviceUUID}":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get New Application List for given Device UUID","operationId":"getNewApplicationList","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"applications":[{"applicationName":"ms-wudo","applicationNumericId":"1304","applicationSDAVCId":"13:1304"},{"applicationName":"cisco-thousandeyes","applicationNumericId":"1298","applicationSDAVCId":"13:1298"},{"applicationName":"kafka","applicationNumericId":"1297","applicationSDAVCId":"13:1297"},{"applicationName":"code42-services","applicationNumericId":"1301","applicationSDAVCId":"13:1301"},{"applicationName":"panasonic-ip-camera","applicationNumericId":"1299","applicationSDAVCId":"13:1299"},{"applicationName":"telegram","applicationNumericId":"1300","applicationSDAVCId":"13:1300"},{"applicationName":"mndp","applicationNumericId":"1308","applicationSDAVCId":"13:1308"},{"applicationName":"ms-intune","applicationNumericId":"1303","applicationSDAVCId":"13:1303"},{"applicationName":"ms-diagnostics","applicationNumericId":"1302","applicationSDAVCId":"13:1302"},{"applicationName":"discord","applicationNumericId":"1305","applicationSDAVCId":"13:1305"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0014","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/policy":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get all policy compliance details","operationId":"getCompliancePolicy","parameters":[{"name":"offset","in":"query","description":"Starting position of records","schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Total records to query after offset","schema":{"type":"integer","format":"int64"}},{"name":"protocolPackName","in":"query","description":"Protocol pack name","schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Scheduled Response":{"description":"Scheduled Response","value":{"data":[{"appList":{"id":"7304764c-7741-4336-8def-451b173a8f21","name":"app_fam","createdBy":"createdBy","version":"UX 2.0","type":"app-list"},"applications":[{"oldApplications":["google-services"],"newApplications":["google-translate","google-maps"]},{"oldApplications":["ms-wudo"],"newApplications":["ms-wudo-app-1"]},{"oldApplications":["http"],"newApplications":[""]},{"oldApplications":["https"],"newApplications":[""]}],"policy":[{"id":"c4feefed-ef30-4d1c-82f2-702b5bc174e4","name":"PG_bug","version":"UX 2.0"},{"id":"32f4c05c-d6db-4423-b7e1-cb9dcc87de5f","name":"PG2","version":"UX 2.0"}],"updatedAt":1706800337447}],"count":1}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0013","details":""}}}}}}}}}},"/sdavc/protocol-pack/compliance/policy/status/{uuid}":{"get":{"tags":["Protocol Pack Compliance"],"description":"Get policy compliance status","operationId":"getPolicyComplianceStatus","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Scheduled Response":{"description":"Scheduled Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"scheduled","message":"Task scheduled"}},"In Progress Response":{"description":"In Progress Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"in_progress","message":"Task is in progress"}},"Success Response":{"description":"Success Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"success","message":"Success"}},"Failure Response":{"description":"Failure Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"failure","message":"Task Failed"}},"Not Started Response":{"description":"Not Started Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"not_started","message":"The task has not started yet"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0009","details":""}}}}}}}}}},"/sdavc/protocol-pack/default":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get all default protocol pack details","operationId":"getDefaultSystemPack","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":[{"file-name":"pp-adv-cat8k-1712.1a-49-68.0.0.pack","version":"68.0.0","device-version":"1712.1a","nbar-engine-version":"49","device-model":"cat8k","license-type":"adv","is-latest":true,"is-upload-confirmed-by-user":true,"numeric-version":68,"uploaded-by-user-name":"system-uploaded","system-pack-type":"default","upload-source":"system-uploaded","last-updated-time":1706824341120,"created-time":1706293230093,"upload-confirmed-time":1706293230158},{"file-name":"pp-adv-cat8k-179.1a-46-68.0.0.pack","version":"68.0.0","device-version":"179.1a","nbar-engine-version":"46","device-model":"cat8k","license-type":"adv","is-latest":true,"is-upload-confirmed-by-user":true,"numeric-version":68,"uploaded-by-user-name":"system-uploaded","system-pack-type":"default","upload-source":"system-uploaded","last-updated-time":1706824343168,"created-time":1706293231384,"upload-confirmed-time":1706293231430}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0006","details":""}}}}}}}}}},"/sdavc/protocol-pack/latest":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get current latest protocol pack details","operationId":"getLatestSystemPack","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"file-name":"pp-adv-cat8k-179.1a-46-68.0.0.pack","version":"68.0.0","device-version":"179.1a","nbar-engine-version":"46","device-model":"cat8k","license-type":"adv","is-latest":true,"is-upload-confirmed-by-user":true,"numeric-version":68,"uploaded-by-user-name":"system-uploaded","system-pack-type":"default","upload-source":"system-uploaded","last-updated-time":1706824343168,"created-time":1706293231384,"upload-confirmed-time":1706293231430}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0006","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upgrade":{"post":{"tags":["Protocol Pack Maintenance"],"description":"Deploy protocol pack to devices","operationId":"upgradeProtocolPack","requestBody":{"description":"Request Payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProtocolPackUpgradeRequest"},"examples":{"Selected Devices, selective protocol pack, scheduled now":{"description":"Selected Devices, selective protocol pack, scheduled now","value":{"deviceSelectionType":"selected-devices","scheduleTime":0,"devices":["172.16.255.11"],"executionType":"now","protocolPacks":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackType":"selected-protocol-pack"}},"Selected Devices, default protocol pack, scheduled now":{"description":"Selected Devices, default protocol pack, scheduled now","value":{"deviceSelectionType":"selected-devices","scheduleTime":0,"devices":["172.16.255.11"],"executionType":"now","protocolPacks":[],"protocolPackType":"default-protocol-pack"}},"Selected Devices, built-in protocol pack, scheduled now":{"description":"Selected Devices, built-in protocol pack, scheduled now","value":{"deviceSelectionType":"selected-devices","scheduleTime":0,"devices":["172.16.255.11"],"executionType":"now","protocolPacks":[],"protocolPackType":"built-in-protocol-pack"}},"All Devices, selective protocol pack, scheduled now":{"description":"All Devices, selective protocol pack, scheduled now","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","protocolPacks":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackType":"selected-protocol-pack"}},"All Devices, default protocol pack, scheduled now":{"description":"All Devices, default protocol pack, scheduled now","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","protocolPacks":[],"protocolPackType":"default-protocol-pack"}},"All Devices, built-in protocol pack, scheduled now":{"description":"All Devices, built-in protocol pack, scheduled now","value":{"deviceSelectionType":"entire-network","scheduleTime":0,"devices":[],"executionType":"now","protocolPacks":[],"protocolPackType":"built-in-protocol-pack"}},"Scheduled Upgrade":{"description":"Scheduled Upgrade","value":{"deviceSelectionType":"entire-network","scheduleTime":1706803770000,"devices":[],"executionType":"later","protocolPacks":[],"protocolPackType":"default-protocol-pack"}}}}},"required":true},"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"taskExtraKey":"vIPtela Inc Regression","deployScheduleTime":0,"protocolPackName":["pp-adv-cat8k-1712.1a-49-68.0.0.pack"],"protocolPackNameSelectionType":"selected-protocol-pack","uuid":"436201f9-c701-4556-8404-2adcde645d3f","status":"scheduled","taskId":"sdavc_deploy_protocol_pack_on_device-436201f9-c701-4556-8404-2adcde645d3f","message":"Deploy Protocol Pack on Device initiated for : vIPtela Inc Regression","segmentName":"vIPtela Inc Regression"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0001","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upgrade/cancel":{"post":{"tags":["Protocol Pack Maintenance"],"description":"Cancel a Scheduled Deploy protocol pack job","operationId":"cancelScheduledDeployJob","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"success":true,"message":"Task cancelled successfully"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0007","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upgrade/status":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get active deploy job status","operationId":"getDeployJobStatus_1","responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Scheduled Response":{"description":"Scheduled Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"scheduled","message":"Task scheduled"}},"In Progress Response":{"description":"In Progress Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"in_progress","message":"Task is in progress"}},"Success Response":{"description":"Success Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"success","message":"Success"}},"Failure Response":{"description":"Failure Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"failure","message":"Task Failed"}},"Not Started Response":{"description":"Not Started Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"not_started","message":"The task has not started yet"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0008","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upgrade/status/{uuid}":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get upgrade status for given Task UUID","operationId":"getDeployJobStatus","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Scheduled Response":{"description":"Scheduled Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"scheduled","message":"Task scheduled"}},"In Progress Response":{"description":"In Progress Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"in_progress","message":"Task is in progress"}},"Success Response":{"description":"Success Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"success","message":"Success"}},"Failure Response":{"description":"Failure Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"failure","message":"Task Failed"}},"Not Started Response":{"description":"Not Started Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"not_started","message":"The task has not started yet"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0008","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upload":{"post":{"tags":["Protocol Pack Maintenance"],"description":"Upload protocol pack to SDAVC","operationId":"uploadProtocolPack","requestBody":{"description":"Protocol Pack File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ProtocolPackUploadRequest"}}},"required":true},"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Success Response":{"description":"Success Response","value":[{"taskExtraKey":"pp-adv-asr1k-176.1a-43-59.0.0.pack","uuid":"5ace81e7-e002-449e-9449-677a2afa6a26","status":"scheduled","taskId":"sdavc_upload_protocol_pack_to_sdavc-5ace81e7-e002-449e-9449-677a2afa6a26","message":"Upload Protocol Pack to SDAVC initiated for : pp-adv-asr1k-176.1a-43-59.0.0.pack","protocolPackName":"pp-adv-asr1k-176.1a-43-59.0.0.pack","actualUploadedFileName":"pp-adv-asr1k-176.1a-43-59.0.0.pack","systemPackType":"","device-compliance-status":{},"policy-compliance-status":{}}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0004","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upload/cancel/{uuid}":{"post":{"tags":["Protocol Pack Maintenance"],"description":"Cancel or discard an uploaded protocol pack","operationId":"cancelProtocolPackUpload","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"success":true,"message":"Protocol pack upload cancelled successfully"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0002","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upload/confirm/{uuid}":{"post":{"tags":["Protocol Pack Maintenance"],"description":"Confirm uploaded protocol pack","operationId":"confirmProtocolPackUpload","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Response":{"description":"Response","value":{"success":true,"message":"Protocol pack confirmed successfully"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0003","details":""}}}}}}}}}},"/sdavc/protocol-pack/maintenance/upload/status/{uuid}":{"get":{"tags":["Protocol Pack Maintenance"],"description":"Get protocol pack upload status","operationId":"getProtocolPackUploadStatus","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Response","content":{"application/json":{"examples":{"Scheduled Response":{"description":"Scheduled Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"scheduled","message":"Task scheduled"}},"In Progress Response":{"description":"In Progress Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"in_progress","message":"Task is in progress"}},"Success Response":{"description":"Success Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"success","message":"Success"}},"Failure Response":{"description":"Failure Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"failure","message":"Task Failed"}},"Not Started Response":{"description":"Not Started Response","value":{"uuid":"2f48cc13-a19e-4d62-8273-ea25896a6ecc","status":"not_started","message":"The task has not started yet"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error","content":{"application/json":{"examples":{"500 - Internal Error":{"description":"500 - Internal Error","value":{"error":{"message":"","code":"PP0005","details":""}}}}}}}}}},"/sdavc/task/{taskId}":{"post":{"tags":["System - Container"],"description":"Activate container","operationId":"activateContainer","parameters":[{"name":"taskId","in":"path","description":"Task Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Container task config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Container task config":{"description":"Container task config","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sdavc/test":{"post":{"tags":["System - Container"],"description":"Test SD_AVC load balancer","operationId":"testLoadBalancer","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/security/device/health":{"get":{"tags":["Monitoring - Security Policy"],"summary":"security device health","description":"Get security device health ","operationId":"getSecurityDeviceHealth","parameters":[{"name":"deviceIp","in":"query","description":"deviceIp - Device IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecurityDeviceHealth"}}}}},"400":{"description":"bad input parameter"}}}},"/security/policy/devicelist":{"get":{"tags":["Monitoring - Security Policy"],"summary":"security policy device list","description":"Get security policy device list ","operationId":"getSecurityPolicyDeviceList","responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyDeviceList"}}}}},"400":{"description":"bad input parameter"}}}},"/security/policy/fwall/device":{"post":{"tags":["Monitoring - Security Policy"],"summary":"firewall devices list","description":"Get firewall devices list ","operationId":"getPostFwallByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"firewall device query":{"description":"firewall device query","$ref":"#/components/examples/FwallDevice"}}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLists"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Security-read,Device Monitoring-read"}},"/security/policy/ips/device":{"post":{"tags":["Monitoring - Security Policy"],"summary":"ips alert devices list","description":"Get ips alert devices list ","operationId":"getPostIPSAlertByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"ips alert device query":{"description":"ips alert device query","$ref":"#/components/examples/IpsAlertDevice"}}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLists"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Security-read,Device Monitoring-read"}},"/security/policy/urlf/device":{"post":{"tags":["Monitoring - Security Policy"],"summary":"url filtering devices list","description":"Get url filtering devices list ","operationId":"getPostUrlFilteringByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"url filtering pass device query":{"description":"url filtering pass device query","$ref":"#/components/examples/URLFilteringPassDevice"},"url filtering block device query":{"description":"url filtering block device query","$ref":"#/components/examples/URLFilteringBlockDevice"},"url filtering exempt white/black list device query":{"description":"url filtering exempt white/black list device query","$ref":"#/components/examples/URLFilteringExemptWitBlkListDevice"},"amp device query":{"description":"amp device query","$ref":"#/components/examples/AMPDevice"}}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLists"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Security-read,Device Monitoring-read"}},"/segment":{"get":{"tags":["Configuration - Segments"],"description":"Get network segments","operationId":"getSegments","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Segment list":{"description":"Segment list","value":{"data":[{"segmentName":"Discovered_VPN_10","segmentId":"10","solution":"sdwan","id":"c952c18b-30b3-4f0b-b985-494693d7adfb","referenceCount":2},{"segmentName":"Discovered_VPN_65529","segmentId":"65529","solution":"sdwan","id":"5dd3f122-e52f-437e-b5e5-5ae94ad09cd6","referenceCount":0},{"segmentName":"Discovered_VPN_20","segmentId":"20","solution":"sd-routing","id":"83b6309d-f61d-4ac5-9699-7d3c04a1caef","referenceCount":0},{"segmentName":"Discovered_VPN_40","segmentId":"40","solution":"sd-routing","id":"64b30b74-08e2-4b4b-81ca-d019c7e452d5","referenceCount":1}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Segments"],"description":"Create network segment","operationId":"createSegment","requestBody":{"description":"Network segment","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network segment":{"description":"Network segment","value":{"segmentName":"Discovered_VPN_80","segmentId":"80","solution":"sdwan"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"bab577b9-e3c7-4385-abc1-d800dacb5f36"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/segment/{id}":{"get":{"tags":["Configuration - Segments"],"description":"Get network segment","operationId":"getSegment","parameters":[{"name":"id","in":"path","description":"Segment Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Segment list":{"description":"Segment list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Segments"],"description":"Edit network segment","operationId":"editSegment","parameters":[{"name":"id","in":"path","description":"Segment Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network segment","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network segment":{"description":"Network segment","value":"{{\n \"segmentName\":\"Discovered_VPN_80\",\n \"segmentId\":\"90\",\n \"solution\":\"sdwan\",\n \"id\":\"bab577b9-e3c7-4385-abc1-d800dacb5f36\",\n \"referenceCount\":0\n}}"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Segments"],"description":"Delete network segment","operationId":"deleteSegment","parameters":[{"name":"id","in":"path","description":"Segment Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/server/info":{"get":{"tags":["Monitoring - Server Info"],"description":"Get Server info","operationId":"createServerInfo_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage server info":{"description":"vManage server info","value":{"Achitecture":"amd64","Available processors":8}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/serverlongpoll/event/poll/{partnerId}":{"get":{"tags":["Partner - Registration"],"description":"Retrieve registration change information","operationId":"getDataChangeInfo","parameters":[{"name":"partnerId","in":"path","description":"Partner Id","required":true,"schema":{"type":"string"}},{"name":"event_id","in":"query","description":"Continuation token of ongoing event-polling session","schema":{"type":"string"}},{"name":"eventNames","in":"query","description":"Names of type of events to filter on","schema":{"type":"array","items":{"$ref":"#/components/schemas/EventName"}}},{"name":"wait_time","in":"query","description":"Maximum polling wait time in seconds","schema":{"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/setting/configuration/webserver/certificate":{"get":{"tags":["Certificate Management - vManage"],"summary":"Retrieves Certificate Signing Request information","description":"Retrieves Certificate Signing Request information","operationId":"showInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Web Server Certificate Response":{"description":"Web Server Certificate Response","$ref":"#/components/examples/GetWebServerCertificateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,dca"},"put":{"tags":["Certificate Management - vManage"],"summary":"Import a signed web server certificate","description":"Import a signed web server certificate","operationId":"importCertificate","requestBody":{"description":"Web Server Certificate configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Web Server Certificate Request":{"description":"Web Server Certificate Request","$ref":"#/components/examples/PutWebServerCertificateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Web Server Certificate Response":{"description":"Web Server Certificate Response","$ref":"#/components/examples/PutWebServerCertificateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"x-roles-required":"Settings-write"},"post":{"tags":["Certificate Management - vManage"],"summary":"Generate Certificate Signing Request","description":"Generate Certificate Signing Request","operationId":"getCSR","requestBody":{"description":"Web Server Certificate configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Web Server Certificate Request":{"description":"Web Server Certificate Request","$ref":"#/components/examples/PostWebServerCertificateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Web Server Certificate Response":{"description":"Web Server Certificate Response","$ref":"#/components/examples/PostWebServerCertificateResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse400"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"x-roles-required":"Settings-write"}},"/setting/configuration/webserver/certificate/getcertificate":{"get":{"tags":["Certificate Management - vManage"],"summary":"Get certificate for alias server","description":"Get certificate for alias server","operationId":"getCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Get Certificate Response":{"description":"Get Certificate Response","$ref":"#/components/examples/GetWebServerCertificateGetCertificateResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/settings/banner":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve banner","description":"Retrieve banner","operationId":"getBanner","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/clientSessionTimeout":{"get":{"tags":["Configuration - Settings"],"summary":"Get client session timeout","description":"Get client session timeout","operationId":"getSessionTimout","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/analytics/dca":{"post":{"tags":["Configuration - Settings"],"summary":"Create analytics data file","description":"Create analytics data file","operationId":"createAnalyticsDataFile","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/certificate/{type}":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve certificate configuration value by type","description":"Retrieve certificate configuration value by type","operationId":"getCertConfiguration","parameters":[{"name":"type","in":"path","description":"Type of the certificate configuration","required":true,"schema":{"type":"string"},"examples":{"CSR Properties":{"description":"CSR Properties","value":"csrproperties"},"Enterprise Root CA":{"description":"Enterprise Root CA","value":"enterpriserootca"},"CRL Settings":{"description":"CRL Settings","value":"crlSetting"},"Certificate":{"description":"Certificate","value":"certificate"},"Hardware Root CA":{"description":"Hardware Root CA","value":"hardwarerootca"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate Response":{"description":"Certificate Response","$ref":"#/components/examples/GetCertificateResponse"},"CSR Properties Response":{"description":"CSR Properties Response","$ref":"#/components/examples/GetCsrPropertiesResponse"},"CRL Settings Response":{"description":"CRL Settings Response","$ref":"#/components/examples/GetCrlSettingsResponse"},"Enterprise Root CA Response":{"description":"Enterprise Root CA Response","$ref":"#/components/examples/GetEnterpriseRootCAResponse"},"Hardware Root CA Response":{"description":"Hardware Root CA Response","$ref":"#/components/examples/GetHardwareRootCAResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Settings"],"summary":"Update certificate configuration","description":"Update certificate configuration","operationId":"editCertConfiguration","parameters":[{"name":"type","in":"path","description":"Type of the certificate configuration","required":true,"schema":{"type":"string"},"examples":{"CSR Properties":{"description":"CSR Properties","value":"csrproperties"},"Enterprise Root CA":{"description":"Enterprise Root CA","value":"enterpriserootca"},"CRL Settings":{"description":"CRL Settings","value":"crlSetting"},"Certificate":{"description":"Certificate","value":"certificate"},"Hardware Root CA":{"description":"Hardware Root CA","value":"hardwarerootca"}}}],"requestBody":{"description":"Certificate configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate Request":{"description":"Certificate Request","$ref":"#/components/examples/PutCertificateRequest"},"CSR Properties Request":{"description":"CSR Properties Request","$ref":"#/components/examples/PostCsrPropertiesRequest"},"CRL Settings Request":{"description":"CRL Settings Request","$ref":"#/components/examples/PostCrlSettingsRequest"},"Hardware Root CA Request":{"description":"Hardware Root CA Request","$ref":"#/components/examples/PutHardwareRootCARequest"},"Enterprise Root CA Request":{"description":"Enterprise Root CA Request","$ref":"#/components/examples/PutEnterpriseRootCARequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate Response":{"description":"Certificate Response","$ref":"#/components/examples/GetCertificateResponse"},"CSR Properties Response":{"description":"CSR Properties Response","$ref":"#/components/examples/GetCsrPropertiesResponse"},"CRL Settings Response":{"description":"CRL Settings Response","$ref":"#/components/examples/GetCrlSettingsResponse"},"Enterprise Root CA Response":{"description":"Enterprise Root CA Response","$ref":"#/components/examples/GetEnterpriseRootCAResponse"},"Hardware Root CA Response":{"description":"Hardware Root CA Response","$ref":"#/components/examples/GetHardwareRootCAResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}},"post":{"tags":["Configuration - Settings"],"summary":"Add new certificate configuration","description":"Add new certificate configuration","operationId":"newCertConfiguration","parameters":[{"name":"type","in":"path","description":"Type of the certificate configuration","required":true,"schema":{"type":"string"},"examples":{"CSR Properties":{"description":"CSR Properties","value":"csrproperties"},"Enterprise Root CA":{"description":"Enterprise Root CA","value":"enterpriserootca"},"CRL Settings":{"description":"CRL Settings","value":"crlSetting"},"Certificate":{"description":"Certificate","value":"certificate"},"Hardware Root CA":{"description":"Hardware Root CA","value":"hardwarerootca"}}}],"requestBody":{"description":"Certificate configuration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate Request":{"description":"Certificate Request","$ref":"#/components/examples/PutCertificateRequest"},"CSR Properties Request":{"description":"CSR Properties Request","$ref":"#/components/examples/PostCsrPropertiesRequest"},"CRL Settings Request":{"description":"CRL Settings Request","$ref":"#/components/examples/PostCrlSettingsRequest"},"Hardware Root CA Request":{"description":"Hardware Root CA Request","$ref":"#/components/examples/PutHardwareRootCARequest"},"Enterprise Root CA Request":{"description":"Enterprise Root CA Request","$ref":"#/components/examples/PutEnterpriseRootCARequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/cloudx":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve cloudx configuration value","description":"Retrieve cloudx configuration value","operationId":"getCloudxConfiguration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Settings"],"summary":"Update cloudx configuration setting","description":"Update cloudx configuration setting","operationId":"editCloudxConfiguration","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"deprecated":true},"post":{"tags":["Configuration - Settings"],"summary":"Add new cloudx configuration","description":"Add new cloudx configuration","operationId":"newCloudxConfiguration","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"deprecated":true}},"/settings/configuration/googleMapKey":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve Google map key","description":"Retrieve Google map key","operationId":"getGoogleMapKey","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/maintenanceWindow":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve maintenance window","description":"Retrieve maintenance window","operationId":"getMaintenanceWindow","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/configuration/microsoftTelemetry":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve Microsoft telemetry configuration value","description":"Retrieve Microsoft telemetry configuration value","operationId":"getMicrosoftTelemetryConfiguration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Settings"],"summary":"Update Microsoft telemetry configuration setting","description":"Update Microsoft telemetry configuration setting","operationId":"editMicrosoftTelemetryConfiguration","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"deprecated":true},"post":{"tags":["Configuration - Settings"],"summary":"Add new Microsoft telemetry configuration","description":"Add new Microsoft telemetry configuration","operationId":"newMicrosoftTelemetryConfiguration","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"deprecated":true}},"/settings/configuration/wani":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve wani configuration value","description":"Retrieve wani configuration value","operationId":"getWaniConfiguration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true},"put":{"tags":["Configuration - Settings"],"summary":"Update wani configuration setting","description":"Update wani configuration setting","operationId":"editWaniConfiguration","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"deprecated":true},"post":{"tags":["Configuration - Settings"],"summary":"Add new wani configuration","description":"Add new wani configuration","operationId":"newWaniConfiguration","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}},"deprecated":true}},"/settings/configuration/{type}":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve configuration value by type","description":"Retrieve configuration value by type","operationId":"getConfigurationBySettingType","parameters":[{"name":"type","in":"path","description":"Type of the certificate configuration","required":true,"schema":{"type":"string"},"examples":{"CSR Properties":{"description":"CSR Properties","value":"csrproperties"},"Enterprise Root CA":{"description":"Enterprise Root CA","value":"enterpriserootca"},"CRL Settings":{"description":"CRL Settings","value":"crlSetting"},"Certificate":{"description":"Certificate","value":"certificate"},"Hardware Root CA":{"description":"Hardware Root CA","value":"hardwarerootca"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate Response":{"description":"Certificate Response","$ref":"#/components/examples/GetCertificateResponse"},"CSR Properties Response":{"description":"CSR Properties Response","$ref":"#/components/examples/GetCsrPropertiesResponse"},"CRL Settings Response":{"description":"CRL Settings Response","$ref":"#/components/examples/GetCrlSettingsResponse"},"Enterprise Root CA Response":{"description":"Enterprise Root CA Response","$ref":"#/components/examples/GetEnterpriseRootCAResponse"},"Hardware Root CA Response":{"description":"Hardware Root CA Response","$ref":"#/components/examples/GetHardwareRootCAResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Settings"],"summary":"Update configuration setting","description":"Update configuration setting","operationId":"editConfiguration","parameters":[{"name":"type","in":"path","description":"Type of the certificate configuration","required":true,"schema":{"type":"string"},"examples":{"CSR Properties":{"description":"CSR Properties","value":"csrproperties"},"Enterprise Root CA":{"description":"Enterprise Root CA","value":"enterpriserootca"},"CRL Settings":{"description":"CRL Settings","value":"crlSetting"},"Certificate":{"description":"Certificate","value":"certificate"},"Hardware Root CA":{"description":"Hardware Root CA","value":"hardwarerootca"}}}],"requestBody":{"description":"Vmanage configuration setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate Request":{"description":"Certificate Request","$ref":"#/components/examples/PutCertificateRequest"},"CSR Properties Request":{"description":"CSR Properties Request","$ref":"#/components/examples/PostCsrPropertiesRequest"},"CRL Settings Request":{"description":"CRL Settings Request","$ref":"#/components/examples/PostCrlSettingsRequest"},"Hardware Root CA Request":{"description":"Hardware Root CA Request","$ref":"#/components/examples/PutHardwareRootCARequest"},"Enterprise Root CA Request":{"description":"Enterprise Root CA Request","$ref":"#/components/examples/PutEnterpriseRootCARequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate Response":{"description":"Certificate Response","$ref":"#/components/examples/GetCertificateResponse"},"CSR Properties Response":{"description":"CSR Properties Response","$ref":"#/components/examples/GetCsrPropertiesResponse"},"CRL Settings Response":{"description":"CRL Settings Response","$ref":"#/components/examples/GetCrlSettingsResponse"},"Enterprise Root CA Response":{"description":"Enterprise Root CA Response","$ref":"#/components/examples/GetEnterpriseRootCAResponse"},"Hardware Root CA Response":{"description":"Hardware Root CA Response","$ref":"#/components/examples/GetHardwareRootCAResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}},"post":{"tags":["Configuration - Settings"],"summary":"Add new certificate configuration","description":"Add new certificate configuration","operationId":"newConfiguration","parameters":[{"name":"type","in":"path","description":"Type of the certificate configuration","required":true,"schema":{"type":"string"},"examples":{"CSR Properties":{"description":"CSR Properties","value":"csrproperties"},"Enterprise Root CA":{"description":"Enterprise Root CA","value":"enterpriserootca"},"CRL Settings":{"description":"CRL Settings","value":"crlSetting"},"Certificate":{"description":"Certificate","value":"certificate"},"Hardware Root CA":{"description":"Hardware Root CA","value":"hardwarerootca"}}}],"requestBody":{"description":"Vmanage configuration setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate Request":{"description":"Certificate Request","$ref":"#/components/examples/PutCertificateRequest"},"CSR Properties Request":{"description":"CSR Properties Request","$ref":"#/components/examples/PostCsrPropertiesRequest"},"CRL Settings Request":{"description":"CRL Settings Request","$ref":"#/components/examples/PostCrlSettingsRequest"},"Hardware Root CA Request":{"description":"Hardware Root CA Request","$ref":"#/components/examples/PutHardwareRootCARequest"},"Enterprise Root CA Request":{"description":"Enterprise Root CA Request","$ref":"#/components/examples/PutEnterpriseRootCARequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Certificate Response":{"description":"Certificate Response","$ref":"#/components/examples/GetCertificateResponse"},"CSR Properties Response":{"description":"CSR Properties Response","$ref":"#/components/examples/GetCsrPropertiesResponse"},"CRL Settings Response":{"description":"CRL Settings Response","$ref":"#/components/examples/GetCrlSettingsResponse"},"Enterprise Root CA Response":{"description":"Enterprise Root CA Response","$ref":"#/components/examples/GetEnterpriseRootCAResponse"},"Hardware Root CA Response":{"description":"Hardware Root CA Response","$ref":"#/components/examples/GetHardwareRootCAResponse"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/settings/passwordPolicy":{"get":{"tags":["Configuration - Settings"],"summary":"Retrieve password policy from global settings","description":"Retrieve password policy from global settings","operationId":"getPasswordPolicy","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server"}}}},"/sig/datacenters/{type}/{tunneltype}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"The API to get all sig data center for given provider type","operationId":"getSigDynamicDataCenterList","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"tunneltype","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDataCenters"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sig/datacenters/{type}/{tunneltype}/{devicetype}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"Get list of data centers for zscaler or umbrella","operationId":"getSigDataCenterList","parameters":[{"name":"type","in":"path","description":"Provider type","required":true,"schema":{"type":"string"}},{"name":"tunneltype","in":"path","description":"Type of the tunnel ipsec/gre","required":true,"schema":{"type":"string"}},{"name":"devicetype","in":"path","description":"Type of the device vedge/cedge","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,Policy Configuration-read,Policy Configuration-write,Policy Deploy-read,Policy Deploy-write"}},"/sig/sigGlobalCredentials/{featureTemplateType}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"Get sig global credentials","operationId":"getSigGlobalCredentials","parameters":[{"name":"featureTemplateType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureTemplateType"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sig/umbrella/childOrg/{type}":{"get":{"tags":["Configuration - Secure Internet Gateway"],"description":"Get the list of child org IDs given the type management or device ","operationId":"getChildOrgs","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/authenticate":{"post":{"tags":["Smart License"],"description":"authenticate user for sle","operationId":"sleauthenticate","requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"data":{"description":"data","value":"{{\"accessToken\":\"3QTD4madnNiu4q4c6YTmrprhAkvM\"}}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/fetchAccounts":{"get":{"tags":["Smart License"],"description":"fetch sava for sle","operationId":"fetchAccounts","parameters":[{"name":"mode","in":"query","description":"mode","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner":{"description":"Partner","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartLicensingfetchAccountsResp"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/fetchAllSa":{"get":{"tags":["Smart License"],"description":"fetch reports offline for sle","operationId":"fetchReports_1","requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"SLE":{"description":"SLE","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/fetchReportsForSa":{"get":{"tags":["Smart License"],"description":"fetch reports offline for sle","operationId":"fetchReports","parameters":[{"name":"saDomain","in":"query","description":"saDomain","required":true,"schema":{"type":"string"}},{"name":"saId","in":"query","description":"saId","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Partner","content":{"application/json":{"schema":{"type":"object"},"examples":{"SLE":{"description":"SLE","value":{}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Partner Id":{"description":"Partner Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/smartLicensing/getUserSettings":{"get":{"tags":["Smart License"],"description":"get settings","operationId":"get settings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Devices":{"description":"Devices","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/smartLicensing/syncLicenses":{"post":{"tags":["Smart License"],"description":"get all licenses for sa/va","operationId":"syncLicenses","requestBody":{"description":"Partner","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LicenseUplodFile"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"license":{"description":"license","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"admin,Software Upgrade-write"}},"/software/compliance/ip/origin/check":{"post":{"tags":["Utility - Security"],"description":"Block IP based on list","operationId":"checkGivenIpList","requestBody":{"description":"Device detail","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device detail":{"description":"Device detail","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"IP validation status":{"description":"IP validation status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/sslproxy/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get edge proxy certificate","operationId":"getProxyCertOfEdge","parameters":[{"name":"deviceId","in":"query","description":"Device Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edge proxy certificate":{"description":"Edge proxy certificate","value":{"enterpriseCA":true,"vManageRootCA":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"put":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Upload device certificate","operationId":"updateCertificate","requestBody":{"description":"Upload device certificate","content":{"application/json":{"schema":{"type":"object"},"examples":{"Upload device certificate":{"description":"Upload device certificate","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","certificate":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{id: \"210c2bc2-5423-4a6b-9269-22eaf058d774\"}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/certificate/wanedge/{deviceId}":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Add SSL proxy wan edge","operationId":"addWANEdge","parameters":[{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cert state","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cert state":{"description":"Cert state","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/certificates":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Upload device certificates","operationId":"uploadCertificiates","requestBody":{"description":"Certificate file","content":{"multipart/form-data":{"schema":{"type":"object"},"examples":{"Certificate file":{"description":"Certificate file"}}}},"required":true},"responses":{"200":{"description":"Success"},"207":{"description":"Multi-status"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/csr":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get SSL proxy CSR","operationId":"getSslProxyCSR","parameters":[{"name":"deviceId","in":"query","description":"device UUID","required":true,"schema":{"type":"string","example":"8d86d8b2-2239-402e-9fef-467f7bad3f2f"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR":{"description":"CSR","value":{"csr":[{"hostCommonName":"vManageCA_vm12","csr":"-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n","last updated":"07 Apr 2022 07:56:17 UTC","commonName":"vManageCA","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/devicecertificates":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get certificate for all cEdges","operationId":"getAllDeviceCertificates","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":[{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate":{"description":"Certificate","value":{"header":{"generatedOn":1650355912089},"data":[{"certificate":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/devicecsr":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get CSR for all cEdges","operationId":"getAllDeviceCSR","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":[{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR":{"description":"CSR","value":{"header":{"generatedOn":1650354738278},"data":[{"csr":"-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n","uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/generate/csr/sslproxy":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"CSR request SSL proxy for edge","operationId":"generateSslProxyCSR","requestBody":{"description":"CSR request for edge","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR request for edge":{"description":"CSR request for edge"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Certificates-write"}},"/sslproxy/generate/vmanage/csr":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Generate CSR","operationId":"generateSSLProxyCSR","requestBody":{"description":"CSR request","content":{"application/json":{"schema":{"type":"object"},"examples":{"CSR request":{"description":"CSR request","value":{"commonName":"vManageCA","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com","intermediateCA":"true"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"ba6586b6-6caf-4eac-a6ae-ec4d57d0fe2c"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/list":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get SSL proxy certificate list","operationId":"getSslProxyList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Certificate list":{"description":"Certificate list","value":[{"deviceModel":"vedge-C8000V","chasisNumber":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","configuredHostname":"vm5","managementSystemIP":"172.16.255.15","deviceSerialNumber":"12345712","configuredSiteId":"500","commonName":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","csr":"-----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n","serialNumber":"","@rid":1023,"last updated":"07 Apr 2022 09:07:34 UTC","certificate":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","state":"CSR_GENERATED","uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","scep":false,"expirationDate":"Apr 08 09:07:34 2022 UTC","hasCert":true,"hasCSR":true,"hasEnterpriseCert":false}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/renew":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Renew device certificate","operationId":"renewCertificate","requestBody":{"description":"Renew device certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Renew device certificate request":{"description":"Renew device certificate request","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"0ed22d4e-ba07-4828-9bd6-f3ea9d281513"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/revoke":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Revoke device certificate","operationId":"revokeCertificate","requestBody":{"description":"Revoke device certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Revoke device certificate request":{"description":"Revoke device certificate request","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","revokeReason":"Unspecified"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/revokerenew":{"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Revoke and renew device certificate","operationId":"revokeRenewCertificate","requestBody":{"description":"Revoke device certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Revoke and renew device certificate request":{"description":"Revoke and renew device certificate request","value":{"uuid":"C8K-2e556375-5d15-420b-aa4d-dd3e5072e585","revokeReason":"Unspecified"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"e23238cc-8b2f-49ed-9ce4-4c68c06fa6f4"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get certificate state","operationId":"getCertificateState","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate State":{"description":"Certificate State","value":{"enterpriseCA":false,"vManageRootCA":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/settings/enterprise/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get enterprise certificate","operationId":"getEnterpriseCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise certificate":{"description":"Enterprise certificate","value":{"scep":false,"last updated":"07 Apr 2022 03:45:59 UTC","commonName":"OCSP-CA","enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Configure enterprise certificate","operationId":"setEnterpriseCert","requestBody":{"description":"Config enterprise certificate request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise certificate request":{"description":"Enterprise certificate request","value":{"scep":"false","enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Certificate":{"description":"Certificate","value":{"scep":false,"last updated":"07 Apr 2022 03:45:59 UTC","commonName":"OCSP-CA","enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/enterprise/rootca":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage enterprise root certificate","operationId":"getVManageEnterpriseRootCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise root certificate":{"description":"Enterprise root certificate","value":{"enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289","last updated":"07 Apr 2022 03:53:12 UTC"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Set vManage enterprise root certificate","operationId":"setEnterpriseRootCaCert","requestBody":{"description":"Set enterprise root CA request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise root CA":{"description":"Enterprise root CA","value":{"enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","intermediateCA":"true"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enterprise root certificate":{"description":"Enterprise root certificate","value":{"enterpriseRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","fingerprint":"db06d0f8799353eabbc47bb201321d54f5086289","last updated":"07 Apr 2022 03:53:12 UTC"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/vmanage/certificate":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage intermediate certificate","operationId":"getvManageCertificate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage intermediate certificate":{"description":"vManage intermediate certificate","value":{"header":{"generatedOn":1649322823353},"data":[{"vManageRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","hostCommonName":"vManageCA_vm12","commonName":"vManageCA_vm12","fingerprint":"fcb9c623aa9022354fecd95b1f355e1372802aeb","last updated":"07 Apr 2022 07:56:17 UTC","intermediateCA":"true"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Set vManage root certificate","operationId":"setvManageintermediateCert","requestBody":{"description":"Set vManage intermediate CA request","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage intermediate CA":{"description":"vManage intermediate CA","value":{"data":[{"commonName":"vManageCA_vm12","vManageRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","intermediateCA":"true"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage intermediate certificate":{"description":"vManage intermediate certificate","value":{"header":{"generatedOn":1649318177975},"data":[{"vManageRootCA":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n","hostCommonName":"vManageCA_vm12","commonName":"vManageCA_vm12","fingerprint":"fcb9c623aa9022354fecd95b1f355e1372802aeb","last updated":"07 Apr 2022 07:56:17 UTC","intermediateCA":"true"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/sslproxy/settings/vmanage/csr":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage CSR","operationId":"getvManageCSR","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage CSR":{"description":"vManage CSR","value":{"csr":[{"hostCommonName":"vManageCA_vm12","csr":"-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n","last updated":"07 Apr 2022 04:37:37 UTC","commonName":"vManageCA","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"}},"/sslproxy/settings/vmanage/rootca":{"get":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Get vManage root certificate","operationId":"getvManageRootCA","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage root certificate":{"description":"vManage root certificate","value":{"header":{"generatedOn":1649300400918},"data":[{"vManageRootCA":"...","publickey":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","csr":"-----BEGIN NEW CERTIFICATE REQUEST-----\n...\n-----END NEW CERTIFICATE REQUEST-----\n","hostCommonName":"vManageRootCa_vm12","last updated":"07 Apr 2022 02:59:59 UTC","uuid":"3a0733ad-3967-4f71-b4fc-a64c3f634366","fingerprint":"1aef4396ce2c71e5df49c448a5eb49b488e9305b","commonName":"vManageRootCa","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","email":"name@cisco.com","validity":"10"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-read,Certificates-write"},"post":{"tags":["Configuration - Device SSL Proxy Certificate Management"],"description":"Set vManage root certificate","operationId":"setvManageRootCA","requestBody":{"description":"Set vManage root CA request","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage root CA":{"description":"vManage root CA","value":{"commonName":"vManageRootCa","org":"Cisco System","orgUnit":"Cisco System","locality":"Shanghai","state":"Shanghai","country":"CN","validity":10,"email":"name@cisco.com"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vManage root certificate":{"description":"vManage root certificate","value":{"id":"4aa25a65-b65a-443c-9ebf-21d1dee0ed20"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Certificates-write"}},"/statistics":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get statistics types","operationId":"getStatisticType","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Stats type":{"description":"Stats type","value":["interfacestatistics","eioltestatistics","providerdpistatistics","sulstatistics","qosstatistics","devicesystemstatusstatistics","bridgemacstatistics","dpistatistics","approutestatsstatistics","provideraggregatedappsdpistatistics","wlanclientinfostatistics","flowlogstatistics","urlf","fwall","vnfstatistics","umbrella","apphostingstatistics","utddaqioxstatistics","ipsalert","aggregatedappsdpistatistics","bridgeinterfacestatistics","artstatistics","trackerstatistics","cloudxstatistics","deviceevents","sleofflinereport","alarm","auditlog","deviceconfiguration","nwpi","nwpiflowraw","speedtest"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getStatsRawData_13","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/aggregation":{"get":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_14","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"},"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events-2"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics-2"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS-2"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_14","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events-2"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics-2"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS-2"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/app-agg/aggregation":{"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"#/components/examples/DPI"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events-2"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics-2"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS-2"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"},"generated by base class - Monitoring - DPI":{"description":"generated by base class - Monitoring - DPI","$ref":"#/components/examples/DPI-2"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/apphosting":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatDataRawData_1","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatsRawData_1","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/apphosting/aggregation":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_1","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_1","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/apphosting/csv":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_1","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/apphosting/doccount":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCount_3","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCountPost_2","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphosting/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get fields and type","operationId":"getStatDataFields_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphosting/page":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_1","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_1","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphosting/query/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get query fields","operationId":"getStatQueryFields_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphostinginterface":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatDataRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatsRawData","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/apphostinginterface/aggregation":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/apphostinginterface/csv":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/apphostinginterface/doccount":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCount_2","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - App Hosting"],"description":"Get response count of a query","operationId":"getCountPost_1","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphostinginterface/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get fields and type","operationId":"getStatDataFields_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/apphostinginterface/page":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - App Hosting"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/apphostinginterface/query/fields":{"get":{"tags":["Monitoring - App Hosting"],"description":"Get query fields","operationId":"getStatQueryFields_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getStatDataRawData_2","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getStatsRawData_2","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"example":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/aggregation":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_2","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["100"],"field":"loss_percentage","type":"number","operator":"less"}]},"aggregation":{"field":[{"property":"local_color","sequence":1,"order":"asc"}],"metrics":[{"property":"loss_percentage","type":"avg"},{"property":"latency","type":"avg"},{"property":"jitter","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAggResp"}},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":" [\n {\n \"count\": 5,\n \"local_color\": \"3g\",\n \"loss_percentage\": 0\n \"jitter\": 0\n \"latency\": 0\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_2","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["100"],"field":"loss_percentage","type":"number","operator":"less"}]},"aggregation":{"field":[{"property":"local_color","sequence":1,"order":"asc"}],"metrics":[{"property":"loss_percentage","type":"avg"},{"property":"latency","type":"avg"},{"property":"jitter","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAggResp"}},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":" [\n {\n \"count\": 5,\n \"local_color\": \"3g\",\n \"loss_percentage\": 0\n \"jitter\": 0\n \"latency\": 0\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/app-agg/aggregation":{"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery9","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAppAggResp"}},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":[{"latency":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/csv":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_2","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":" blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/device/tunnel/summary":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get statistics for top applications per tunnel in a grid table","operationId":"getStatsAppRouteDeviceTunnelSummary","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTunnenSummarResp"}},"examples":{"Statistics for top application":{"description":"Statistics for top application","value":[{"name":"172.16.255.11:lte-172.16.255.15:3g","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.15:lte","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.16:3g","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.16:lte","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"entry_time":"","app_probe_class":""}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/device/tunnels":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get statistics for top applications per tunnel in a grid table","operationId":"getStatsAppRouteDeviceTunnels","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"examples":{"Tunnel top statistics":{"description":"Tunnel top statistics","value":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677160200123,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677159336845,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":3718,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:lte","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm1","id":"0q-JfoYB04cEz_Q-t9i_"},{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.2","local_color":"lte","src_ip":"10.0.101.1","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677160200123,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677159336845,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":3713,"dst_port":12366,"name":"172.16.255.11:lte-172.16.255.16:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm1","id":"za-JfoYB04cEz_Q-t9i_"},{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.2","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677160200123,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677159336845,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":3714,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:3g","sla_class_list":"0","tunnel_color":"3g:3g","host_name":"vm1","id":"zq-JfoYB04cEz_Q-t9i_"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/doccount":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get response count of a query","operationId":"getDocCount_1","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get response count of a query","operationId":"getDocCountPost","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/fec/aggregation":{"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get aggregation data and fec recovery rate","operationId":"getAppRouteFecAgg","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["172.16.255.11:lte-172.16.255.14:lte","172.16.255.11:lte-172.16.255.15:3g"],"field":"name","type":"string","operator":"in"},{"value":["100"],"field":"loss_percentage","type":"number","operator":"less"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"state","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"loss_percentage","type":"avg"},{"property":"fecLossRecovery","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteFECAggResp"}},"examples":{"Aggregation data and fec recovery rate":{"description":"Aggregation data and fec recovery rate","value":" [\n {\n \"loss_percentage\": 0.1066624445851805,\n \"entry_time\": 1676892600000,\n \"count\": 1578,\n \"proto\": \"IPSEC\",\n \"name\": \"172.16.254.16:default-172.16.254.2:default\",\n \"state\": \"Up\",\n \"fecLossRecovery\": \"-\",\n },\n {\n \"loss_percentage\": 0.1266624445851805,\n \"entry_time\": 1676892600000,\n \"count\": 1579,\n \"proto\": \"IPSEC\",\n \"name\": \"172.16.254.16:default-172.16.254.3:default\",\n \"state\": \"Up\",\n \"fecLossRecovery\": \"-\",\n }\n ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/fields":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get fields and type","operationId":"getStatDataFields_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteDocCountResponse"}},"example":[{"property":"vdevice_name","dataType":"string"},{"property":"host_name","dataType":"string"},{"property":"device_model","dataType":"string"},{"property":"statcycletime","dataType":"date"},{"property":"entry_time","dataType":"date"},{"property":"vip_idx","dataType":"number"},{"property":"local_system_ip","dataType":"string"},{"property":"remote_system_ip","dataType":"string"},{"property":"local_color","dataType":"string"},{"property":"remote_color","dataType":"string"},{"property":"proto","dataType":"string"},{"property":"window","dataType":"number"},{"property":"src_ip","dataType":"string"},{"property":"dst_ip","dataType":"string"},{"property":"src_port","dataType":"number"},{"property":"dst_port","dataType":"number"},{"property":"total","dataType":"number"},{"property":"latency","dataType":"number"},{"property":"loss_percentage","dataType":"number"},{"property":"jitter","dataType":"number"},{"property":"tx_pkts","dataType":"number"},{"property":"rx_pkts","dataType":"number"},{"property":"tx_octets","dataType":"number"},{"property":"rx_octets","dataType":"number"},{"property":"name","dataType":"string"},{"property":"loss","dataType":"number"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/page":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getStatBulkRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteAggRespWithPageInfo"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.2","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677076800077,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677075936838,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":934,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:3g","sla_class_list":"0","tunnel_color":"3g:3g","host_name":"vm1","id":"-auReYYB04cEz_Q-IvdV"},{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.0.101.1","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677076800077,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677075936838,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":937,"dst_port":12366,"name":"172.16.255.11:lte-172.16.255.16:lte","sla_class_list":"0","tunnel_color":"lte:lte","host_name":"vm1","id":"_KuReYYB04cEz_Q-IvdV"},{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":0,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"3g","src_ip":"10.0.101.2","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1677076800077,"siteid":100,"state":"Up","local_system_ip":"172.16.255.11","tenant":"default","entry_time":1677075936838,"loss_percentage":0,"app_probe_class":"None","rx_pkts":0,"vmanage_system_ip":"172.16.255.11","fec_rx":0,"src_port":12366,"jitter":0,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.11","proto":"IPSEC","vip_idx":938,"dst_port":12366,"name":"172.16.255.11:3g-172.16.255.16:lte","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm1","id":"_auReYYB04cEz_Q-IvdV"}],"pageInfo":{"startTime":"1677076800076","endTime":"1677076800077","scrollId":"FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFnRpX1duVm1rUmhpMVJUdGk1R05PWHcAAAAAAAAkbhZVMG9reER2Y1NtT1ZwM2lBYmpEWVZ3_10","hasMoreData":true,"count":10,"totalCount":1430}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteAggRespWithPageInfo"},"example":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1666941702257","endTime":"1666941699172","count":1000}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/query/fields":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get query fields","operationId":"getStatQueryFields_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query fields":{"description":"Query fields","value":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tloc":{"post":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tloc","operationId":"getApprouteTloc","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"local_tloc","sequence":1,"size":20},{"property":"siteid","sequence":2}],"metrics":[{"property":"rx_octets","type":"sum","order":"desc"},{"property":"tx_octets","type":"sum","order":"desc"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTlocResp"}},"example":[{"rx_octets":0,"tx_octets":0,"count":1401,"local_tloc":"172.1.1.1:mpls","siteid":607}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/transport/summary/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get application-aware routing statistics summary from device","operationId":"getAppRouteTransportSummaryType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":5}},{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteFECAggResp"}},"examples":{"Application-aware routing statistics summary":{"description":"Application-aware routing statistics summary","value":[{"entry_time":1676892600000,"loss_percentage":0,"color":"3g:3g","jitter":0,"latency":0,"app_probe_class":""},{"entry_time":1676818800000,"loss_percentage":0,"color":"3g:lte","jitter":0,"latency":0,"app_probe_class":""}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/transport/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get application-aware routing statistics from device","operationId":"getAppRouteTransportType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteTransportResp"},"example":[{"latency":0,"entry_time":1673524800000,"jitter":0,"color":"lte","loss_percentage":0,"app_probe_class":"None"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnel/{type}/summary":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel top statistics in as chart","operationId":"getAppRouteTunnelSummaryType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"examples":{"Tunnel top statistics":{"description":"Tunnel top statistics","value":{"value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnels/health/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel health","operationId":"getAppRouteTunnelHealth","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":3}},{"name":"last_n_minutes","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"deviceIP","in":"query","schema":{"type":"string"},"example":"172.16.255.11"},{"name":"site-id","in":"query","schema":{"type":"string"}},{"name":"regionName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTunnenSummarResp"}},"examples":{"Tunnel top statistics":{"description":"Tunnel top statistics","value":[{"name":"172.16.255.11:lte-172.16.255.16:lte","remote_system_ip":"172.16.255.16,","remote_color":"lte","remote-host-name":"vm6,","remote_site_id":"600,","remote_latitude":"32.0,","remote_longitude":"-88.0,","local_color":"gold,","local_system_ip":"172.16.255.11,","device-type":"vedge,","deviceClass":"viptela-router,","state":"Up,","vqoe_score":"10,","jitter":"0,","rx_octets":"0,","loss_percentage":"0,","latency":"0,","tx_octets":"0,","health":"green"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnels/summary/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel top statistics from device","operationId":"getAppRouteTunnelsSummaryType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":10}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppRouteTransportResp"},"example":[{"name":"172.16.255.11:lte-172.16.255.16:3g","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"app_probe_class":""},{"name":"172.16.255.11:lte-172.16.255.16:lte","jitter":0,"rx_octets":0,"tx_octets":0,"loss_percentage":0,"latency":0,"app_probe_class":""}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/approute/tunnels/{type}":{"get":{"tags":["Monitoring - Application Aware Routing"],"description":"Get tunnel top statistics from device","operationId":"getAppRouteTunnelType","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"},"example":"loss"},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["3g","lte"],"field":"local_color","type":"string","operator":"in"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteRespWithPageInfo"}},"example":{"value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/art":{"get":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getStatDataRawData_4","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getStatsRawData_4","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/art/aggregation":{"get":{"tags":["Monitoring - ART"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_4","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - ART"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_4","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/art/csv":{"get":{"tags":["Monitoring - ART"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_4","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/art/doccount":{"get":{"tags":["Monitoring - ART"],"description":"Get response count of a query","operationId":"getCount_5","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - ART"],"description":"Get response count of a query","operationId":"getCountPost_4","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/art/fields":{"get":{"tags":["Monitoring - ART"],"description":"Get fields and type","operationId":"getStatDataFields_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/art/page":{"get":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_2","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - ART"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_2","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/art/query/fields":{"get":{"tags":["Monitoring - ART"],"description":"Get query fields","operationId":"getStatQueryFields_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bfd":{"get":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getStatDataRawData_5","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getStatsRawData_5","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/bfd/aggregation":{"get":{"tags":["Monitoring - BFD"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_5","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - BFD"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_5","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/bfd/csv":{"get":{"tags":["Monitoring - BFD"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_5","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/bfd/doccount":{"get":{"tags":["Monitoring - BFD"],"description":"Get response count of a query","operationId":"getCount_6","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - BFD"],"description":"Get response count of a query","operationId":"getCountPost_5","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bfd/fields":{"get":{"tags":["Monitoring - BFD"],"description":"Get fields and type","operationId":"getStatDataFields_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bfd/page":{"get":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_3","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - BFD"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_3","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bfd/query/fields":{"get":{"tags":["Monitoring - BFD"],"description":"Get query fields","operationId":"getStatQueryFields_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgeinterface":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatDataRawData_6","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatsRawData_6","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/bridgeinterface/aggregation":{"get":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_6","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_6","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/bridgeinterface/csv":{"get":{"tags":["Monitoring - Bridge"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_6","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/bridgeinterface/doccount":{"get":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCount_7","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCountPost_6","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgeinterface/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get fields and type","operationId":"getStatDataFields_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgeinterface/page":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_4","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_4","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgeinterface/query/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get query fields","operationId":"getStatQueryFields_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgemac":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatDataRawData_7","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatsRawData_7","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/bridgemac/aggregation":{"get":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_7","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Bridge"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_7","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/bridgemac/csv":{"get":{"tags":["Monitoring - Bridge"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_7","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/bridgemac/doccount":{"get":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCount_8","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Bridge"],"description":"Get response count of a query","operationId":"getCountPost_7","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgemac/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get fields and type","operationId":"getStatDataFields_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/bridgemac/page":{"get":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_5","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Bridge"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_5","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/bridgemac/query/fields":{"get":{"tags":["Monitoring - Bridge"],"description":"Get query fields","operationId":"getStatQueryFields_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cflowd":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getStatDataRawData_9","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getStatsRawData_9","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/cflowd/aggregation":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_9","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Cflowd"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_9","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/cflowd/applications":{"get":{"tags":["Monitoring - Cflowd"],"description":"Generate cflowd flows list in a grid table","operationId":"createFlowsGrid","parameters":[{"name":"vpn","in":"query","description":"VPN Id","schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"Device IP","schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"limit","in":"query","description":"Limit","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Flows":{"description":"Flows","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/applications/summary":{"get":{"tags":["Monitoring - Cflowd"],"description":"Generate cflowd flows list in a grid table","operationId":"createFlowssummary","parameters":[{"name":"limit","in":"query","description":"Limit","schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Flows":{"description":"Flows","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/csv":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_9","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/cflowd/device/applications":{"get":{"tags":["Monitoring - Cflowd"],"description":"Generate cflowd flows list in a grid table","operationId":"createFlowDeviceData","parameters":[{"name":"query","in":"query","description":"Query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Flows":{"description":"Flows","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/doccount":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get response count of a query","operationId":"getCount_10","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Cflowd"],"description":"Get response count of a query","operationId":"getCountPost_9","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cflowd/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get fields and type","operationId":"getStatDataFields_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cflowd/page":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_7","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cflowd"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_7","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cflowd/query/fields":{"get":{"tags":["Monitoring - Cflowd"],"description":"Get query fields","operationId":"getStatQueryFields_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cloudx":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getStatDataRawData_10","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getStatsRawData_10","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/cloudx/aggregation":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_10","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_10","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/cloudx/csv":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_10","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/cloudx/doccount":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get response count of a query","operationId":"getCount_11","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get response count of a query","operationId":"getCountPost_10","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cloudx/fields":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get fields and type","operationId":"getStatDataFields_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/cloudx/page":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_8","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - CloudExpress"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_8","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/cloudx/query/fields":{"get":{"tags":["Monitoring - CloudExpress"],"description":"Get query fields","operationId":"getStatQueryFields_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/collect":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Start stats collect","operationId":"startStatsCollection","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"ActivateDataCollection":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/collect/thread/status":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get stats collect thread report","operationId":"generateStatsCollectThreadReport","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Process thread report":{"description":"Process thread report","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/collection/reset/{processQueue}":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Reset stats collect thread report","operationId":"resetStatsCollection","parameters":[{"name":"processQueue","in":"path","description":"Process queue","required":true,"schema":{"type":"integer","format":"int64","default":-1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"statisticsCollectionReset":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/csv":{"get":{"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_13","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/demomode":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Enable statistic demo mode","operationId":"enableStatisticsDemoMode","parameters":[{"name":"enable","in":"query","description":"Demo mode flag","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Demo mode":{"description":"Demo mode","value":{"DemoMode":"Stats collection interval: 1 minute, Stats Processing interval: 1 min"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/device":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getStatDataRawData_15","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getStatsRawData_15","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/device/aggregation":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_17","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_18","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/device/csv":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_15","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/device/doccount":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get response count of a query","operationId":"getCount_15","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get response count of a query","operationId":"getCountPost_15","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/device/fields":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get fields and type","operationId":"getStatDataFields_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/device/page":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_13","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Device Statistics"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_13","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/device/query/fields":{"get":{"tags":["Monitoring - Device Statistics"],"description":"Get query fields","operationId":"getStatQueryFields_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/devicehealth/history":{"get":{"tags":["Monitoring - Device Health"],"summary":"Device health history data","description":"Get all device health history ","operationId":"getDeviceHealthHistory","parameters":[{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthHistoryItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/devicehealth/overview/{type}":{"get":{"tags":["Monitoring - Device Health"],"summary":"Device health overview data","description":"Get all device health overview ","operationId":"getDeviceHealthOverview","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"personality","in":"query","schema":{"type":"string","enum":["vsmart","vbond","vmanage","vedge"],"default":"vedge"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceHealthOverview"}}}},"400":{"description":"bad input parameter"}}}},"/statistics/doccount":{"get":{"description":"Get response count of a query","operationId":"getCount_13","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"description":"Get response count of a query","operationId":"getCountPost_13","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/download/{processType}/fetchvManageList":{"get":{"tags":["Monitoring - Stats Download"],"operationId":"fetchList","parameters":[{"name":"processType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/statistics/download/{processType}/file/{fileType}/{queue}/{deviceIp}/{token}/{fileName}":{"get":{"tags":["Monitoring - Stats Download"],"description":"Downloading stats file","operationId":"download","parameters":[{"name":"processType","in":"path","description":"Process type","required":true,"schema":{"type":"string"}},{"name":"fileType","in":"path","description":"File type","required":true,"schema":{"type":"string"}},{"name":"queue","in":"path","description":"Queue name","required":true,"schema":{"type":"string"}},{"name":"deviceIp","in":"path","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}},{"name":"token","in":"path","description":"Token","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/download/{processType}/filelist":{"post":{"tags":["Monitoring - Stats Download"],"description":"Downloading list of stats file","operationId":"downloadList","parameters":[{"name":"processType","in":"path","description":"Possible types are: remoteprocessing, dr","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/dpi":{"get":{"tags":["Monitoring - DPI"],"description":"Get DPI stats raw data","operationId":"getDPIStatsRawData","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get DPI stats raw data","operationId":"getDPIStatsRawDataPost","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/agg-app/aggregation":{"post":{"tags":["Monitoring - DPI"],"description":"Get raw aggregated data and display applications with the highest utilization for a device","operationId":"getAggAppDataPost","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1.1.60.7"],"field":"vdevice_name","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/dpi/aggregation":{"get":{"tags":["Monitoring - DPI"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getDPIStatsAggregationData","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get raw aggregated data and display applications with the highest utilization for a device","operationId":"getDPIStatsAggregationDataPost","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1.1.60.7"],"field":"vdevice_name","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/dpi/applications":{"get":{"tags":["Monitoring - DPI"],"description":"Get detailed DPI application flows list in a grid table","operationId":"getAggAppFlows","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAppResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/statistics/dpi/applications/summary":{"get":{"tags":["Monitoring - DPI"],"description":"Get detailed DPI application flows summary","operationId":"getAggAppFlowsSummary","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIAppResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/csv":{"get":{"tags":["Monitoring - DPI"],"description":"Get raw data with optional query as CSV","operationId":"getDPIStatsRawDataAsCSV","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/device/application/flowcount":{"get":{"tags":["Monitoring - DPI"],"description":"Get application flow count per tunnel","operationId":"getDPIDeviceAppUniqueFlowCount","parameters":[{"name":"deviceId","in":"query","required":true,"schema":{"type":"string"}},{"name":"interval","in":"query","required":true,"schema":{"type":"string"}},{"name":"application","in":"query","schema":{"type":"string"}},{"name":"window","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"family","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/device/applications":{"get":{"tags":["Monitoring - DPI"],"description":"Get DPI application flows device aggregation data","operationId":"getDPIDeviceAppAggregationData","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAppResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/statistics/dpi/device/details/applications":{"get":{"tags":["Monitoring - DPI"],"description":"Get detailed DPI device and application list","operationId":"getDPIDeviceAppDetails","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAppDetailResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/doccount":{"get":{"tags":["Monitoring - DPI"],"description":"Get response count of a query","operationId":"getDPIStatsCount","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get response count of a query","operationId":"getDPIStatsCountPost","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/fields":{"get":{"tags":["Monitoring - DPI"],"description":"Get fields and type","operationId":"getDPIFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"fields":{"description":"fields","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/page":{"get":{"tags":["Monitoring - DPI"],"description":"Get DPI stats pagination raw data","operationId":"getDPIStatsPaginationRawData","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIPaginationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - DPI"],"description":"Get DPI stats pagination raw data","operationId":"getDPIStatsPaginationRawDataPost","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPIPaginationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/dpi/pktdup/aggregation":{"post":{"tags":["Monitoring - DPI"],"description":"Get time series aggregation data for packet duplication for an application over TLOCs if available","operationId":"getDPIStatsAggregationDataForPacketDup","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FecAndPktDupResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/query/fields":{"get":{"tags":["Monitoring - DPI"],"description":"Get query fields","operationId":"getDPIQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"fields":{"description":"fields","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/dpi/recovery/aggregation":{"post":{"tags":["Monitoring - DPI"],"description":"Get aggregation data and fec recovery rate if available","operationId":"getDPIStatsAggregationDataForFec","requestBody":{"description":"User","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FecAndPktDupResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/eiolte":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getStatDataRawData_8","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getStatsRawData_8","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/eiolte/aggregation":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_8","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_8","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/eiolte/cellularAggregation":{"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"cellularAggregation","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatisticsDBQueryParam"},"examples":{"cellular aggregation":{"description":"cellular aggregation","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["1"],"operator":"last_n_hours"},{"field":"rat","type":"string","value":["Unknown"],"operator":"not_equal"},{"field":"bandclass","type":"string","value":["Unknown"],"operator":"not_equal"}]},"aggregation":{"field":[{"sequence":1,"orderType":"count","size":5000,"property":"carrier","order":"desc"},{"sequence":2,"orderType":"count","size":5000,"property":"host_name","order":"desc"},{"sequence":1,"size":5000,"property":"vdevice_name","order":"desc"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Carrier List":{"description":"Carrier List","value":{"data":[{"carrier":"Test PLMN 1-1","vdevice_name":"172.16.255.101","host_name":"pm1-Slot2","count":86}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/eiolte/csv":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_8","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/eiolte/doccount":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get response count of a query","operationId":"getCount_9","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get response count of a query","operationId":"getCountPost_8","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/eiolte/fields":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get fields and type","operationId":"getStatDataFields_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/eiolte/page":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_6","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_6","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/eiolte/query/fields":{"get":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get query fields","operationId":"getStatQueryFields_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/eiolte/uniqueAggregation":{"post":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get unique aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"uniqueAggregation","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatisticsDBQueryParam"},"examples":{"unique aggregation request":{"description":"unique aggregation request","$ref":"#/components/examples/UniqueAggregation"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"unique aggregation response":{"description":"unique aggregation response","$ref":"#/components/examples/UniqueAggregation-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/endpointTracker":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getStatDataRawData_18","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]},"size":10000}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"entry_time":"1623811598645","tracker_name":"track1","vmanage_system_ip":"172.16.255.15","host_name":"vm5","vdevice_name":"172.16.255.15","device_model":"vedge-CSR-1000v","vpn_idx":2,"tracker_status":"DOWN","rtt_avg":4,"rtt_min":0,"rtt_max":42,"tenant":"default","statcycletime":"1623813001149","id":"xELMEnoBED2frxv5D_e_"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getStatsRawData_18","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/endpointTracker/aggregation":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_20","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_21","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/endpointTracker/csv":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_18","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/endpointTracker/doccount":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get response count of a query","operationId":"getCount_18","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get response count of a query","operationId":"getCountPost_18","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/endpointTracker/fields":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get fields and type","operationId":"getStatDataFields_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/endpointTracker/page":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_16","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_16","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/endpointTracker/query/fields":{"get":{"tags":["Monitoring - Endpoint Tracker Status"],"description":"Get query fields","operationId":"getStatQueryFields_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fields":{"get":{"description":"Get fields and type","operationId":"getStatDataFields_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/flowlog":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get stats raw data","operationId":"getStatDataRawData_14","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}},{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"entry_time":1715135940274,"statcycletime":1715135940274,"vpn_id":4294967295,"src_ip":"192.168.1.10","dest_ip":"10.0.0.1","src_port":443,"dest_port":80,"dscp":0,"ip_proto":6,"ingress_intf":"eth0","egress_intf":"eth1","direction":"inbound","policy_name":"default_rule","action":"allow","start_time":1654041600,"total_pkts":100,"total_bytes":1024,"flow_active":"yes","vdevice_name":"172.16.254.1","vmanage_system_ip":"10.0.0.1","host_name":"server1","device_model":"modelX","stats_data_id":"uuid1234","tenant":"feb962f1-a182-4516-997e-4beb9c31515c"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Flowlog"],"description":"Get stats raw data","operationId":"getStatDataRawDataPost","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"entry_time":1715135940274,"statcycletime":1715135940274,"vpn_id":4294967295,"src_ip":"192.168.1.10","dest_ip":"10.0.0.1","src_port":443,"dest_port":80,"dscp":0,"ip_proto":6,"ingress_intf":"eth0","egress_intf":"eth1","direction":"inbound","policy_name":"default_rule","action":"allow","start_time":1654041600,"total_pkts":100,"total_bytes":1024,"flow_active":"yes","vdevice_name":"172.16.254.1","vmanage_system_ip":"10.0.0.1","host_name":"server1","device_model":"modelX","stats_data_id":"uuid1234","tenant":"feb962f1-a182-4516-997e-4beb9c31515c"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/flowlog/aggregation":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_27","parameters":[{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowlogAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Flowlog"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_29","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowlogAggregationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/flowlog/csv":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_25","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/flowlog/doccount":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get response count of a query","operationId":"getFlowlogCount","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Flowlog"],"description":"Get response count of a query","operationId":"getFlowlogCountPost","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/flowlog/fields":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get fields and type","operationId":"getFlowlogFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStatDataFieldArray"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/flowlog/page":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get stats pagination raw data","operationId":"getStatsPaginationRawData_23","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"Scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowlogPaginationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Flowlog"],"description":"Get stats pagination raw data","operationId":"getStatsPaginationRawDataPost","parameters":[{"name":"scrollId","in":"query","description":"Scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowlogPaginationResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/flowlog/query/fields":{"get":{"tags":["Monitoring - Flowlog"],"description":"Get query fields","operationId":"getFlowlogQueryFields","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fwall":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getStatDataRawData_23","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getStatsRawData_23","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/fwall/aggregation":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_25","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_26","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/fwall/csv":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_23","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/fwall/doccount":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get response count of a query","operationId":"getCount_23","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get response count of a query","operationId":"getCountPost_23","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fwall/fields":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get fields and type","operationId":"getStatDataFields_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/fwall/page":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_21","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_21","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/fwall/query/fields":{"get":{"tags":["Monitoring - Umbrella Patterns"],"description":"Get query fields","operationId":"getStatQueryFields_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getStatDataRawData_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceQuery"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getStatsRawData_11","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.55.16"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceRespWithPageInfo"}},"examples":{"QueryFields":{"description":"QueryFields","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/aggregation":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24000"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","system","vmanage_system","eth0","loopback65528","ge0/0"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"}},"examples":{"Aggregated Data":{"description":"Aggregated Data","value":[{"entry_time":1673766000000,"count":1,"interface":"eth0","tx_kbps":0,"rx_kbps":1},{"entry_time":1673766000000,"count":1,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"eth0","tx_kbps":1.8333333333333333,"rx_kbps":0.8333333333333334},{"entry_time":1673769600000,"count":6,"interface":"ge0/0","tx_kbps":0.3333333333333333,"rx_kbps":2.8333333333333335},{"entry_time":1673769600000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":2,"interface":"system","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"ge0/0","tx_kbps":5,"rx_kbps":48.833333333333336},{"entry_time":1673771400000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_11","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","ge0/2","ge0/4","ge0/7","loopback1","loopback2"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggResp"}},"examples":{"Aggregated Data":{"description":"Aggregated Data","value":[{"entry_time":1673766000000,"count":1,"interface":"eth0","tx_kbps":0,"rx_kbps":1},{"entry_time":1673766000000,"count":1,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673766000000,"count":1,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673767800000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"eth0","tx_kbps":1.8333333333333333,"rx_kbps":0.8333333333333334},{"entry_time":1673769600000,"count":6,"interface":"ge0/0","tx_kbps":0.3333333333333333,"rx_kbps":2.8333333333333335},{"entry_time":1673769600000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":6,"interface":"loopback65528","tx_kbps":0,"rx_kbps":0},{"entry_time":1673769600000,"count":2,"interface":"system","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"eth0","tx_kbps":0,"rx_kbps":0},{"entry_time":1673771400000,"count":6,"interface":"ge0/0","tx_kbps":5,"rx_kbps":48.833333333333336},{"entry_time":1673771400000,"count":6,"interface":"ge0/1","tx_kbps":0,"rx_kbps":0}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/app-agg/aggregation":{"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_1","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query filter":{"description":"Query filter","value":{"query":{"condition":"AND","rules":[{"value":["2400"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/1","system","vmanage_system","eth0","loopback65528","ge0/0"],"field":"interface","type":"string","operator":"in"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}],"aggregation":{"field":[{"property":"interface","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"rx_kbps","type":"avg"},{"property":"tx_kbps","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/ccapacity/distribution":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get bandwidth distribution","operationId":"getBandwidthDistribution","parameters":[{"name":"site-id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapacityResp"},"examples":{"Bandwidth Distribution":{"description":"Bandwidth Distribution","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1.1.60.7"],"field":"vdevice_name","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"family","size":200,"sequence":1}],"metrics":[{"property":"octets","type":"sum","order":"desc"}]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/csv":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_11","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"example":"{\n \"blob\": https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd\n}"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/doccount":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get response count of a query","operationId":"getCount10","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get response count of a query","operationId":"getCountPost_11","requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/fields":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get fields and type","operationId":"getStatDataFields_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceDocCountRequest"}},"examples":{"Interface Fields":{"description":"Interface Fields","value":[{"property":"entry_time","dataType":"date"},{"property":"vip_idx","dataType":"number"},{"property":"statcycletime","dataType":"date"},{"property":"vdevice_name","dataType":"string"},{"property":"device_model","dataType":"string","display":"keyvalue"},{"property":"host_name","dataType":"string"},{"property":"vpn_id","dataType":"number"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/page":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getStatBulkRawData_2","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"},"examples":{"Response with page info":{"description":"Response with page info","value":[{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"system","tx_octets":0,"oper_status":"Up","rx_errors":0,"bw_down":10000,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Up","bw_up":10000,"interface_type":"logical","tenant":"default","entry_time":1673958142101,"vip_time":1673958142101,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":284,"host_name":"vm11","vpn_id":0,"id":"RQG-v4UBrf5pDUb4VeQc"},{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"ge0/5","tx_octets":0,"oper_status":"Down","rx_errors":0,"bw_down":0,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Down","bw_up":0,"interface_type":"physical","tenant":"default","entry_time":1673958414824,"vip_time":1673958414825,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":293,"host_name":"vm11","vpn_id":0,"id":"TgG-v4UBrf5pDUb4VeQc"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Interface Statistics"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData_2","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Query filter","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.55.16"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceAggRespWithPageInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/query/fields":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get query fields","operationId":"getStatQueryFields_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Interface Query Fields":{"description":"Interface Query Fields","value":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"Event Time","options":[{"enableDateFields":false,"number":"1","value":"Last 1 hour","key":"last_1_hour"},{"enableDateFields":false,"number":"3","value":"Last 3 hours","key":"last_3_hours"},{"enableDateFields":false,"number":"6","value":"Last 6 hours","key":"last_6_hours"},{"enableDateFields":false,"number":"12","value":"Last 12 hours","key":"last_12_hours"},{"enableDateFields":false,"number":"24","isSelected":true,"value":"Last 24 hours","key":"last_24_hours"},{"enableDateFields":false,"number":"168","value":"Last 7 days","key":"last_168_hours"},{"enableDateFields":true,"value":"Custom","key":"custom"}]}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/interface/type":{"get":{"tags":["Monitoring - Interface Statistics"],"description":"Get statistics per interface","operationId":"getStatisticsPerInterface","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["20.0.1.20"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceAggResp"},"examples":{"Interface by type":{"description":"Interface by type","value":[{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"system","tx_octets":0,"oper_status":"Up","rx_errors":0,"bw_down":10000,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Up","bw_up":10000,"interface_type":"logical","tenant":"default","entry_time":1673958142101,"vip_time":1673958142101,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":284,"host_name":"vm11","vpn_id":0,"id":"RQG-v4UBrf5pDUb4VeQc"},{"down_capacity_percentage":0,"tx_pps":0,"total_mbps":0,"device_model":"vedge-cloud","rx_kbps":0,"interface":"ge0/5","tx_octets":0,"oper_status":"Down","rx_errors":0,"bw_down":0,"tx_pkts":0,"tx_errors":0,"rx_octets":0,"statcycletime":1673959200022,"admin_status":"Down","bw_up":0,"interface_type":"physical","tenant":"default","entry_time":1673958414824,"vip_time":1673958414825,"af_type":"IPv4","rx_pkts":0,"rx_pps":0,"vmanage_system_ip":"172.16.255.21","tx_drops":0,"rx_drops":0,"tx_kbps":0,"vdevice_name":"172.16.255.21","up_capacity_percentage":0,"vip_idx":293,"host_name":"vm11","vpn_id":0,"id":"TgG-v4UBrf5pDUb4VeQc"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/ipsalert":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getStatDataRawData_21","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getStatsRawData_21","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/ipsalert/aggregation":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_23","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_24","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/ipsalert/csv":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_21","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/ipsalert/doccount":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get response count of a query","operationId":"getCount_21","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get response count of a query","operationId":"getCountPost_21","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/ipsalert/fields":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get fields and type","operationId":"getStatDataFields_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/ipsalert/page":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_19","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - IPsAlert"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_19","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/ipsalert/query/fields":{"get":{"tags":["Monitoring - IPsAlert"],"description":"Get query fields","operationId":"getStatQueryFields_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/nwa":{"post":{"tags":["Monitoring - Network Availability"],"description":"Get network availability raw data based on input query and filters.","operationId":"getAggregationDataByQuery_3","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["site"],"field":"type","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkAvailabilityResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/nwa/aggregation":{"post":{"tags":["Monitoring - Network Availability"],"description":"Get network availability aggregated data based on input query and filters.","operationId":"getPostAggregationDataByQuery_3","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"site availability table query string":{"description":"site availability table query string","$ref":"#/components/examples/SiteAvailabilityTable"},"link availability table query string":{"description":"link availability table query string","$ref":"#/components/examples/LinkAvailabilityTable"},"site availability chart query string":{"description":"site availability chart query string","$ref":"#/components/examples/SiteAvailabilityChart"},"link availability chart query string":{"description":"link availability chart query string","$ref":"#/components/examples/LinkAvailabilityChart"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkAvailabilityResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/statistics/nwa/details":{"post":{"tags":["Monitoring - Network Availability"],"description":"Get network availability aggregated data with details based on input query and filters.","operationId":"getDetailAggregationDataByQuery","parameters":[{"name":"includePrev","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"site availability table query string":{"description":"site availability table query string","$ref":"#/components/examples/SiteAvailabilityTable"},"link availability table query string":{"description":"link availability table query string","$ref":"#/components/examples/LinkAvailabilityTable"},"site availability chart query string":{"description":"site availability chart query string","$ref":"#/components/examples/SiteAvailabilityChart"},"link availability chart query string":{"description":"link availability chart query string","$ref":"#/components/examples/LinkAvailabilityChart"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkAvailabilityResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/statistics/on-demand/queue":{"get":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"gets current on-demand queue entries","operationId":"getQueueEntries","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue Entries":{"description":"Queue Entries","value":{"entries":[{"status":"COMPLETED","complete":true,"data_type":"ConnectionEvents","tenant_id":"default","start_time":0,"creationTime":1640765713644,"value":48,"completionTime":1640765718372,"end_time":0,"startProcessingTime":1640765717682,"time_period":"LAST_N_HOURS","id":"0a43d31b-fde9-400a-b0ed-319f72115323","device_id":"172.16.255.11"},{"status":"QUEUED","complete":false,"data_type":"DPI","tenant_id":"default","start_time":0,"creationTime":1640764758920,"value":24,"completionTime":0,"end_time":0,"startProcessingTime":0,"time_period":"LAST_N_HOURS","id":"93629fed-ec81-4f37-9c85-24b577191c9c","device_id":"10.0.1.17"},{"status":"COMPLETED","complete":true,"data_type":"DPI","tenant_id":"default","start_time":0,"creationTime":1640765915038,"value":48,"completionTime":1640765918258,"end_time":0,"startProcessingTime":1640765917678,"time_period":"LAST_N_HOURS","id":"d9111cd6-59ab-482c-bd95-41fdaba9fc5b","device_id":"172.16.255.11"},{"status":"QUEUED","complete":false,"data_type":"ConnectionEvents","tenant_id":"default","start_time":0,"creationTime":1640767377708,"value":24,"completionTime":0,"end_time":0,"startProcessingTime":0,"time_period":"LAST_N_HOURS","id":"544ce0e1-9f57-4266-b789-ed50d043761c","device_id":"10.0.1.17"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"},"post":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"Create on-demand troubleshooting queue entry","operationId":"createQueueEntry","requestBody":{"description":"On-demand queue entry","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"device_id":"10.0.1.17","data_type":"DPI","time_period":"LAST_N_HOURS","value":24}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"complete":false,"creationTime":1641373054019,"startProcessingTime":0,"completionTime":0,"id":"bc4e2dbe-a226-4a01-aa1a-1859978014d3","device_id":"169.254.10.10","data_type":"DPI","time_period":"LAST_N_HOURS","tenant_id":"a200c754-22bc-4a99-b0b9-a2957755e3ba","value":3,"start_time":0,"end_time":0,"status":"QUEUED"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/statistics/on-demand/queue/properties":{"get":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"gets current size of on-demand queue","operationId":"getQueueProperties","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Queue size is 2":{"description":"Queue size is 2","value":{"tenant_current_size":2,"max_size":20,"tenant_max_size":5}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read,RBAC VPN-write"}},"/statistics/on-demand/queue/{entryId}":{"put":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"Updates on-demand troubleshooting queue entry","operationId":"updateQueueEntry","parameters":[{"name":"entryId","in":"path","description":"Entry Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"On-demand queue entry","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"device_id":"10.0.1.17","data_type":"DPI","time_period":"LAST_N_HOURS","value":24}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"OnDemandQueueEntry":{"description":"OnDemandQueueEntry","value":{"id":"ac031e7b-9c6e-4375-8589-ad503f9d52d2","device_id":"10.0.1.17","data_type":"DPI","time_period":"LAST_N_HOURS","value":24}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"},"delete":{"tags":["Monitoring - DPI - On-demand troubleshooting"],"description":"removes on-demand queue entry","operationId":"deleteQueueEntry","parameters":[{"name":"entryId","in":"path","description":"Entry Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,RBAC VPN-read"}},"/statistics/page":{"get":{"description":"Get stats raw data","operationId":"getStatsPaginationRawData_10","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_10","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/perfmon/aggregation":{"post":{"tags":["Monitoring - Performance Monitor"],"summary":"one site one application line chart data","description":"Get one application one site line chart data ","operationId":"getPostAggregationDataByQuery_15","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"string"},"examples":{"all paths chart query string":{"description":"all paths chart query string","$ref":"#/components/examples/PerfmonPathChart"}}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSiteChartItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/application/heatmap/detail":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"single applicaiton site health detail in a time range","description":"Get single applicaiton site health detail in a time range ","operationId":"getApplicationHeatMapDetail","parameters":[{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"siteid","in":"query","schema":{"type":"string"}},{"name":"start_time","in":"query","description":"Heatmap single box entry_time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"heatmap_time","in":"query","description":"Heatmap generation time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"],"default":"12"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationHeatMapDetail"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/perfmon/application/site/health":{"post":{"tags":["Monitoring - Performance Monitor"],"summary":"one site one application health data","description":"Get one application health for one site ","operationId":"getApplicationSiteHealth","parameters":[{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"all paths table query string":{"description":"all paths table query string","$ref":"#/components/examples/PerfmonPathTable"}}}},"required":true},"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSiteItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/application/sites/health":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"all sites one application health data","description":"Get one application health for all sites ","operationId":"getApplicationSitesHealth","parameters":[{"name":"application","in":"query","required":true,"schema":{"type":"string"}},{"name":"isHeatMap","in":"query","schema":{"type":"boolean"}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationSitesItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/applications/site/health":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"one site all applications health data","description":"Get all applications health for one site ","operationId":"getApplicationsSiteHealth","parameters":[{"name":"siteid","in":"query","required":true,"schema":{"type":"string"}},{"name":"isHeatMap","in":"query","schema":{"type":"boolean"}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"includeUsage","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationsSiteItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/perfmon/applications/sites/health":{"get":{"tags":["Monitoring - Performance Monitor"],"summary":"all sites all applications health data","description":"Get applications health for all sites ","operationId":"getApplicationsSitesHealth","parameters":[{"name":"isHeatMap","in":"query","schema":{"type":"boolean"}},{"name":"last_n_hours","in":"query","schema":{"type":"string","enum":["1","3","6","12","24"]}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"includeUsage","in":"query","schema":{"type":"boolean","default":false}},{"name":"useCache","in":"query","description":"Use cache data","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationsSitesItem"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"Application Monitoring-read,Application Monitoring-write"}},"/statistics/process":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Process stats data","operationId":"processStatisticsData","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status":{"description":"Status","value":{"ActivateDataProcessing":"success"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/process/counters":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get statistics processing counters","operationId":"getStatisticsProcessingCounters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Statistics processing counters":{"description":"Statistics processing counters","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/process/status":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get stats process report","operationId":"generateStatsProcessReport","parameters":[{"name":"processQueue","in":"query","description":"Process queue","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Process report":{"description":"Process report","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/process/thread/status":{"get":{"tags":["Monitoring - Stats Processing"],"description":"Get stats process thread report","operationId":"generateStatsProcessThreadReport","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Process thread report":{"description":"Process thread report","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/statistics/qos":{"get":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getStatDataRawData_13","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSRespWithPageInfo"}},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getStatsRawData12","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","schema":{"type":"string"}},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","ASC","Asc","desc","DESC","Desc"]}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSRespWithPageInfo"}},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/aggregation":{"get":{"tags":["Monitoring - QoS"],"description":"Monitoring - QoS","operationId":"getAggregationDataByQuery_13","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"queue_name","sequence":1,"size":20}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"tx_bytes_in_kbps","type":"avg","order":"desc"},{"property":"drop_in_kbps","type":"avg"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSAggResp"}},"example":[{"entry_time":1678924800000,"count":72,"queue_name":"Queue4","drop_in_kbps":0,"tx_bytes_in_kbps":0},{"entry_time":1678924800000,"count":72,"queue_name":"Queue5","drop_in_kbps":0,"tx_bytes_in_kbps":0},{"entry_time":1678924800000,"count":72,"queue_name":"Queue6","drop_in_kbps":0,"tx_bytes_in_kbps":0}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_13","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]},"aggregation":{"field":[{"property":"queue_name","sequence":1,"size":20}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"tx_bytes_in_kbps","type":"avg","order":"desc"},{"property":"drop_in_kbps","type":"avg"}]},"sort":[{"field":"entry_time","type":"date","order":"asc"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSAggResp"}},"example":" [\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue4\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n },\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue5\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n },\n {\n \"entry_time\": 1678924800000,\n \"count\": 72,\n \"queue_name\": \"Queue6\",\n \"drop_in_kbps\": 0,\n \"tx_bytes_in_kbps\": 0\n }"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/app-agg/aggregation":{"post":{"tags":["Monitoring - QoS"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_2","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.16"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"number","operator":"in"}]},"aggregation":{"field":[{"property":"queue_name","sequence":1,"size":20}],"histogram":{"property":"entry_time","type":"hour","interval":6,"order":"asc"},"metrics":[{"property":"tx_bytes_in_kbps","type":"avg","order":"desc"},{"property":"drop_in_kbps","type":"avg"},{"property":"jitter","type":"avg"}],"sort":[{"property":"entry_time","type":"date","order":"desc"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QoSAggResp"}},"example":[{"entry_time":1678881600000,"count":72,"queue_name":"Queue1","drop_in_kbps":0,"jitter":0,"tx_bytes_in_kbps":0},{"entry_time":1678881600000,"count":72,"queue_name":"Queue2","drop_in_kbps":0,"jitter":0,"tx_bytes_in_kbps":0}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/csv":{"get":{"tags":["Monitoring - QoS"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV12","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"example":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/doccount":{"get":{"tags":["Monitoring - QoS"],"description":"Get response count of a query","operationId":"getCount13","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get response count of a query","operationId":"getCountPost13","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":{"count":17193}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/fields":{"get":{"tags":["Monitoring - QoS"],"description":"Get fields and type","operationId":"getStatDataFields13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/page":{"get":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getStatBulkRawData_3","parameters":[{"name":"query","in":"query","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}},{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QoSRespWithPageInfo"},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"647394800045,","endTime":"1647394800047,","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10,","hasMoreData":"true,","count":"5,","totalCount":11140}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - QoS"],"description":"Get stats raw data","operationId":"getPostStatBulkRawData12","parameters":[{"name":"scrollId","in":"query","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["12"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.11"],"field":"vdevice_name","type":"string","operator":"in"},{"value":["ge0/0"],"field":"interface","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QoSRespWithPageInfo"},"example":{"data":[{"drop_in_kbps":0,"device_model":"vedge-cloud","interface":"ge0/0","time_interval":300,"queued_pkts":0,"tx_pkts":0,"statcycletime":1676971800123,"drop_in_bytes":0,"tx_bytes":0,"tenant":"default","entry_time":1676971204628,"drop_in_pkts":0,"vip_time":1676971204628,"tail_drop_bytes":0,"tx_bytes_in_pps":0,"vmanage_system_ip":"172.16.255.11","queued_bytes":0,"queue_name":"Queue4","red_drop_bytes":0,"queued_bytes_in_kbps":0,"red_drop_pkts":0,"vdevice_name":"172.16.255.11","vip_idx":1448708,"drop_in_pps":0,"tail_drop_pkts":0,"tx_bytes_in_kbps":0,"host_name":"vm1","id":"z7ROc4YB8aNY7Lff9mZW"}],"pageInfo":{"startTime":"647394800045,","endTime":"1647394800047,","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==_10,","hasMoreData":"true,","count":"5,","totalCount":11140}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/qos/query/fields":{"get":{"tags":["Monitoring - QoS"],"description":"Get query fields","operationId":"getStatQueryFields_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QoSQueryFieldsResp"},"example":{"data":[{"isRequired":true,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"Event Time","options":[{"enableDateFields":false,"number":"1","value":"Last 1 hour","key":"last_1_hour"},{"enableDateFields":false,"number":"3","value":"Last 3 hours","key":"last_3_hours"},{"enableDateFields":false,"number":"6","value":"Last 6 hours","key":"last_6_hours"},{"enableDateFields":false,"number":"12","value":"Last 12 hours","key":"last_12_hours"},{"enableDateFields":false,"number":"24","isSelected":true,"value":"Last 24 hours","key":"last_24_hours"},{"enableDateFields":false,"number":"168","value":"Last 7 days","key":"last_168_hours"},{"enableDateFields":true,"value":"Custom","key":"custom"}]}],"header":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/query/fields":{"get":{"description":"Get query fields","operationId":"getStatQueryFields_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sdra/headends":{"get":{"tags":["Monitoring - SDRA"],"description":"Get SD-WAN Remote Access Head-end summary","operationId":"getSdraHeadendSummary","parameters":[{"name":"site","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdraHeadendSummary"},"examples":{"SDRA Head-end Summary":{"description":"SDRA Head-end Summary","value":" {\n \"ipsec_enabled\": 5,\n \"sslvpn_enabled\": 2,\n }\n"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sdra/sessions":{"get":{"tags":["Monitoring - SDRA"],"description":"Get SD-WAN Remote Access session summary","operationId":"getSdraSessionSummary","parameters":[{"name":"site","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdraSessionSummary"},"examples":{"SDRA Session Summary":{"description":"SDRA Session Summary","value":" {\n \"total\": {\n \"ipsec_anyconnect\": 50,\n \"ipsec_soho\": 20,\n \"ipsec_unknown\": 25,\n \"sslvpn_anyconnect\": 200,\n }, \"top\": [\n {\n \"system_ip\": \"1.1.1.1\",\n \"site_id\": 10,\n \"host_name\": vm10,\n \"ipsec_anyconnect\": 3,\n \"ipsec_soho\": 5,\n \"ipsec_unknown\": 11,\n \"sslvpn_anyconnect\": 0,\n },\n {\n \"system_ip\": \"2.2.2.2\",\n \"site_id\": 20,\n \"host_name\": vm20,\n \"ipsec_anyconnect\": 0,\n \"ipsec_soho\": 0,\n \"ipsec_unknown\": 0,\n \"sslvpn_anyconnect\": 85,\n }\n ]\n }\n"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/settings/disable/devicelist/{indexName}":{"get":{"tags":["Monitoring - Status"],"description":"Get list of disabled devices for a statistics index","operationId":"getDisabledDeviceList","parameters":[{"name":"indexName","in":"path","description":"Index name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Disabled device list":{"description":"Disabled device list","value":["172.16.255.14"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read"},"put":{"tags":["Monitoring - Status"],"description":"Update list of disabled devices for a statistics index","operationId":"updateStatisticsDeviceList","parameters":[{"name":"indexName","in":"path","description":"Index name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Disabled device","content":{"application/json":{"schema":{"type":"object"},"examples":{"Disabled device":{"description":"Disabled device","value":["172.16.255.14"]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update status":{"description":"Update status","value":{"response":true}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write"}},"/statistics/settings/status":{"get":{"tags":["Monitoring - Status"],"description":"Get statistics settings","operationId":"getStatisticsSettings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Statistics settings":{"description":"Statistics settings","value":[{"indexName":"approutestatsstatistics","status":"enable","displayName":"Approute"},{"indexName":"interfacestatistics","status":"enable","displayName":"Interface"},{"indexName":"wlanclientinfostatistics","status":"enable","displayName":"Wlan Client Info"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read,dca"},"put":{"tags":["Monitoring - Status"],"description":"Update statistics settings","operationId":"updateStatisticsSettings","requestBody":{"description":"Stats setting","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats setting":{"description":"Stats setting","value":[{"indexName":"interfacestatistics","status":"enable"}]}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-write,dca"}},"/statistics/settings/status/device":{"get":{"tags":["Monitoring - Status"],"description":"Get list of enabled device for statistics index","operationId":"getEnabledIndexForDevice","parameters":[{"name":"deviceId","in":"query","description":"Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Enabled device":{"description":"Enabled device","value":["interfacestatistics","eioltestatistics","sulstatistics","qosstatistics","devicesystemstatusstatistics","bridgemacstatistics","dpistatistics","approutestatsstatistics","wlanclientinfostatistics","flowlogstatistics","urlf","fwall","vnfstatistics","umbrella","apphostingstatistics","utddaqioxstatistics","ipsalert","aggregatedappsdpistatistics","bridgeinterfacestatistics","artstatistics","trackerstatistics","cloudxstatistics"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Settings-read"}},"/statistics/sitehealth":{"get":{"description":"Get stats raw data","operationId":"getStatDataRawData_3","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"description":"Get stats raw data","operationId":"getStatsRawData_3","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/sitehealth/aggregation":{"get":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_15","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"},"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events-2"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics-2"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS-2"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_16","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"generated by base class - Monitoring - Events":{"description":"generated by base class - Monitoring - Events","$ref":"#/components/examples/Events-2"},"generated by base class - Monitoring - Interface Statistics":{"description":"generated by base class - Monitoring - Interface Statistics","$ref":"#/components/examples/InterfaceStatistics-2"},"generated by base class - Monitoring - QoS":{"description":"generated by base class - Monitoring - QoS","$ref":"#/components/examples/QoS-2"},"generated by base class - Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"},"generated by base class - Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"},"generated by base class - Monitoring - IPsAlert":{"description":"generated by base class - Monitoring - IPsAlert","$ref":"#/components/examples/IPsAlert-2"},"generated by base class - Monitoring - Umbrella Patterns":{"description":"generated by base class - Monitoring - Umbrella Patterns","$ref":"#/components/examples/UmbrellaPatterns-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/sitehealth/common":{"get":{"tags":["Monitoring - SiteHealth Monitor"],"summary":"sitehealth data","description":"Get all site health ","operationId":"getSiteHealth","parameters":[{"name":"isHeatMap","in":"query","schema":{"type":"string","default":"false"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"interval","in":"query","schema":{"type":"integer","format":"int32","default":30}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"start_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"end_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"includeDetails","in":"query","schema":{"type":"string","default":"false"}},{"name":"includeRegion","in":"query","schema":{"type":"string","default":"false"}},{"name":"regionName","in":"query","schema":{"type":"string"}},{"name":"deviceType","in":"query","schema":{"type":"string","enum":["controller","vedge","all"]}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteHealthItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/sitehealth/csv":{"get":{"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_3","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/sitehealth/doccount":{"get":{"description":"Get response count of a query","operationId":"getCount_4","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"description":"Get response count of a query","operationId":"getCountPost_3","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sitehealth/fields":{"get":{"description":"Get fields and type","operationId":"getStatDataFields_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sitehealth/page":{"get":{"description":"Get stats raw data","operationId":"getStatsPaginationRawData_11","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_11","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sitehealth/query/fields":{"get":{"description":"Get query fields","operationId":"getStatQueryFields_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sitehealth/topology":{"get":{"tags":["Monitoring - SiteHealth Monitor"],"summary":"sitehealth data","description":"Get all site health topology ","operationId":"getSiteHealthTopology","parameters":[{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"start_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"end_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"interval","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteHealthTopologyItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/speedtest":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatDataRawData_25","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatsRawData_25","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/speedtest/aggregation":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_28","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_30","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/speedtest/csv":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_26","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/speedtest/doccount":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get response count of a query","operationId":"getCount_25","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get response count of a query","operationId":"getCountPost_25","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/speedtest/fields":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get fields and type","operationId":"getStatDataFields_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/speedtest/page":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_24","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_23","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/speedtest/query/fields":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get query fields","operationId":"getStatQueryFields_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get security connection events stats raw data","operationId":"getSulStatDataRawData","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","fw_zone_pair":"ulogging_in2out","statcycletime":1616121001459,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616120034778,"create_time":1616120009235,"fw_dst_zone":"ulogging_z_out","end_time":1616120024267,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_src_zone":"ulogging_z_in","fw_policy":"p1","src_port":34128,"start_time":1616120009235,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"103.235.46.39","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"_dlRSHgBQcANHsKKdbP0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get stats raw data","operationId":"getStatsRawData_14","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","fw_zone_pair":"ulogging_in2out","statcycletime":1616121001459,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616120034778,"create_time":1616120009235,"fw_dst_zone":"ulogging_z_out","end_time":1616120024267,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_src_zone":"ulogging_z_in","fw_policy":"p1","src_port":34128,"start_time":1616120009235,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"103.235.46.39","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"_dlRSHgBQcANHsKKdbP0"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sul/connections/aggregation":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_16","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated each result":{"description":"Aggregated each result","value":{"data":[{"latency":0.6404125644631974}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_17","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":{"data":[{"ip_proto":6,"device_model":"vedge-CSR-1000v","egress_intf":"cpu","packets":5,"src_ip":"10.20.24.1","statcycletime":1616170802027,"octets":300,"sdvt_drop_reason_name":"Service Node not healthy","tenant":"default","dest_port":80,"entry_time":1616170026992,"create_time":1616170001492,"end_time":1616170016505,"fw_action":"Pass","vmanage_system_ip":"172.16.255.15","fw_policy":"p1","src_port":53105,"start_time":1616170001492,"application":"unknown","fw_protocol":"http","ingress_intf":"GigabitEthernet5","fw_class":"1","vdevice_name":"172.16.255.15","dest_ip":"90.130.70.73","vip_idx":1,"family":"network-service","host_name":"vm5","vpn_id":1,"id":"uNlJS3gBQcANHsKKW_5s"}],"pageInfo":{"startTime":"1615956601540","endTime":"1616170802027","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAQXMWSm81WWtQX1NUeXU4UnpKYm9VV2Nudw==_500","hasMoreData":false,"count":14,"totalCount":14}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/sul/connections/app-agg/aggregation":{"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationAppDataByQuery_3","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"field":"latency","type":"long","value":["1"],"operator":"greater"},"fields":["latency"],"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregated search result":{"description":"Aggregated search result","value":{"data":[{"latency":0.6404125644631974}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,dca"}},"/statistics/sul/connections/csv":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_14","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["168"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["1"],"field":"vpn_id","type":"int","operator":"in"},{"value":["p1"],"field":"fw_policy","type":"string","operator":"in"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sul/connections/doccount":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get response count of a query","operationId":"getCount_14","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get response count of a query","operationId":"getCountPost_14","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"},{"value":["172.16.255.15"],"field":"vdevice_name","type":"string","operator":"in"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections/fields":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get fields and type","operationId":"getStatDataFields_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections/filter/policy_name/{policyType}":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get filter Policy Name list","operationId":"getFilterPolicyNameList","parameters":[{"name":"policyType","in":"path","description":"Policy type","required":true,"schema":{"type":"string","enum":["zoneBasedFW","intrusionPrevention","urlFiltering","advancedMalwareProtection"]}},{"name":"query","in":"query","description":"query string","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"field":"vdevice_name","type":"string","operator":"in","value":["172.16.255.15"]}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Filter Policy Name list":{"description":"Filter Policy Name list","value":[{"fw_policy":"FW-Block-AV"},{"fw_policy":"FW-Block-p2p"},{"fw_policy":"FW_policy1"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/sul/connections/page":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_12","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_12","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/sul/connections/query/fields":{"get":{"tags":["Monitoring - Security Unified Logging Connection Events"],"description":"Get query fields","operationId":"getStatQueryFields_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getStatDataRawData_16","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getStatsRawData_16","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/system/aggregation":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_18","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_19","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/system/cpu":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get device system CPU stats list","operationId":"createDeviceSystemCPUStat","parameters":[{"name":"query","in":"query","description":"Query filter","required":true,"schema":{"type":"string","example":"{\"query\":{\"condition\":\"AND\",\"rules\":[{\"value\":[\"1\"],\"field\":\"entry_time\",\"type\":\"date\",\"operator\":\"last_n_hours\"},{\"value\":[\"172.16.255.11\"],\"field\":\"vdevice_name\",\"type\":\"string\",\"operator\":\"in\"}]}}"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"mem_used":842211328,"disk_avail":7370178560,"device_model":"vedge-cloud","mem_cached":440655872,"mem_util":0.43,"min1_avg":1.05,"disk_used":168906752,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925196144,"runningp":0,"cpu_user":1.15,"cpu_idle_new":94.86,"vip_time":1656925196144,"min15_avg":1.08,"totalp":325,"cpu_idle":94.86,"mem_buffers":76447744,"cpu_system":3.99,"vmanage_system_ip":"172.16.255.11","min5_avg":1.07,"cpu_min1_avg":1.05,"mem_free":597938176,"vdevice_name":"172.16.255.11","vip_idx":6977,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.15,"cpu_system_new":3.99,"host_name":"vm1","cpu_min5_avg":1.07,"id":"ZE2UyIEBC5z8Ij_cxb8R"},{"mem_used":842907648,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.06,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925256204,"runningp":0,"cpu_user":10.17,"cpu_idle_new":76.16,"vip_time":1656925256205,"min15_avg":1.08,"totalp":326,"cpu_idle":76.16,"mem_buffers":76447744,"cpu_system":13.67,"vmanage_system_ip":"172.16.255.11","min5_avg":1.07,"cpu_min1_avg":1.06,"mem_free":596877312,"vdevice_name":"172.16.255.11","vip_idx":6978,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":10.17,"cpu_system_new":13.67,"host_name":"vm1","cpu_min5_avg":1.07,"id":"W02UyIEBC5z8Ij_cxb8R"},{"mem_used":842715136,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.02,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925316264,"runningp":0,"cpu_user":1.34,"cpu_idle_new":92.22,"vip_time":1656925316264,"min15_avg":1.08,"totalp":326,"cpu_idle":92.22,"mem_buffers":76447744,"cpu_system":6.44,"vmanage_system_ip":"172.16.255.11","min5_avg":1.06,"cpu_min1_avg":1.02,"mem_free":597069824,"vdevice_name":"172.16.255.11","vip_idx":6979,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.34,"cpu_system_new":6.44,"host_name":"vm1","cpu_min5_avg":1.06,"id":"XE2UyIEBC5z8Ij_cxb8R"},{"mem_used":842813440,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.01,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925376319,"runningp":0,"cpu_user":1.17,"cpu_idle_new":94.02,"vip_time":1656925376319,"min15_avg":1.07,"totalp":326,"cpu_idle":94.02,"mem_buffers":76447744,"cpu_system":4.81,"vmanage_system_ip":"172.16.255.11","min5_avg":1.04,"cpu_min1_avg":1.01,"mem_free":596971520,"vdevice_name":"172.16.255.11","vip_idx":6980,"cpu_min15_avg":1.07,"system_ip":"172.16.255.11","cpu_user_new":1.17,"cpu_system_new":4.81,"host_name":"vm1","cpu_min5_avg":1.04,"id":"XU2UyIEBC5z8Ij_cxb8R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/csv":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_16","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/system/doccount":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get response count of a query","operationId":"getCount_16","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get response count of a query","operationId":"getCountPost_16","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/fields":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get fields and type","operationId":"getStatDataFields_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/memory":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get device system memory stats list","operationId":"createDeviceSystemMemoryStat","parameters":[{"name":"query","in":"query","description":"Query filter","required":true,"schema":{"type":"string","example":"{\"query\":{\"condition\":\"AND\",\"rules\":[{\"value\":[\"1\"],\"field\":\"entry_time\",\"type\":\"date\",\"operator\":\"last_n_hours\"},{\"value\":[\"172.16.255.11\"],\"field\":\"vdevice_name\",\"type\":\"string\",\"operator\":\"in\"}]}}"}},{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device system stats":{"description":"Device system stats","value":{"data":[{"mem_used":842715136,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.02,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925316264,"runningp":0,"cpu_user":1.34,"cpu_idle_new":92.22,"vip_time":1656925316264,"min15_avg":1.08,"totalp":326,"cpu_idle":92.22,"mem_buffers":76447744,"cpu_system":6.44,"vmanage_system_ip":"172.16.255.11","min5_avg":1.06,"cpu_min1_avg":1.02,"mem_free":597069824,"vdevice_name":"172.16.255.11","vip_idx":6979,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.34,"cpu_system_new":6.44,"host_name":"vm1","cpu_min5_avg":1.06,"id":"XE2UyIEBC5z8Ij_cxb8R"},{"mem_used":842813440,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441020416,"mem_util":0.43,"min1_avg":1.01,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925376319,"runningp":0,"cpu_user":1.17,"cpu_idle_new":94.02,"vip_time":1656925376319,"min15_avg":1.07,"totalp":326,"cpu_idle":94.02,"mem_buffers":76447744,"cpu_system":4.81,"vmanage_system_ip":"172.16.255.11","min5_avg":1.04,"cpu_min1_avg":1.01,"mem_free":596971520,"vdevice_name":"172.16.255.11","vip_idx":6980,"cpu_min15_avg":1.07,"system_ip":"172.16.255.11","cpu_user_new":1.17,"cpu_system_new":4.81,"host_name":"vm1","cpu_min5_avg":1.04,"id":"XU2UyIEBC5z8Ij_cxb8R"},{"mem_used":842711040,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441024512,"mem_util":0.43,"min1_avg":1.11,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925436376,"runningp":0,"cpu_user":1.24,"cpu_idle_new":93.19,"vip_time":1656925436376,"min15_avg":1.08,"totalp":326,"cpu_idle":93.19,"mem_buffers":76447744,"cpu_system":5.57,"vmanage_system_ip":"172.16.255.11","min5_avg":1.07,"cpu_min1_avg":1.11,"mem_free":597069824,"vdevice_name":"172.16.255.11","vip_idx":6981,"cpu_min15_avg":1.08,"system_ip":"172.16.255.11","cpu_user_new":1.24,"cpu_system_new":5.57,"host_name":"vm1","cpu_min5_avg":1.07,"id":"Xk2UyIEBC5z8Ij_cxb8R"},{"mem_used":842600448,"disk_avail":7369719808,"device_model":"vedge-cloud","mem_cached":441069568,"mem_util":0.43,"min1_avg":1.04,"disk_used":169365504,"statcycletime":1656927601936,"tenant":"default","entry_time":1656925496428,"runningp":0,"cpu_user":1.3,"cpu_idle_new":93.16,"vip_time":1656925496428,"min15_avg":1.07,"totalp":326,"cpu_idle":93.16,"mem_buffers":76447744,"cpu_system":5.54,"vmanage_system_ip":"172.16.255.11","min5_avg":1.05,"cpu_min1_avg":1.04,"mem_free":597135360,"vdevice_name":"172.16.255.11","vip_idx":6982,"cpu_min15_avg":1.07,"system_ip":"172.16.255.11","cpu_user_new":1.3,"cpu_system_new":5.54,"host_name":"vm1","cpu_min5_avg":1.05,"id":"X02UyIEBC5z8Ij_cxb8R"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/page":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_14","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_14","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/query/fields":{"get":{"tags":["Real-Time Monitoring - Device System Stats"],"description":"Get query fields","operationId":"getStatQueryFields_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/stats":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getStatDataRawData_17","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getStatsRawData_17","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/system/stats/aggregation":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_19","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_20","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/system/stats/csv":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_17","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/system/stats/doccount":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get response count of a query","operationId":"getCount_17","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get response count of a query","operationId":"getCountPost_17","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/stats/fields":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get fields and type","operationId":"getStatDataFields_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/system/stats/page":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_15","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - System Status Stats"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_15","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/system/stats/query/fields":{"get":{"tags":["Monitoring - System Status Stats"],"description":"Get query fields","operationId":"getStatQueryFields_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/tunnelhealth/history":{"get":{"tags":["Monitoring - Tunnel Health"],"summary":"Tunnel health history data","description":"Get all tunnel health history ","operationId":"statisticsApprouteTunnelhealthHistoryGet","parameters":[{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthHistoryItem"}}}}},"400":{"description":"bad input parameter"}}}},"/statistics/tunnelhealth/overview/{type}":{"get":{"tags":["Monitoring - Tunnel Health"],"summary":"Tunnel health overview data","description":"Get all tunnel health overview ","operationId":"statisticsApprouteTunnelhealthOverviewTypeGet","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelHealthOverview"}}}},"400":{"description":"bad input parameter"}}}},"/statistics/umbrella":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getStatDataRawData_24","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getStatsRawData_24","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/umbrella/aggregation":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_26","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Umbrella"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_27","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - Umbrella":{"description":"generated by base class - Monitoring - Umbrella","$ref":"#/components/examples/Umbrella-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/umbrella/csv":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_24","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/umbrella/doccount":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get response count of a query","operationId":"getCount_24","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Umbrella"],"description":"Get response count of a query","operationId":"getCountPost_24","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/umbrella/fields":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get fields and type","operationId":"getStatDataFields_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/umbrella/page":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_22","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Umbrella"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_22","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/umbrella/query/fields":{"get":{"tags":["Monitoring - Umbrella"],"description":"Get query fields","operationId":"getStatQueryFields_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/urlf":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getStatDataRawData_22","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getStatsRawData_22","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/urlf/aggregation":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_24","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_25","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Monitoring - URL Filtering":{"description":"generated by base class - Monitoring - URL Filtering","$ref":"#/components/examples/URLFiltering-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/urlf/csv":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_22","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/urlf/doccount":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get response count of a query","operationId":"getCount_22","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get response count of a query","operationId":"getCountPost_22","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/urlf/fields":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get fields and type","operationId":"getStatDataFields_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/urlf/page":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_20","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - URL Filtering"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_20","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/urlf/query/fields":{"get":{"tags":["Monitoring - URL Filtering"],"description":"Get query fields","operationId":"getStatQueryFields_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/vnfstatistics":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getStatDataRawData_12","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getStatsRawData_12","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/vnfstatistics/aggregation":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_12","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_12","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/vnfstatistics/csv":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_12","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/vnfstatistics/doccount":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get response count of a query","operationId":"getCount_12","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get response count of a query","operationId":"getCountPost_12","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/vnfstatistics/fields":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get fields and type","operationId":"getStatDataFields_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/vnfstatistics/page":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_9","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_9","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/vnfstatistics/query/fields":{"get":{"tags":["Monitoring - VNF Interface Statistics"],"description":"Get query fields","operationId":"getStatQueryFields_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/wlanclientinfo":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getStatDataRawData_19","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"metrics":[{"property":"latency","type":"avg"}]}}},{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by(emp:entry_time)","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order(emp:asc\u3001ASC\u3001Asc\u3001desc\u3001Desc\u3001DESC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"3g","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.101.2","local_color":"lte","src_ip":"10.1.14.14","sla_class_names":"None","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400056,"state":"Up","local_system_ip":"172.16.255.14","tenant":"default","entry_time":1589073792008,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.14","fec_rx":0,"src_port":12380,"jitter":1,"remote_system_ip":"172.16.255.11","vdevice_name":"172.16.255.14","proto":"IPSEC","vip_idx":190,"dst_port":12366,"name":"172.16.255.14:lte-172.16.255.11:3g","sla_class_list":"0","tunnel_color":"3g:lte","host_name":"vm4","id":"4OBG_HEB_JLsavezVUfr"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getStatsRawData_19","parameters":[{"name":"page","in":"query","description":"page number","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"page size","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"sort by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"sort order","schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"name","sequence":1},{"property":"proto","sequence":2}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"},"metrics":[{"property":"latency","type":"avg"},{"property":"loss","type":"avg"},{"property":"loss_percentage","type":"avg"},{"property":"vqoe_score","type":"avg"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"remote_color":"lte","fec_re":0,"vqoe_score":10,"device_model":"vedge-cloud","latency":1,"tx_octets":0,"dst_ip":"10.0.106.1","local_color":"lte","src_ip":"10.1.15.15","sla_class_names":"test_sla_class","loss":0,"total":600,"tx_pkts":0,"fec_tx":0,"rx_octets":0,"statcycletime":1589075400052,"state":"Up","local_system_ip":"172.16.255.15","tenant":"default","entry_time":1589073783045,"loss_percentage":0,"rx_pkts":0,"vmanage_system_ip":"172.16.255.15","fec_rx":0,"src_port":12366,"jitter":1,"remote_system_ip":"172.16.255.16","vdevice_name":"172.16.255.15","proto":"IPSEC","vip_idx":351,"dst_port":12386,"name":"172.16.255.15:lte-172.16.255.16:lte","sla_class_list":"0,1","tunnel_color":"lte:lte","host_name":"vm5","id":"IuBG_HEB_JLsavezVkiZ"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/wlanclientinfo/aggregation":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getAggregationDataByQuery_21","parameters":[{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"},"examples":{"query string":{}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"getPostAggregationDataByQuery_22","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"query string":{}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca"}},"/statistics/wlanclientinfo/csv":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get raw data with optional query as CSV","operationId":"getStatDataRawDataAsCSV_19","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"text/csv":{"schema":{"type":"string"},"examples":{"Search result in csv format":{"description":"Search result in csv format","value":"blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/statistics/wlanclientinfo/doccount":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get response count of a query","operationId":"getCount_19","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":17193}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get response count of a query","operationId":"getCountPost_19","requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query":{"description":"Query","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"count":9642}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/wlanclientinfo/fields":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get fields and type","operationId":"getStatDataFields_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"example":[{"dataType":"string","property":"mac"},{"dataType":"string","property":"vap"},{"dataType":"number","property":"rssi"},{"dataType":"string","property":"mode"},{"dataType":"number","property":"bandwidth"},{"dataType":"string","property":"data_security"},{"dataType":"number","property":"rx_rate"},{"dataType":"string","property":"assoc_time"},{"dataType":"date","property":"entry_time"},{"dataType":"date","property":"statcycletime"},{"dataType":"string","property":"ssid"},{"dataType":"number","property":"vip_idx"},{"dataType":"date","property":"vip_time"},{"dataType":"string","property":"vdevice_name"},{"dataType":"string","property":"host_name"},{"dataType":"string","property":"device_model"}]}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/statistics/wlanclientinfo/page":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getStatsPaginationRawData_17","parameters":[{"name":"query","in":"query","description":"Query string","schema":{"type":"string"},"example":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}},{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"},"post":{"tags":["Monitoring - Wlan Client Info"],"description":"Get stats raw data","operationId":"getPostStatsPaginationRawData_17","parameters":[{"name":"scrollId","in":"query","description":"ES scroll Id","schema":{"type":"string"},"example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ=="},{"name":"count","in":"query","description":"Result size","schema":{"type":"integer","format":"int64"},"example":10}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"Stats query string":{"description":"Stats query string","value":{"query":{"condition":"AND","rules":[{"value":["24"],"field":"entry_time","type":"date","operator":"last_n_hours"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Search result":{"description":"Search result","value":{"data":[{"mem_used":19407626240,"disk_avail":9305948160,"device_model":"vmanage","mem_cached":6740430848,"mem_util":0.59,"min1_avg":0.92,"disk_used":5789007872,"statcycletime":1647394800045,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647393870251,"runningp":0,"cpu_user":8.63,"cpu_idle_new":88.14,"vip_time":1647393870252,"min15_avg":1.08,"totalp":2427,"cpu_idle":88.14,"mem_buffers":892911616,"cpu_system":3.23,"vmanage_system_ip":"169.254.10.2","min5_avg":1.07,"cpu_min1_avg":0.115,"mem_free":5716930560,"vdevice_name":"172.16.255.201","vip_idx":82,"cpu_min15_avg":0.135,"system_ip":"172.16.255.201","cpu_user_new":8.63,"cpu_system_new":3.23,"host_name":"vm201","cpu_min5_avg":0.13375,"id":"4YphkH8BPIGvVbrdtzXi"},{"mem_used":19534016512,"disk_avail":9304268800,"device_model":"vmanage","mem_cached":6747897856,"mem_util":0.6,"min1_avg":1.14,"disk_used":5790687232,"statcycletime":1647394800046,"tenant":"57501bad-32a7-4f52-8f54-8547dcd7403e","entry_time":1647394110479,"runningp":0,"cpu_user":5.53,"cpu_idle_new":91.49,"vip_time":1647394110479,"min15_avg":1.1,"totalp":2323,"cpu_idle":91.49,"mem_buffers":902213632,"cpu_system":2.97,"vmanage_system_ip":"169.254.10.2","min5_avg":1.14,"cpu_min1_avg":0.1425,"mem_free":5573771264,"vdevice_name":"172.16.255.201","vip_idx":86,"cpu_min15_avg":0.1375,"system_ip":"172.16.255.201","cpu_user_new":5.53,"cpu_system_new":2.97,"host_name":"vm201","cpu_min5_avg":0.1425,"id":"5YphkH8BPIGvVbrdtzXi"}],"pageInfo":{"startTime":"1647394800045","endTime":"1647394800047","scrollId":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ==","hasMoreData":true,"count":2,"totalCount":11140}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/statistics/wlanclientinfo/query/fields":{"get":{"tags":["Monitoring - Wlan Client Info"],"description":"Get query fields","operationId":"getStatQueryFields_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"property":"entry_time","name":"Event Time","isRequired":true,"dataType":"date","fieldData":{"type":"dateList"},"options":[{"key":"last_1_hour","value":"Last 1 hour","number":"1","enableDateFields":false},{"key":"last_3_hours","value":"Last 3 hours","number":"3","enableDateFields":false},{"key":"last_6_hours","value":"Last 6 hours","number":"6","enableDateFields":false},{"key":"last_12_hours","value":"Last 12 hours","number":"12","enableDateFields":false},{"key":"last_24_hours","value":"Last 24 hours","number":"24","enableDateFields":false,"isSelected":true},{"key":"last_168_hours","value":"Last 7 days","number":"168","enableDateFields":false},{"key":"custom","value":"Custom","enableDateFields":true}]},{"property":"vdevice_name","name":"Device name","isRequired":true,"multiSelect":false,"dataType":"string"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/stream/device/capture":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Create packet capture session","operationId":"getSessionInfoCapture","requestBody":{"description":"Packet Capture Parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePacketCaptureReq"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/disable/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Disable packet capture session","operationId":"disablePacketCaptureSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisablePacketCaptureRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/download/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Download packet capture file","operationId":"downloadFile","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/forcedisbale/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Force stop packet capture session","operationId":"forceStopPcapSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForceStopPacketCaptureRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/start/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Start packet capture session","operationId":"startPcapSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/status/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get packet capture session status","operationId":"getFileDownloadStatus","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFileDownloadStatusRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/stop/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Stop packet capture session","operationId":"stopPcapSession","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PacketCaptureInfo"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/vnicsInfo/{vnfId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get vnic info by vrfId","operationId":"getVnicInfoByVnfId","parameters":[{"name":"vnfId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVnicInfoRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/capture/{deviceUUID}/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Form post packet capture","operationId":"formPostPacketCapture","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormPacketCaptureRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/log":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSessionInfoLog","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/disable/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"disableDeviceLog","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/download/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"downloadDebugLog","parameters":[{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/renew/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"renewSessionInfo","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/search/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"searchDeviceLog","parameters":[{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/sessions":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSessions","responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/sessions/clear/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"clearSession","parameters":[{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-write"}},"/stream/device/log/type":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getLogType","parameters":[{"name":"uuid","in":"query","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/log/{logType}/{deviceUUID}/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"streamLog","parameters":[{"name":"logType","in":"path","description":"Log type","required":true,"schema":{"type":"string"}},{"name":"deviceUUID","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"Session Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"string"}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/log/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getDeviceLog","parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Uuid"}},{"name":"logId","in":"query","schema":{"type":"integer","format":"int64","default":-1}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"x-roles-required":"Tools-read"}},"/stream/device/nwpi/activeFlowWithQuery":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get active flows for NWPI.","operationId":"activeFlowWithQuery","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveFlowResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/aggFlow":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get aggregated flow data for NWPI.","operationId":"getAggFlow","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggFlowResponsePayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/appQosData":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get QoS Application data for NWPI.","operationId":"getAppQosData","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"receivedTimestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppQosDataResponsePayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/appQosState":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get QoS Application state to received timestamp mapping for NWPI.","operationId":"getAppQosState","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppQosStateResponsePayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/concurrentData":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get concurrent data for NWPI.","operationId":"getConcurrentData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpitraceFlowRespPayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/concurrentDomainData":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get concurrent domain data for NWPI.","operationId":"getConcurrentDomainData","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrentDomainDataResponsePayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/currentTimestamp":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"operationId":"getCurrentTimestamp","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentTimestampResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/device/blist/del":{"delete":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Delete Device BlackList for NWPI.","operationId":"delDeviceBlack","parameters":[{"name":"systemIp","in":"query","description":"systemIp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceBlistDeleteResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/device/blist/get":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Device BlackList for NWPI.","operationId":"getDeviceBList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceBlistResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/deviceInfoBySite":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get device and interface data by site","operationId":"getDevicesAndInterfacesBySite","parameters":[{"name":"site_id","in":"query","description":"Site id","required":true,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"mode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadData"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/domainMetric":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"operationId":"getDomainMetric","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"domain","in":"query","required":true,"schema":{"type":"string"}},{"name":"firstTimestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lastTimestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceModel","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainMetricResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/eventAppHopList":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Trace Application and HopList for NWPI.","operationId":"getEventAppHopList","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string"}},{"name":"serverSideKey","in":"query","schema":{"type":"string"}},{"name":"clientSideKey","in":"query","schema":{"type":"string"}},{"name":"vpn","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventAppHopListResponsePayload"},"examples":{"event app hop list":{"description":"event app hop list","value":"{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-hoplist\",\"application\": \"smtp\",\"upHopListInfo\": [[ {\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\"}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\"}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\"}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\"}]]}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventAppScoreBandwidth":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Trace Event Application Performance Score and Bandwidth for NWPI.","operationId":"getEventAppScoreBandwidth","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"receivedTimestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","schema":{"type":"string"}},{"name":"serverSideKey","in":"query","schema":{"type":"string"}},{"name":"clientSideKey","in":"query","schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string"}},{"name":"vpn","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventAppScoreBandwidthResponsePayload"},"examples":{"event application score and bandwidth":{"description":"event application score and bandwidth","value":"{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-app-score-bandwidth\",\"data\": {\"received_timestamp\": 1647581328105,\"detail\": [{\"application\": \"smtp\",\"received_timestamp\":1647581328105,\"upHopListInfo\": [[{\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 249381,\"performanceScore\": 95,\"bandwidth\": 79998}],[{\"from\": \"4.4.1.1:PUBLIC_INTERNET\",\"to\": \"4.4.2.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 683820,\"performanceScore\": 95,\"bandwidth\": 207353.2}]],\"downHopListInfo\": [[{\"from\": \"4.4.2.1:PUBLIC_INTERNET\",\"to\": \"4.4.1.1:PUBLIC_INTERNET\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 15690,\"performanceScore\": 95,\"bandwidth\": 5598}],[{\"from\": \"4.4.2.1:MPLS\",\"to\": \"4.4.1.1:MPLS\",\"delay\": 768,\"loss\": 0,\"intervalbytes\": 20775,\"performanceScore\": 95,\"bandwidth\": 5472}]]}]}, \"tenant\":\"default\"}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventFlowFromAppHop":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Trace Event Flow From Application And Hop for NWPI.","operationId":"getEventFlowFromAppHop","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"direction","in":"query","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","required":true,"schema":{"type":"string"}},{"name":"deviceTraceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","schema":{"type":"string"}},{"name":"application","in":"query","schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string"}},{"name":"serverSideKey","in":"query","schema":{"type":"string"}},{"name":"clientSideKey","in":"query","schema":{"type":"string"}},{"name":"vpn","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventFlowFromAppHopResponsePayload"},"examples":{"event flow from app and hop":{"description":"event flow from app and hop","value":"{[{\"trace-id\": 8784,\"entry_time\": 1647581252409,\"type\": \"event-flow\",\"data\": {\"app_name\": \"smtp\",\"received_timestamp\": 1647581328105,\"direction\": \"upstream\",\"from\": \"4.4.1.1:MPLS\",\"to\": \"4.4.2.1:MPLS\",\"intervalActiveFlow\": 7,\"intervalFinFlow\": 7,\"inspectedFlow\": 7,\"qosCongestedFlow\": 0,\"slaViolatedFlow\": 0,\"asymmetryFlow\": 0,\"fifNotClassifiledFlow\": 0,\"pathChangedFlow\": 0,\"policyBypassedFlow\": 0,\"wanAsymmetryFlow\": 0},\"tenant\":\"default\"}]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventReadout":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Trace Event Readout for NWPI.","operationId":"getEventReadout","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","schema":{"type":"string"}},{"name":"vpn","in":"query","schema":{"type":"string"}},{"name":"userName","in":"query","schema":{"type":"string"}},{"name":"version","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventReadoutResponsePayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/eventReadoutBySite":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get event Readout By Site","operationId":"getEventReadoutBySite","parameters":[{"name":"site_id","in":"query","description":"site id","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","description":"last_n_hours","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"mode","in":"query","description":"mode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadData"},"examples":{"Get event Readout By Site":{"description":"Get event Readout By Site","value":{"data":[{"trace_id":160,"entry_time":1673499964222,"source_site":"500","device_ip":"N/A","vpn_id":"1","src_if":"N/A","src_ip":"N/A","src_port":"N/A","dst_ip":"N/A","dst_port":"N/A","src_pfx":"N/A","src_pfx_len":"N/A","dst_pfx":"N/A","dst_pfx_len":"N/A","app":"N/A","common_app":"N/A","app_grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace_name":"dd_test_0112_1","domain_mon":"disabled","qos_mon":"true","art_vis":"true","app_vis":"true","dia_vis":"N/A","hub_wan_vis":"true","sampling":"N/A","spl_intvl":"N/A","stop_time":1673503629842,"source_site_vmanage_version":"20.11.999-2486","state":"stopped","message":"Trace Stop successfully (auto stop)","warning":"","wan_drop_rate_threshold":5,"local_drop_rate_threshold":5,"detail":[{"application":"rtp-video","totalFlowNum":35,"dropSendPkts":[{"sendPkts":5485,"dropPkts":2072,"event":"LOCAL_DROP"}],"eventList":["FIF_DPI_NOT_CLASSIFIED","LOCAL_DROP"],"eventImpactedFlowNum":[{"event":"LOCAL_DROP","impactedFlowNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","impactedFlowNum":"8"}],"eventNum":[{"event":"LOCAL_DROP","eventNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","eventNum":"8"}],"eventHopStatistics":[{"event":"LOCAL_DROP","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"13","dropCauses":[{"dropCause":"MplsFragReq"}]}]},{"event":"FIF_DPI_NOT_CLASSIFIED","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"8","dropCauses":[]}]}],"eventHopTimeInfo":[{"eventHop":"FIF_DPI_NOT_CLASSIFIED+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"FIF_DPI_NOT_CLASSIFIED+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673499975847","endTime":"1673500050669","eventNum":"8"}]},{"eventHop":"LOCAL_DROP+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"LOCAL_DROP+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673500035854","endTime":"1673500053871","eventNum":"12"},{"startTime":"1673500032732","endTime":"1673500035864","eventNum":"2"}]}],"eventHopPolicyInfo":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/eventReadoutByTraces":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get event Readout By Traces","operationId":"getEventReadoutByTraces","parameters":[{"name":"trace_id","in":"query","description":"traceId","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"entry_time","in":"query","description":"entry_time","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"vpn","in":"query","description":"vpn","schema":{"type":"string"}},{"name":"userName","in":"query","description":"userName","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadData"},"examples":{"Get event Readout By Traces":{"description":"Get event Readout By Traces","value":{"data":[{"trace_id":160,"entry_time":1673499964222,"source_site":"500","device_ip":"N/A","vpn_id":"1","src_if":"N/A","src_ip":"N/A","src_port":"N/A","dst_ip":"N/A","dst_port":"N/A","src_pfx":"N/A","src_pfx_len":"N/A","dst_pfx":"N/A","dst_pfx_len":"N/A","app":"N/A","common_app":"N/A","app_grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace_name":"dd_test_0112_1","domain_mon":"disabled","qos_mon":"true","art_vis":"true","app_vis":"true","dia_vis":"N/A","hub_wan_vis":"true","sampling":"N/A","spl_intvl":"N/A","stop_time":1673503629842,"source_site_vmanage_version":"20.11.999-2486","state":"stopped","message":"Trace Stop successfully (auto stop)","warning":"","wan_drop_rate_threshold":5,"local_drop_rate_threshold":5,"detail":[{"application":"rtp-video","totalFlowNum":35,"dropSendPkts":[{"sendPkts":5485,"dropPkts":2072,"event":"LOCAL_DROP"}],"eventList":["FIF_DPI_NOT_CLASSIFIED","LOCAL_DROP"],"eventImpactedFlowNum":[{"event":"LOCAL_DROP","impactedFlowNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","impactedFlowNum":"8"}],"eventNum":[{"event":"LOCAL_DROP","eventNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","eventNum":"8"}],"eventHopStatistics":[{"event":"LOCAL_DROP","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"13","dropCauses":[{"dropCause":"MplsFragReq"}]}]},{"event":"FIF_DPI_NOT_CLASSIFIED","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"8","dropCauses":[]}]}],"eventHopTimeInfo":[{"eventHop":"FIF_DPI_NOT_CLASSIFIED+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"FIF_DPI_NOT_CLASSIFIED+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673499975847","endTime":"1673500050669","eventNum":"8"}]},{"eventHop":"LOCAL_DROP+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"LOCAL_DROP+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673500035854","endTime":"1673500053871","eventNum":"12"},{"startTime":"1673500032732","endTime":"1673500035864","eventNum":"2"}]}],"eventHopPolicyInfo":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/exportTrace":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Export NWPI Trace Data","operationId":"exportTrace","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Nwpi Trace Data File":{"description":"Nwpi Trace Data File","value":"{binary format response}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/finalizedData":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"finalizedData for NWPI.","operationId":"getFinalizedData","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpitraceFlowRespPayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/finalizedDomainData":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Domain data for NWPI.","operationId":"getFinalizedDomainData","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinalizedDomainDataResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/flowDetail":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"flowDetail for NWPI.","operationId":"getFlowDetail","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"flowId","in":"query","description":"flow id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiflowDetailRespPayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/flowMetric":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"flowMetric for NWPI.","operationId":"getFlowMetric","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"flowId","in":"query","description":"flow id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"firstTimestamp","in":"query","description":"first timestamp of xAxis","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lastTimestamp","in":"query","description":"last timestamp of xAxis","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiflowMetricRespPayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/getMonitorState":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"getMonitorState","operationId":"getMonitorState","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiDomainMonitorStateRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/importTrace":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Import Trace","operationId":"importTrace","parameters":[{"name":"newTraceName","in":"query","schema":{"type":"string"}}],"requestBody":{"description":"Trace Data File","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImportTraceRequest"}}},"required":true},"responses":{"200":{"description":"Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportTraceResponse"},"examples":{"Success Response":{"description":"Success Response","value":{"state":true,"msg":"Trace imported successfully."}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}}},"/stream/device/nwpi/monitor/overrideStart":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"CXP Monitor Action - Override Start","operationId":"monitorOverrideStart","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiMonitorReqPayload"},"examples":{"Start CXP Monitor":{"description":"Start CXP Monitor","value":{"traceId":"160","clientIp":"N/A","domainAppGrp":"N/A","domainAppVis":"true","domainList":[{"domain":"proxy.esl.cisco.com+1","resolvedIp":[]}],"deviceToDomainId":[{"domain":"proxy.esl.cisco.com+1","mapping":[{"uuid":"C8K-7dc60c5b-8e9f-461a-a536-177a0382de49","domainId":2}]}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiMonitorRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/monitor/start":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"CXP Monitor Action - Start","operationId":"monitorStart","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiMonitorReqPayload"},"examples":{"Start CXP Monitor":{"description":"Start CXP Monitor","value":{"traceId":"160","clientIp":"N/A","domainAppGrp":"N/A","domainAppVis":"true","domainList":[{"domain":"proxy.esl.cisco.com+1","resolvedIp":[]}],"deviceToDomainId":[{"domain":"proxy.esl.cisco.com+1","mapping":[{"uuid":"C8K-7dc60c5b-8e9f-461a-a536-177a0382de49","domainId":2}]}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiMonitorRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/monitor/stop":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"CXP Monitor Action - Stop","operationId":"monitorStop","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiMonitorReqPayload"},"examples":{"Stop CXP Monitor":{"description":"Stop CXP Monitor","value":{"traceId":"160","clientIp":"N/A","domainAppGrp":"N/A","domainAppVis":"true","domainList":[{"domain":"proxy.esl.cisco.com+1","resolvedIp":[]}],"deviceToDomainId":[{"domain":"proxy.esl.cisco.com+1","mapping":[{"uuid":"C8K-7dc60c5b-8e9f-461a-a536-177a0382de49","domainId":2}]}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiMonitorRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/nwpiDSCP":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"operationId":"getNwpiDscp","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiDSCPResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/nwpiNbarAppGroup":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"operationId":"getNwpiNbarAppGroup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiNbarAppGroupResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/nwpiProtocol":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"operationId":"getNwpiProtocol","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiProtocolResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/nwpiSettingView":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"get NWPI setting","operationId":"nwpiSettingView","parameters":[{"name":"type","in":"query","description":"setting type","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiSettingDataPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"default"}},"/stream/device/nwpi/packetFeatures":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"packetFeatures for NWPI.","operationId":"getPacketFeatures","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"flowId","in":"query","description":"flow id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpipacketRespPayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/preloadinfo":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"operationId":"getPreloadInfo","parameters":[{"name":"mode","in":"query","description":"mode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiPreloadRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/query/fields":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get query fields","operationId":"getStatQueryFields_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFieldsResponsePayload"},"examples":{"Query result count":{"description":"Query result count","value":{"data":[{"isRequired":false,"fieldData":{"type":"dateList"},"dataType":"date","property":"entry_time","name":"Event Time","options":[{"enableDateFields":false,"number":"0.0167","value":"Last 1 m","key":"last_1_minute"},{"enableDateFields":false,"number":"0.167","value":"Last 10 m","key":"last_10_minute"},{"enableDateFields":false,"number":"0.5","value":"Last 30 m","key":"last_30_minute"},{"enableDateFields":false,"number":"1","value":"Last 1 hour","key":"last_1_hours"},{"number":"2","value":"Last 2 hour","key":"last_2_hours"},{"number":"5","isSelected":true,"value":"Last 5 hour","key":"last_5_hours"},{"enableDateFields":true,"value":"Custom","key":"custom"}],"isHidden":true},{"isRequired":false,"fieldData":{"type":"enum"},"dataType":"number","property":"data.vpn_id","name":"VPN Id","options":[],"multiSelect":true},{"isRequired":false,"dataType":"string","property":"data.app_name","name":"Application","placeholder":"separated by , example: box,google-services","validation":{"type":"string"},"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.src_ip","name":"Source IP","validation":{"type":"ip"},"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.src_port","name":"Source Port","validation":{"type":"long"},"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.dst_ip","name":"Destination IP","validation":{"type":"ip"},"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.dst_port","name":"Destination Port","validation":{"type":"long"},"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.protocol","name":"Protocol","validation":{"type":"string"},"multiSelect":false},{"isRequired":false,"fieldData":{"type":"enum"},"dataType":"string","property":"data.event","name":"Event","options":[{"value":"SLA Violation","key":"SLA_VIOLATION"},{"value":"WAN Loss","key":"WAN_DROP"},{"value":"Local Drop","key":"LOCAL_DROP"},{"value":"QoS Congestion","key":"QOS_CONGESTION"},{"value":"Server No Response","key":"SERVER_NO_RESPONSE"},{"value":"Flow Asymmetry","key":"FLOW_ASYMMETRY"},{"value":"Path Change","key":"PATH_CHANGE"},{"value":"DPI First Packet Unclassified","key":"FIF_DPI_NOT_CLASSIFIED"},{"value":"UTD Diverted","key":"UTD_DIVERTED"},{"value":"APPQoE Diverted","key":"APP_QOE_DIVERTED"},{"value":"Policy Bypass","key":"POLICY_BYPASS"}],"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.max_local_drop_rate","name":"Local Drop Rate(%)","validation":{"min":1,"max":100,"type":"number"},"isHidden":true,"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.max_wan_drop_rate","name":"Wan Loss Rate(%)","validation":{"min":1,"max":100,"type":"number"},"isHidden":true,"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.user_name","name":"User","validation":{"type":"string"},"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.thousand_eyes_test_ids","name":"ThousandEyes Test","disableUserActions":true,"multiSelect":false},{"isRequired":false,"dataType":"string","property":"data.flow_id","name":"Flow Id","validation":{"type":"long"},"multiSelect":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/routingDetail":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Routing Details for NWPI.","operationId":"getRoutingDetailFromLocal","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","required":true,"schema":{"type":"string"}},{"name":"routePrefixs","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingDetailResponsePayload"},"examples":{"Access list associations":{"description":"Access list associations","value":{"upstream":[{"hostname":"Site20-cEdge-1","system_ip":"4.4.4.2","route":"119.0.0.0/8","route_preference":1,"metric":0,"next_hop":{"outgoing_interface":"NULL0","next_hop_address":"168.19.1.200"},"source_protocol":"static","last_update_time":1646093417790}],"downstream":[{"hostname":"Site20-cEdge-2","system_ip":"4.4.4.3","route":"10.20.25.0/24","route_preference":1,"metric":0,"next_hop":{"outgoing_interface":"NULL0","next_hop_address":"168.19.1.201"},"source_protocol":"static","last_update_time":1646093417790}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/tasks/create":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Task Action - Create","operationId":"taskCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Create Trace Start Task with empty Duration":{"description":"Create Trace Start Task with empty Duration","value":{"taskName":"auto-on","events":["sla-violation","qos-congestion"],"sites":["100","500"],"duration":""}},"Create Trace Start Task with Duration":{"description":"Create Trace Start Task with Duration","value":{"taskName":"auto-on","events":["sla-violation","qos-congestion"],"sites":["100","500"],"duration":"1440"}},"Create Trace Start Task without Duration":{"description":"Create Trace Start Task without Duration","value":{"taskName":"auto-on","events":["sla-violation","qos-congestion"],"sites":["100","500"]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksCreateResponsePayload"},"examples":{"Create task response":{"description":"Create task response","value":{"action":"success","sites":["100","500"],"taskId":3,"taskName":"auto_on","entry_time":1716795211822,"expire-time":1716881611822,"state":"active"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/tasks/delete/{taskId}":{"delete":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Delete Auto On Task","operationId":"taskDelete","parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"string","example":"2"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksDeleteResponsePayload"},"examples":{"Delete task response":{"description":"Delete task response","value":{"action":"success","taskId":"2"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/tasks/eventStatsData":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get auto on stats data in one task","operationId":"getEventStatsData","parameters":[{"name":"taskId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"state","in":"query","required":true,"schema":{"type":"string"}},{"name":"taskEndTime","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"duration","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventStatsDataResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Routing-read,Routing-write"}},"/stream/device/nwpi/tasks/stop/{taskId}":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Task Action - Stop","operationId":"taskStop","parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"string","example":"2"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TasksStopResponsePayload"},"examples":{"Task stop response":{"description":"Task stop response","value":{"action":"success","taskId":2,"taskName":"auto-on","state":"finished","message":"Task Stop initiated successfully (user stop)","startTime":1716777834490}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/tasks/taskHistory":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get all the auto on tasks","operationId":"getTaskHistory","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskHistoryResponsePayload"},"examples":{"Response for getting tasks":{"description":"Response for getting tasks","value":{"header":{"generatedOn":1716795499234,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-nwpiTaskData"},"columns":[{"title":"Task Name","property":"taskName","dataType":"string"},{"title":"Task ID","property":"taskId","dataType":"number"},{"title":"Event(s)","property":"events","dataType":"array"},{"title":"Site(s)","property":"sites","dataType":"array"},{"title":"State","property":"state","dataType":"string"},{"title":"Start Time","property":"startTime","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"},{"title":"Duration","property":"duration","dataType":"string"},{"title":"Stop Time","property":"stopTime","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"}],"fields":[{"property":"taskName","dataType":"string"},{"property":"taskId","dataType":"number"},{"property":"events","dataType":"array"},{"property":"sites","dataType":"array"},{"property":"state","dataType":"string"},{"property":"startTime","dataType":"date"},{"property":"duration","dataType":"string"},{"property":"stopTime","dataType":"date"},{"property":"data","dataType":"object"}]},"data":[{"taskId":4,"taskName":"auto_on","duration":"600","events":"[\"qos-congestion\",\"sla-violation\"]","sites":"[\"100\",\"500\"]","sitesName":"[\"SITE_100\",\"SITE_500\"]","stopTime":1716831311226,"traces":false,"startTime":1716795311226,"entry_time":1716795311226,"state":"active","type":"task-history","insertTime":1716795499234},{"startTime":1716795211822,"taskId":3,"taskName":"auto_on","duration":"1440","events":"[\"qos-congestion\",\"sla-violation\"]","sites":"[\"100\",\"500\"]","sitesName":"[\"SITE_100\",\"SITE_500\"]","stopTime":1716795289048,"traces":"false","state":"finished","type":"task-history","tenant":"default"},{"startTime":1716443790022,"taskId":1,"taskName":"auto-on","duration":"1440","events":"[\"qos-congestion\",\"sla-violation\"]","sites":"[\"100\",\"400\",\"500\",\"600\"]","sitesName":"[\"SITE_100\",\"SITE_400\",\"SITE_500\",\"SITE_600\"]","stopTime":1716530190022,"traces":"true","state":"finished","type":"task-history","tenant":"default"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/tasks/{taskId}/traces":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get all traces in one task","operationId":"getTaskTrace","parameters":[{"name":"taskId","in":"path","description":"taskId","required":true,"schema":{"type":"string","example":"119"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskTracesResponsePayload"},"examples":{"Response for traces of task":{"description":"Response for traces of task","value":{"header":{"generatedOn":1716794459431,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-nwpiTraceData"},"columns":[{"title":"Start Time","property":"entry_time","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"},{"title":"Trace Id","property":"trace-id","dataType":"number"}],"fields":[{"property":"entry_time","dataType":"date"},{"property":"trace-id","dataType":"number"},{"property":"type","dataType":"string"},{"property":"data","dataType":"object"}]},"data":[{"entry_time":1716531432110,"trace-id":39600,"type":"trace-history","data":{"summary":{"source-site":"3","device-ip":"4.4.4.103","vpn-id":"0","vpn-list":"[\"10\"]","src-if":"N/A","src-ip":"N/A","src-port":"N/A","dst-ip":"N/A","dst-port":"N/A","src-pfx":"N/A","src-pfx-len":"N/A","dst-pfx":"N/A","dst-pfx-len":"N/A","app":"N/A","username":"N/A","common_app":"N/A","app-grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"6","trace-name":"auto_on-yicliu-security-demo1_security_drop_39600","domain-mon":"disabled","qos-mon":"true","art-vis":"true","app-vis":"true","dia-vis":"N/A","hub-wan-vis":"N/A","sampling":"N/A","spl-intvl":"N/A","stop-time":1716531870136,"source-site-vmanage-version":"20.15.0-12","taskId":119,"trace-trigger-event":"N/A","enable-cmd-header":"N/A","state":"stopped","message":"Trace Stop successfully (auto stop)","warning":"","wan-drop-rate-threshold":5,"local-drop-rate-threshold":5,"agg-client-prefix":"N/A","agg-svr-prefix":"N/A","agg-src-sgt":"N/A","agg-user-name":"N/A","tenant-id":"default","auto-on-task-name":"auto_on-yicliu-security-demo1","area-name":"Global","event-color":"none","sla-class":"none","event-vpn":"10","event-application":"none","up-bfd-session":4,"bfd-session-with-traffic":0,"peerSitesCount":0,"health-server-ip":"4.4.4.2","health-cpu-load":"37.77","health-mem-usage":"17","health-device-cpu-load":"16.74","health-device-mem-usage":"54","health-cpu-load-average":"0.85","health-cpu-core":"32","health-app-server-mem":"0.07","health-running-traces":2,"trace_stop_type":""},"devices":[{"device-ip":"4.4.4.103","local-system-ip":"4.4.4.103","source-site":"3","art-vis":"true","site-id":"3","uuid":"C8K-53b44a53-9467-481e-b595-2407df133b67","duration":"6","@rid":9135,"trace-id":39600,"device-type":"src","model":"AutoOn","state":"completed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531432110,"connectedVManages":"4.4.4.2","parent-trace-id":39600,"domain_monitor_can_be_started":"true","message":"Trace Done","vpn-id":"0","version":"17.15.01.6.385","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"auto_on-yicliu-security-demo1_security_drop_39600","expire-time":1716531792110,"tenantId":"default"},{"device-ip":"4.4.4.130","traceModel":1,"health-device-mem-usage":"54","source-site":"3","art-vis":"true","event-vpn":"10","uuid":"C8K-8d7c2053-93d3-45b9-b13c-5a6c1ea87092","health-running-traces":2,"wan-drop-rate-threshold":5,"trace-id":39600,"device-type":"notsrc","warning":"","model":"AutoOn","state":"completed","health-mem-usage":"17","qos-mon":"true","entry_time":1716531432110,"health-cpu-core":"32","local-drop-rate-threshold":5,"parent-trace-id":39600,"targetVmanageMgmtIp":"4.4.4.2","vpn-id":"0","version":"17.15.01.3.529","bfd-session-with-traffic":0,"vpn-list":"[\"10\"]","trace-name":"auto_on-yicliu-security-demo1_security_drop_39600","source-site-vmanage-version":"20.15.0-12","expire-time":1716531432116,"health-device-cpu-load":"16.74","local-system-ip":"4.4.4.130","event-application":"none","site-id":"30","health-app-server-mem":"0.07","duration":"6","@rid":8510,"dscp-is-valid":"false","connectedVManages":"4.4.4.2","health-cpu-load":"37.77","message":"Trace Done","health-cpu-load-average":"0.85","up-bfd-session":4,"peerSitesCount":0,"health-server-ip":"4.4.4.2","app-vis":"true","trace_stop_type":"","trace-trigger-event":"N/A","tenantId":"default"}],"readout":{"detail":[]},"flowTimeRange":{"start_time":1716531342000,"end_time":1716531711000}},"tenant":"default","traceModel":1},{"entry_time":1716531295367,"trace-id":39584,"type":"trace-history","data":{"summary":{"source-site":"","device-ip":"N/A","vpn-id":"0","vpn-list":"[\"1\",\"996\",\"10\"]","src-if":"N/A","src-ip":"N/A","src-port":"N/A","dst-ip":"N/A","dst-port":"N/A","src-pfx":"N/A","src-pfx-len":"N/A","dst-pfx":"N/A","dst-pfx-len":"N/A","app":"N/A","username":"N/A","common_app":"N/A","app-grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"1440","trace-name":"daemon_monitor_trace","domain-mon":"disabled","qos-mon":"true","art-vis":"N/A","app-vis":"true","dia-vis":"N/A","hub-wan-vis":"N/A","sampling":"N/A","spl-intvl":"N/A","stop-time":1716617842854,"source-site-vmanage-version":"20.15.0-12","taskId":119,"trace-trigger-event":"N/A","enable-cmd-header":"N/A","state":"stopped-with-exception","message":"Trace Stop with exception (auto stop)\n * vmanage received 1 trace done message from [4.4.4.130]\n * vmanage hasn't received trace done message from [4.4.4.135, 4.4.4.136, 4.4.4.105, 4.4.4.103, 4.4.4.180, 4.4.4.181, 4.4.4.106, 4.4.4.120, 4.4.4.119, 4.4.4.108, 4.4.4.137]","warning":"","wan-drop-rate-threshold":5,"local-drop-rate-threshold":5,"agg-client-prefix":"N/A","agg-svr-prefix":"N/A","agg-src-sgt":"N/A","agg-user-name":"N/A","health-server-ip":"4.4.4.2","health-cpu-load":"7.18","health-mem-usage":"19","health-cpu-load-average":"0","health-cpu-core":"0","health-app-server-mem":"0","health-running-traces":1,"trace_stop_type":"","devicesCheckInfo":"[{\"bfd-session-with-traffic\":1,\"up-bfd-session\":1,\"health-device-cpu-load\":\"18.31\",\"health-device-mem-usage\":\"27\",\"deviceHostName\":\"-4.4.4.120\",\"peerSitesCount\":1},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":4,\"health-device-cpu-load\":\"14.21\",\"health-device-mem-usage\":\"47\",\"deviceHostName\":\"-4.4.4.130\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"0\",\"health-device-mem-usage\":\"0\",\"deviceHostName\":\"-4.4.4.135\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"4.57\",\"health-device-mem-usage\":\"65\",\"deviceHostName\":\"-4.4.4.137\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":2,\"up-bfd-session\":4,\"health-device-cpu-load\":\"16.74\",\"health-device-mem-usage\":\"54\",\"deviceHostName\":\"-4.4.4.103\",\"peerSitesCount\":1},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"0\",\"health-device-mem-usage\":\"0\",\"deviceHostName\":\"-4.4.4.136\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"0\",\"health-device-mem-usage\":\"0\",\"deviceHostName\":\"-4.4.4.106\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":4,\"health-device-cpu-load\":\"25.41\",\"health-device-mem-usage\":\"47\",\"deviceHostName\":\"-4.4.4.105\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"0\",\"health-device-mem-usage\":\"0\",\"deviceHostName\":\"-4.4.4.180\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":1,\"up-bfd-session\":1,\"health-device-cpu-load\":\"18.26\",\"health-device-mem-usage\":\"26\",\"deviceHostName\":\"-4.4.4.119\",\"peerSitesCount\":1},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"0\",\"health-device-mem-usage\":\"0\",\"deviceHostName\":\"Site8-cEdge-1-4.4.4.108\",\"peerSitesCount\":0},{\"bfd-session-with-traffic\":0,\"up-bfd-session\":0,\"health-device-cpu-load\":\"0\",\"health-device-mem-usage\":\"0\",\"deviceHostName\":\"-4.4.4.181\",\"peerSitesCount\":0}]"},"devices":[{"device-ip":"4.4.4.135","local-system-ip":"4.4.4.135","log":"device is unreachable","source-site":"35","site-id":"35","uuid":"ASR1001-HX-JAE222202LC","duration":"1440","@rid":9125,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"device is unreachable","vpn-id":"0","version":"17.09.01.0.03211858","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.136","local-system-ip":"4.4.4.136","log":"device is unreachable","source-site":"36","site-id":"36","uuid":"C1111-8PWE-FGL2149919Y","duration":"1440","@rid":9127,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"device is unreachable","vpn-id":"0","version":"17.09.01.0.03160742","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.105","local-system-ip":"4.4.4.105","source-site":"5","site-id":"5","uuid":"C8K-00c313bc-8e69-4c1e-981e-84197567f8d1","duration":"1440","@rid":9118,"trace-id":39584,"device-type":"src","model":"Lite","state":"running","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"connectedVManages":"4.4.4.2","parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"Trace Start successfully","vpn-id":"0","version":"17.14.01.0.03142250","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.103","local-system-ip":"4.4.4.103","source-site":"3","site-id":"3","uuid":"C8K-53b44a53-9467-481e-b595-2407df133b67","duration":"1440","@rid":9120,"trace-id":39584,"device-type":"src","model":"Lite","state":"running","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"connectedVManages":"4.4.4.2","parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"Trace Start successfully","vpn-id":"0","version":"17.15.01.6.385","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.180","local-system-ip":"4.4.4.180","log":"device is unreachable","source-site":"180","site-id":"180","uuid":"C8K-668344fe-842d-4308-ae9b-2fee6f5d213f","duration":"1440","@rid":9121,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"device is unreachable","vpn-id":"0","version":"17.06.01.0.313","app-vis":"true","vpn-list":"[\"1\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.181","local-system-ip":"4.4.4.181","log":"device is unreachable","source-site":"181","site-id":"181","uuid":"C8K-7a391403-fe2c-4f14-a5e4-cf93288dceae","duration":"1440","@rid":9122,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"device is unreachable","vpn-id":"0","version":"17.06.01.0.313","app-vis":"true","vpn-list":"[\"1\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.130","local-system-ip":"4.4.4.130","source-site":"30","site-id":"30","uuid":"C8K-8d7c2053-93d3-45b9-b13c-5a6c1ea87092","duration":"1440","@rid":9119,"trace-id":39584,"device-type":"src","model":"Lite","state":"completed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"connectedVManages":"4.4.4.2","parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"Trace Done","vpn-id":"0","version":"17.15.01.3.529","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.106","local-system-ip":"4.4.4.106","log":"device is unreachable","source-site":"6","site-id":"6","uuid":"CSR-134623c5-a814-4552-9a75-27e28aae3c06","duration":"1440","@rid":9129,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"device is unreachable","vpn-id":"0","version":"17.06.01.3.135059","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.120","local-system-ip":"4.4.4.120","source-site":"20","site-id":"20","uuid":"CSR-7c9f706c-288e-49da-8f57-9f5a5b3e3333","duration":"1440","@rid":9124,"trace-id":39584,"device-type":"src","model":"Lite","state":"running","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"connectedVManages":"4.4.4.2","parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"Trace Start successfully","vpn-id":"0","version":"17.14.01.0.262","app-vis":"true","vpn-list":"[\"996\",\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.119","local-system-ip":"4.4.4.119","source-site":"19","site-id":"19","uuid":"CSR-7c9f706c-288e-49da-8f57-9f5a5b3e5555","duration":"1440","@rid":9123,"trace-id":39584,"device-type":"src","model":"Lite","state":"running","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"connectedVManages":"4.4.4.2","parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"Trace Start successfully","vpn-id":"0","version":"17.14.01.2.1085","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.108","local-system-ip":"4.4.4.108","log":"device is unreachable","source-site":"8","site-id":"8","uuid":"CSR-8e3a07d0-6e22-4a85-9397-f86c1e4e4f4d","duration":"1440","@rid":9130,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"device is unreachable","vpn-id":"0","version":"17.06.01.3.135059","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"},{"device-ip":"4.4.4.137","local-system-ip":"4.4.4.137","log":"Trace Start initiated failed (unknown element: qos-mon in /Cisco-IOS-XE-nwpi-rpc:device-nwpi) ","source-site":"37","site-id":"37","uuid":"ISR4451-X/K9-FOC17042FM3","duration":"1440","@rid":9128,"trace-id":39584,"device-type":"src","model":"Lite","state":"start-failed","dscp-is-valid":"false","qos-mon":"true","entry_time":1716531295367,"connectedVManages":"4.4.4.2","parent-trace-id":39584,"domain_monitor_can_be_started":"true","message":"Trace Start initiated failed (unknown element: qos-mon in /Cisco-IOS-XE-nwpi-rpc:device-nwpi) ","vpn-id":"0","version":"17.09.01.0.03212256","app-vis":"true","vpn-list":"[\"10\"]","trace-name":"daemon_monitor_trace","expire-time":1716617695367,"tenantId":"default"}],"readout":{"detail":[]},"flowTimeRange":{"start_time":0,"end_time":0}},"tenant":"default","traceModel":2}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/trace/delete":{"delete":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Trace Action - Delete","operationId":"traceDelete","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"string","example":"16"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64","example":1716782661675}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiTraceDeleteRespPayload"},"examples":{"Trace delete successfully":{"description":"Trace delete successfully","value":{"action":"success","trace-id":"16"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/trace/record/{deviceUUID}":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"post flow data","operationId":"nwpiPostFlowData","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-write,vmanage-http-stream"}},"/stream/device/nwpi/trace/start":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Trace Action - Start","operationId":"traceStart","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiTraceStartReqPayload"},"examples":{"Start trace simply":{"description":"Start trace simply","value":{"source-site":"500","duration":"60","vpn-id":"1"}},"Start trace simply (use vpn-list)":{"description":"Start trace simply (use vpn-list)","value":{"source-site":"500","duration":"60","vpn-list":["1"]}},"Start trace simply (UI default paramters)":{"description":"Start trace simply (UI default paramters)","value":{"source-site":"500","duration":"60","local-drop-rate-threshold":5,"wan-drop-rate-threshold":5,"device-list":[{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","version":"17.15.01.0.727","transport-interface":[]}],"vpn-id":"1","art-vis":"true","app-vis":"true","qos-mon":"true","source-site-version":"17.15","traceModel":"SDWAN_MANUAL","warning":""}},"Start trace with synthetic traffic":{"description":"Start trace with synthetic traffic","value":{"source-site":"500","duration":"60","local-drop-rate-threshold":5,"wan-drop-rate-threshold":5,"device-list":[{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","version":"17.15.01.0.727","transport-interface":[]}],"vpn-id":"1","test":[{"target-url":"www.chatgpt.com","dscp":"0","test-intvl":"1","dns-svr":"8.8.8.8","vpn-id":"1","username":"","user_grp":""}],"art-vis":"true","app-vis":"true","qos-mon":"true","source-site-version":"17.15","traceModel":"SDWAN_MANUAL","warning":""}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiTraceStartRespPayload"},"examples":{"Start trace simply":{"description":"Start trace simply","value":{"action":"success","qos-mon":true,"source-site":"500","trace-id":80,"trace-name":"trace_80","traceModel":0,"entry_time":1716789542704,"expire-time":1716793142704,"state":"starting","traces":[{"uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","trace-id":80,"entry_time":1716789542704,"status":"success","message":"Trace Starting"}],"domain-mon":false,"local-drop-rate-threshold":5,"wan-drop-rate-threshold":5}},"Start trace simply (UI default paramters)":{"description":"Start trace simply (UI default paramters)","value":{"action":"success","qos-mon":true,"source-site":"500","trace-id":96,"trace-name":"trace_96","traceModel":0,"entry_time":1716790090943,"expire-time":1716793690943,"state":"starting","traces":[{"uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","trace-id":96,"entry_time":1716790090943,"status":"success","message":"Trace Starting"}],"domain-mon":false,"local-drop-rate-threshold":5,"wan-drop-rate-threshold":5}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/trace/stop/{traceId}":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Trace Action - Stop","operationId":"traceStop","parameters":[{"name":"traceId","in":"path","description":"traceId","required":true,"schema":{"type":"string","example":"48"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiTraceStopRespPayload"},"examples":{"Trace stop successfully":{"description":"Trace stop successfully","value":{"action":"success","trace-id":"48","trace-name":"trace_48","state":"stopping","message":"Trace Stop initiated successfully (user stop), ready to notify devices","qos-mon":true,"entry_time":1716782691675,"domain-mon":false,"traces":[{"uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","trace-id":48,"entry_time":1716782691675,"action":"success","message":"Device Trace Stop initiated successfully (device is waiting to be notified)"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write"}},"/stream/device/nwpi/traceCftRecord":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get Trace CFT record","operationId":"getTraceCftRecord","parameters":[{"name":"traceId","in":"query","description":"TraceId","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"entryTime","in":"query","description":"entryTime","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceState","in":"query","description":"traceState","required":true,"schema":{"type":"string"}},{"name":"vpnIds","in":"query","description":"vpnIds","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"localColors","in":"query","description":"localColors","schema":{"type":"array","items":{"type":"string"}}},{"name":"devices","in":"query","description":"devices","schema":{"type":"array","items":{"type":"string"}}},{"name":"vrfNames","in":"query","description":"vrfNames","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceCftRecordResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/traceFinFlowCount":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Retrieve total Fin Flow counts","operationId":"getFinalizedFlowCount","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InlineResponse200"},"examples":{"Finalized flow count":{"description":"Finalized flow count","value":{"total_flow_count":"10000"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceFinFlowTimeRange":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Retrieve Fin Flow time range","operationId":"getFinFlowTimeRange","parameters":[{"name":"traceId","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceFinFlowTimeRangeResponsePayload"},"examples":{"Finalized flow time range":{"description":"Finalized flow time range","value":[{"start_time":"1651543925251","end_time":"1651545413468"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceFinFlowWithQuery":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Retrieve Certain Fin Flows","operationId":"traceFinFlowWithQuery","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpitraceFlowRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceFlow":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"getTraceFlow","operationId":"getTraceFlow","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"state","in":"query","description":"trace state","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpitraceFlowRespPayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/traceHistory":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get historical traces","operationId":"getTraceHistory","parameters":[{"name":"traceModel","in":"query","description":"traceModel","schema":{"type":"string"},"examples":{"Get multiple types of traces with parameters separated by commas":{"description":"Get multiple types of traces with parameters separated by commas","value":"SDWAN_MANUAL,SDWAN_AUTO_ON,SD_ROUTING_MANUAL"},"Get auto on traces":{"description":"Get auto on traces","value":"SDWAN_AUTO_ON"},"Get manual traces":{"description":"Get manual traces","value":"SDWAN_MANUAL"},"Get sd-routing traces":{"description":"Get sd-routing traces","value":"SD_ROUTING_MANUAL"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiTraceHistoryRespPayload"},"examples":{"Response for getting historical traces":{"description":"Response for getting historical traces","value":{"header":{"generatedOn":1716888241874,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-nwpiTraceData"},"columns":[{"title":"Start Time","property":"entry_time","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"},{"title":"Trace Id","property":"trace-id","dataType":"number"}],"fields":[{"property":"entry_time","dataType":"date"},{"property":"trace-id","dataType":"number"},{"property":"type","dataType":"string"},{"property":"data","dataType":"object"}]},"data":[{"trace-id":144,"entry_time":1716885120542,"traceModel":0,"type":"trace-history","data":{"summary":{"source-site":"500","device-ip":"N/A","vpn-id":"0","vpn-list":"[\"1\"]","src-if":"N/A","src-ip":"N/A","src-port":"N/A","dst-ip":"N/A","dst-port":"N/A","src-pfx":"N/A","src-pfx-len":"N/A","dst-pfx":"N/A","dst-pfx-len":"N/A","app":"N/A","username":"N/A","common_app":"N/A","app-grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace-name":"trace_144","domain-mon":"disabled","qos-mon":"N/A","art-vis":"N/A","app-vis":"N/A","dia-vis":"N/A","hub-wan-vis":"N/A","sampling":"N/A","spl-intvl":"N/A","stop-time":-1,"source-site-vmanage-version":"20.15.0-50","taskId":-1,"trace-trigger-event":"N/A","enable-cmd-header":"N/A","state":"stopping","message":"Trace Stop initiated successfully (user stop), ready to notify devices","warning":"","wan-drop-rate-threshold":5,"local-drop-rate-threshold":5,"agg-client-prefix":"N/A","agg-svr-prefix":"N/A","agg-src-sgt":"N/A","agg-user-name":"N/A","health-server-ip":"172.16.255.22","health-cpu-load":"3.06","health-mem-usage":"44","health-cpu-load-average":"0.06","health-cpu-core":"16","health-app-server-mem":"0.09","health-running-traces":1,"trace_stop_type":"","devicesCheckInfo":"[{\"bfd-session-with-traffic\":0,\"up-bfd-session\":18,\"health-device-cpu-load\":\"30.56\",\"health-device-mem-usage\":\"83\",\"deviceHostName\":\"vm5-172.16.255.15\",\"peerSitesCount\":0}]"},"devices":[{"entry_time":1716885120542,"device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","connectedVManages":"172.16.255.22","parent-trace-id":144,"domain_monitor_can_be_started":"true","source-site":"500","site-id":"500","message":"Device Trace Stop initiated successfully (received device reply ok)","vpn-id":"0","uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","version":"17.15.01.0.727","duration":"60","vpn-list":"[\"1\"]","trace-name":"trace_144","@rid":4365,"trace-id":144,"expire-time":1716888720542,"tenantId":"default","device-type":"src","state":"stopped","dscp-is-valid":"false"}]}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/stream/device/nwpi/traceInfoByBaseKey":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get TraceInfoByBaseKey","operationId":"getTraceInfoByBaseKey","parameters":[{"name":"traceId","in":"query","description":"traceId","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"entryTime","in":"query","description":"entryTime","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"traceModel","in":"query","description":"traceModel","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceInfoResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/traceReadoutFilter":{"get":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get event Readout Filter By Traces","operationId":"getTraceReadoutFilter","parameters":[{"name":"trace_id","in":"query","description":"traceId","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"entry_time","in":"query","description":"entry_time","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventReadoutFilterResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/stream/device/nwpi/upsertSetting":{"post":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"insert or update setting","operationId":"upsertSetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NwpiSettingDataPayload"},"examples":{"insert or update setting ":{"description":"insert or update setting ","value":{"type":"peerSiteThresholdType","peerSiteThreshold":100}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-write"}},"/stream/device/speed":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSession","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestSession"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/speed/disable/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"disableSpeedTestSession","parameters":[{"name":"sessionId","in":"path","description":"sessionId","required":true,"schema":{"$ref":"#/components/schemas/Uuid"},"examples":{"sessionId":{"description":"sessionId","value":"5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestStatusResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/speed/interface/bandwidth":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getInterfaceBandwidth","parameters":[{"name":"deviceUUID","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DeviceUuid"}},{"name":"circuit","in":"query","schema":{"type":"string"}},{"name":"sourceInterface","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestInterfaceResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/stream/device/speed/start/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"startSpeedTest","parameters":[{"name":"sessionId","in":"path","description":"sessionId","required":true,"schema":{"$ref":"#/components/schemas/Uuid"},"examples":{"sessionId":{"description":"sessionId","value":"5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestStatusResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/speed/status/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSpeedTestStatus","parameters":[{"name":"sessionId","in":"path","description":"sessionId","required":true,"schema":{"$ref":"#/components/schemas/Uuid"},"examples":{"sessionId":{"description":"sessionId","value":"5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestStatusResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/speed/stop/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"stopSpeedTest","parameters":[{"name":"sessionId","in":"path","description":"sessionId","required":true,"schema":{"$ref":"#/components/schemas/Uuid"},"examples":{"sessionId":{"description":"sessionId","value":"5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestStatusResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/speed/{deviceUUID}/{sessionId}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"saveSpeedTestResults","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","description":"sessionId","required":true,"schema":{"$ref":"#/components/schemas/Uuid"},"examples":{"sessionId":{"description":"sessionId","value":"5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d"}}}],"requestBody":{"description":"SpeedTestResult","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestResult"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestStatusResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/speed/{sessionId}":{"get":{"tags":["Troubleshooting Tools - Diagnostics"],"operationId":"getSpeedTest","parameters":[{"name":"sessionId","in":"path","description":"sessionId","required":true,"schema":{"$ref":"#/components/schemas/Uuid"},"examples":{"sessionId":{"description":"sessionId","value":"5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d"}}},{"name":"logId","in":"query","schema":{"type":"integer","format":"int64","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestResultResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/stream/device/status/{deviceUUID}":{"post":{"tags":["Troubleshooting Tools - Diagnostics"],"description":"Get device status stream","operationId":"processDeviceStatus","parameters":[{"name":"deviceUUID","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/umts":{"post":{"tags":["Troubleshooting Tools - UMTS"],"summary":"Assign sessionId to client","description":"assign sessionId to client if there is no conflict ongoing sessions ","operationId":"enableSession","requestBody":{"description":"Input query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UMTSInput"}}},"required":true},"responses":{"200":{"description":"Session info which client can start request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UMTSSession"}}}}},"400":{"description":"bad input parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"conflicts sample":{"description":"conflicts sample","$ref":"#/components/examples/umts_enable_error"}}}}}}}},"/stream/device/umts/statistics/{deviceUUID}/{eventType}":{"get":{"tags":["Troubleshooting Tools - UMTS"],"summary":"get UMTS Data","description":"get UMTS result by type, time, and device uuid","operationId":"getUMTSData","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventType","in":"path","required":true,"schema":{"type":"string"}},{"name":"lastNHours","in":"query","schema":{"type":"integer","format":"int32","default":24}}],"responses":{"200":{"description":"opertion result","content":{"application/json":{"schema":{"type":"object"},"examples":{"get event-driven sample":{"description":"get event-driven sample","$ref":"#/components/examples/umts_eventdriven_result"}}}}},"400":{"description":"bad input parameter"}}}},"/stream/device/umts/{deviceUUID}/save":{"post":{"tags":["Troubleshooting Tools - UMTS"],"summary":"save UMTS result","description":"Save UMTS Data, this api is called by device side ","operationId":"saveUMTSData","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object"},"examples":{"on-demand sample":{"description":"on-demand sample","$ref":"#/components/examples/UmtsSaveRequest"}}}},"required":true},"responses":{"200":{"description":"save result","content":{"application/json":{"schema":{"type":"string"},"examples":{"save result sample":{"description":"save result sample","value":"{status: success}"}}}}},"400":{"description":"bad input parameter"}},"x-roles-required":"vmanage-http-stream"}},"/stream/device/umts/{operation}/{sessionId}":{"get":{"tags":["Troubleshooting Tools - UMTS"],"summary":"start/stop/disable/status/download session","description":"start, stop,status,download or disable session ","operationId":"updateUmtsSessionStatus","parameters":[{"name":"operation","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"opertion result","content":{"application/json":{"schema":{"type":"object"},"examples":{"start/stop/disable/status/download sample":{"description":"start/stop/disable/status/download sample","value":"{status: success}"},"status ok sample":{"description":"status ok sample","$ref":"#/components/examples/umts_status_result"},"status fail sample":{"description":"status fail sample","$ref":"#/components/examples/umts_status_fail_result"},"status downloadable sample":{"description":"status downloadable sample","$ref":"#/components/examples/umts_status_downloadable_result"},"download sample":{"description":"download sample","$ref":"#/components/examples/umts_download_sample"}}}}},"400":{"description":"bad input parameter","content":{"application/json":{"schema":{"type":"object"},"examples":{"error sample":{"description":"error sample","$ref":"#/components/examples/umts_status_error"}}}}}}}},"/system/device":{"post":{"tags":["Configuration - Device Inventory"],"description":"Create new device
Note: In a multitenant vManage system, this API is only available in the Provider view 123.","operationId":"createDevice","requestBody":{"description":"Create device request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Create device request":{"description":"Create device request","$ref":"#/components/examples/SystemDevice"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/bootstrap/device/{uuid}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Create vEdge device config","operationId":"generateBootstrapConfigForVedge","parameters":[{"name":"uuid","in":"path","description":"Device UUID","required":true,"schema":{"type":"string"},"example":"ESR-6300-LIC-K9-FAUSTEST126"},{"name":"configtype","in":"query","description":"configtype","required":true,"schema":{"type":"string"},"example":"cloudinit"},{"name":"inclDefRootCert","in":"query","required":true,"schema":{"type":"boolean","default":true}},{"name":"version","in":"query","schema":{"type":"string","default":"v1"}},{"name":"wanif","in":"query","description":"wanif","schema":{"type":"string"},"example":"GigabitEthernet1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateBootstrapConfigForVedge"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","$ref":"#/components/examples/GetBootstrapDevice"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/bootstrap/devices":{"post":{"tags":["Configuration - Device Inventory"],"description":"Create bootstrap config for software vEdges","operationId":"generateBootstrapConfigForVedges","requestBody":{"description":"Request body for Device bootstrap configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VEdgeBootstrapConfig"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/PostBootstrapDevices"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateBootstrapConfigForVedgesResponse"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","$ref":"#/components/examples/PostBootstrapDevicesResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/bootstrap/download/{id}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Download vEdge device config","operationId":"getBootstrapConfigZip","parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string"},"example":"b4d93025-cf37-41a5-a2a6-d9113ede034c"}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/GetBootstrapConfigZip"},"examples":{"Device bootstrap configuration":{"description":"Device bootstrap configuration","$ref":"#/components/examples/BootstrapDownloadId"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/bootstrap/generic/devices":{"get":{"tags":["Configuration - Device Inventory"],"description":"Create bootstrap config for software vEdges","operationId":"generateGenericBootstrapConfigForVedges","parameters":[{"name":"wanif","in":"query","description":"Device WAN interface","schema":{"type":"string"},"example":"GigabitEthernet1"},{"name":"sdRoutingDevice","in":"query","description":"Flag indicating if this is SD-Routing device","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateGenericBootstrapConfigForVedges"},"examples":{"Task Id":{"description":"Task Id","$ref":"#/components/examples/BootstrapGenericDevices"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/claimDevices":{"post":{"tags":["Configuration - Device Inventory"],"description":"Claim the selected unclaimed devices","operationId":"claimDevices","requestBody":{"description":"Claim device request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimDevicesRequest"},"examples":{"Claim device request":{"description":"Claim device request","$ref":"#/components/examples/ClaimDevices"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimDevicesResponse"},"examples":{"Claimed device info":{"description":"Claimed device info","$ref":"#/components/examples/ClaimDevicesResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/controllers/vedge/status":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get controllers vEdge sync status","operationId":"getControllerVEdgeSyncStatus_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vEdge status":{"description":"vEdge status","$ref":"#/components/examples/ControllersVedgeStatus"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/system/device/decommission/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Decomission vEdge device","operationId":"decommissionVedgeCloud","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"},"example":"C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecommissionVedgeCloud"},"examples":{"Task id":{"description":"Task id","$ref":"#/components/examples/DecommissionUuid"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/devicesWithoutSubjectSudi":{"get":{"tags":["Configuration - Device Inventory"],"description":"retrieve devices without subject sudi","operationId":"devicesWithoutSubjectSudi","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/fileupload":{"post":{"tags":["Configuration - Device Inventory"],"description":"Upload file to vEdge","operationId":"formPost","requestBody":{"description":"Request body for Upload file to vEdge","content":{"multipart/form-data":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/FileUpload"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormPostResp"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/FileUploadResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/generate-payg":{"post":{"tags":["Configuration - Device Inventory"],"description":"Authenticate vSmart user account","operationId":"validateUser","requestBody":{"description":"Request body","content":{"multipart/form-data":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/GeneratePayG"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/GeneratePayGResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/lifecycle/management/{uuid}":{"post":{"tags":["Configuration - Device Inventory"],"description":"Set device lifecycle needed flag","operationId":"setLifeCycle","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"},"example":"0cee8b1d-1d2c-4c8b-a111-4b17ce9dd473"},{"name":"enable","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetLifeCycle"},"examples":{"Device lifecycle needed value":{"description":"Device lifecycle needed value","$ref":"#/components/examples/LifecycleManagement"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/management/systemip":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get management system IP mapping","operationId":"getManagementSystemIPInfo_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"System IP mapping":{"description":"System IP mapping","$ref":"#/components/examples/ManagementSystemIp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/system/device/migrateDevice/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Migrate device software to vedge/cedge","operationId":"migrateDevice","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"},"example":"cad0e65b-86b5-48af-8c26-5a470ea68166"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device migration result":{"description":"Device migration result","$ref":"#/components/examples/MigrateDevice"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/quickconnect/smartaccount/sync":{"post":{"tags":["Configuration - Device Inventory"],"description":"Sync devices from Smart-Account","operationId":"getSmartAccountDevices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartAccountModel"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncDevicesResp"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/reset/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Reset vEdge device","operationId":"resetVedgeCloud","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"},"example":"cad0e65b-86b5-48af-8c26-5a470ea68166"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetVedgeCloud"},"examples":{"Task id":{"description":"Task id","$ref":"#/components/examples/Reset"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/rma/candidates/{deviceType}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get RMA candidates by device type","operationId":"getRMACandidates","parameters":[{"name":"deviceType","in":"path","description":"deviceType","required":true,"schema":{"type":"string"},"example":"controller"},{"name":"uuid","in":"query","description":"uuid","schema":{"type":"string"},"example":"ec7af44a-8731-442d-9b5e-62f3dc407454"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRMACandidates"},"examples":{"Device type":{"description":"Device type","$ref":"#/components/examples/RmaCandidates"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/rootcertchain/status":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get controllers vEdge sync status","operationId":"getRootCertStatusAll","parameters":[{"name":"state","in":"query","description":"state","required":true,"schema":{"type":"string"},"example":"pending/done"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRootCertStatusAll"},"examples":{"vEdge sync status":{"description":"vEdge sync status","$ref":"#/components/examples/RootcertChainStatus"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/selfsignedcert/iscreated":{"get":{"tags":["Configuration - Device Inventory"],"description":"Whether self signed certificate created","operationId":"checkSelfSignedCert_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Self signed certificate created":{"description":"Self signed certificate created","$ref":"#/components/examples/SelfsignedcertIsCreated"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/system/device/smartaccount/authenticate":{"post":{"tags":["Configuration - Device Inventory"],"description":"Authenticate vSmart user account","operationId":"smartAccountAuthenticate","requestBody":{"description":"Claim device request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Smartaccount Authenticate Request":{"description":"Smartaccount Authenticate Request","$ref":"#/components/examples/SmartAccountAuthenticate"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartAccountAuthenticateResponse"},"examples":{"Access token":{"description":"Access token","$ref":"#/components/examples/SmartAccountAuthenticateResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/smartaccount/sync":{"post":{"tags":["Configuration - Device Inventory"],"description":"Sync devices from Smart-Account","operationId":"syncDevices","requestBody":{"description":"Request body for Sync devices from Smart-Account","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/SmartAccountSync"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncDevicesResp"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/SmartAccountSyncResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/sync/rootcertchain":{"get":{"tags":["Configuration - Device Inventory"],"description":"Sync root certificate","operationId":"syncRootCertChain","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRootCertChain"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/SyncRootcertChain"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/tenant/management/systemip":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get management system IP
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantManagementSystemIPs","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTenantManagementSystemIPs"},"examples":{"System IP":{"description":"System IP","$ref":"#/components/examples/TenantManagementSystemIp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/type/{deviceCategory}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get devices details","operationId":"getCloudDockDataBasedOnDeviceType","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string","enum":["vedges","controllers"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device info":{"description":"Device info","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,dca"}},"/system/device/type/{deviceCategory}/defaultConfig":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get devices default config","operationId":"getCloudDockDefaultConfigBasedOnDeviceType","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string","enum":["vedges","controllers"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device default config":{"description":"Device default config","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,dca"}},"/system/device/unclaimedDevices":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get list of all unclaimed devices","operationId":"getAllUnclaimedDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllUnclaimedDevices"},"examples":{"Device info":{"description":"Device info","$ref":"#/components/examples/UnclaimedDevices"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/updateDeviceSubjectSUDI/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"update subject sudi value of given device uuid","operationId":"updateDeviceSubjectSUDI","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/vedgedetection":{"get":{"tags":["Configuration - Device Inventory"],"description":"Check for Vedge Device Presence","operationId":"checkvEdgeDevicePresence","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VedgeCheckResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/vmanagerootca/{uuid}":{"delete":{"tags":["Configuration - Device Inventory"],"description":"Invalidate vManage root CA","operationId":"invalidateVmanageRootCA","parameters":[{"name":"uuid","in":"path","description":"Device UUID","required":true,"schema":{"type":"string"},"example":"930633aa-f843-4dff-a2f0-664ca97df5ae"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidateVmanageRootCA"},"examples":{"Device info":{"description":"Device info","$ref":"#/components/examples/Vmanagerootca"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/system/device/{deviceCategory}":{"get":{"tags":["Configuration - Device Inventory"],"description":"Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers","operationId":"getDevicesDetails","parameters":[{"name":"deviceCategory","in":"path","description":"Device category","required":true,"schema":{"type":"string"},"example":"vedges"},{"name":"model","in":"query","description":"Device model","schema":{"type":"string","enum":["vedge-cloud","vedge-1000","vedge-2000","vedge-100","vedge-ISR1100-4G","vedge-ISR1100-4GLTE","vedge-ISR1100X-4G","vedge-ISR1100-6G","vedge-ISR1100X-6G","vedge-100-B","vedge-100-WM","vedge-100-M","vEdge-5000","vedge-CSR-1000v","vedge-IR-1101","vedge-IR-1821","vedge-IR-1831","vedge-IR-1833","vedge-IR-1835","vedge-IR-8140H","vedge-IR8140H-P","vedge-IR-8340","vedge-ESR-6300","vedge-ISR-4331","vedge-ISR-4321","vedge-ISR-4351","vedge-ISR-4221","vedge-IR-1101","vedge-ESR-6300","vedge-ISR-4331","vedge-ISR-4321","vedge-ISR-4351","vedge-ISR-4221","vedge-ISR-4221X","vedge-ISR-4431","vedge-ISR-4451-X","vedge-ASR-1001-HX","vedge-ASR-1002-X","vedge-ASR-1002-HX","vedge-ASR-1006-X","vedge-C1111-8P","vedge-C1121X-8P","vedge-C1111X-8P","vedge-C1111-8PLTELAW","vedge-C1111-8PLTEEA","vedge-C1121-8PLTEPW","vedge-C1111-8PLTELA","vedge-C1117-4PLTEEA","vedge-C1126X-8PLTEP","vedge-C1127X-8PLTEP","vedge-C1127X-8PMLTEP","vedge-C1127-8PMLTEP","vedge-C1117-4PLTELA","vedge-ISRv","vedge-C8000V","vedge-ASR-1001-X","vedge-C1111-4P","vedge-C1101-4P","vedge-C1101-4PLTEP","vedge-C8500-12X4QC","vedge-C8500-12X","vedge-C8330-1N1S-4M2X","vedge-C8330-6TM4SX","vedge-C8330X-6TM4SX","vedge-C8500L-8S4X","vedge-C1111-8PW","vedge-C1111-8PLTEEAW","vedge-C1111-4PLTEEA","vedge-C1101-4PLTEPW","vedge-C1109-4PLTE2PW","vedge-C1109-4PLTE2P","vedge-C1121X-8PLTEP","vedge-C1161X-8PLTEP","vedge-C1113-8PMLTEEA","vedge-C1111-4PLTELA,vedge-C1116-4P","vedge-C1116-4PLTEEA","vedge-C1117-4P","vedge-C1117-4PM","vedge-C1117-4PMLTEEA","vsmart","vmanage","vbond","vedge-ISR-4461","vedge-C8300-1N1S-4T2X","vedge-C8300-1N1S-6T","vedge-C1161X-8P","vedge-C8300-2N2S-4T2X","vedge-C8300-2N2S-6T","vedge-C8200-1N-4T","vedge-C8200L-1N-4T","vedge-C1161-8P","vedge-C1126-8PLTEP","vedge-C1127-8PLTEP","vedge-C1121-4P","vedge-C1121-4PLTEP","vedge-C1128-8PLTEP","vedge-C1121X-8PLTEPW","vedge-C1121-8PLTEP","vedge-C1121-8P","vedge-C1161-8PLTEP","vedge-C1113-8PLTEEA","vedge-C1131-8PW","vedge-C1131X-8PW","vedge-C1131-8PLTEPW","vedge-C1131X-8PLTEPW","vedge-C1113-8PLTEW","vedge-C1111-4PW","vedge-C1112-8P","vedge-C1112-8PLTEEA","vedge-C1112-8PLTEEAWE","vedge-C1112-8PWE","vedge-C1113-8P","vedge-C1113-8PLTEEAW","vedge-C1113-8PLTELA","vedge-C1113-8PLTELAWZ","vedge-C1113-8PM","vedge-C1113-8PMWE","vedge-C1113-8PW","vedge-C1116-4PLTEEAWE","vedge-C1116-4PWE","vedge-C1117-4PLTEEAW","vedge-C1117-4PLTELAWZ","vedge-C1117-4PMLTEEAWE","vedge-C1117-4PMWE","vedge-C1117-4PW","vedge-C1118-8P","vedge-C1109-2PLTEGB","vedge-C1109-2PLTEUS","vedge-C1109-2PLTEVZ"]},"example":"vedge-cloud"},{"name":"state","in":"query","description":"List of states","schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificateStates"},"enum":["tokengenerated","bootstrapconfiggenerated","csrgenerated","csrfailed","certinstalled","certinstallfailed"]},"example":["certinstalled"]},{"name":"uuid","in":"query","description":"List of device uuid","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceUuid"}},"example":["C8K-5e87e5c3-0923-4364-a729-d65d40298d76"]},{"name":"deviceIP","in":"query","description":"List of device system IP","schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}},"example":["172.16.255.21"]},{"name":"validity","in":"query","description":"List of device validity","schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificateValidity"},"enum":["valid","invalid","staging"]},"example":["valid","invalid","staging"]},{"name":"family","in":"query","description":"The platform family to filter for","schema":{"type":"string","enum":["aon","cedge"]}},{"name":"siteId","in":"query","description":"The Site Id to filter for","schema":{"type":"integer","format":"int64"},"example":400},{"name":"topology","in":"query","description":"The device topology to filter for","schema":{"type":"string","enum":["hub","spoke"]}},{"name":"tag","in":"query","description":"The tag name to filter for","schema":{"type":"string"},"example":"Tag1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/DeviceCategoryResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca,Device Inventory > Edge-read,Device Inventory > Controller-read"}},"/system/device/{uuid}":{"put":{"tags":["Configuration - Device Inventory"],"description":"Edit device","operationId":"editDevice","parameters":[{"name":"uuid","in":"path","description":"Device UUID","required":true,"schema":{"type":"string"},"example":"5dfa7d1e-201e-4506-83d6-667a56d17a10"}],"requestBody":{"description":"Edit device request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Edit Device":{"description":"Edit Device","$ref":"#/components/examples/SystemDevice"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Device Inventory"],"description":"Delete vEdges","operationId":"deleteDevice_1","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"},"example":"930633aa-f843-4dff-a2f0-664ca97df5ae"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDevice"},"examples":{"Example Value":{"description":"Example Value","$ref":"#/components/examples/SystemDeviceDeleteResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Device Inventory > Edge-write"}},"/system/device/{uuid}/unlock":{"post":{"tags":["Configuration - Device Inventory"],"description":"Unlock device","operationId":"unlockDevice","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device config":{"description":"Device config"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write"}},"/system/reverseproxy/{uuid}":{"get":{"tags":["System - Reverse Proxy"],"description":"Get reverse proxy IP/Port mappings for controller","operationId":"getReverseProxyMappings","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reverse proxy mappings":{"description":"Device reverse proxy mappings","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["System - Reverse Proxy"],"description":"Create reverse proxy IP/Port mappings for controller","operationId":"createReverseProxyMappings","parameters":[{"name":"uuid","in":"path","description":"Device uuid","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Device reverse proxy mappings","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device reverse proxy mappings":{"description":"Device reverse proxy mappings","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/cloudx":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get CloudX feature list","operationId":"getCloudXStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX status":{"description":"CloudX status","value":{"data":[{"appType":"amazon_aws","longName":"Amazon AWS","totalSites":2,"goodSites":0,"badSites":0,"averageSites":0}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/addcloudx/{type}":{"post":{"tags":["Configuration - CloudExpress"],"description":"Add cloudx gateway","operationId":"addCloudxType","parameters":[{"name":"type","in":"path","description":"Cloudx type","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cloudx","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx":{"description":"Cloudx"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"}},"/template/cloudx/attachedclient":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get attached client site list","operationId":"getAttachedClientList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX attached client site":{"description":"CloudX attached client site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/attacheddia":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get attached Dia site list","operationId":"getAttachedDiaList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX attached Dia site":{"description":"CloudX attached Dia site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/attachedgateway":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get attached gateway list","operationId":"getAttachedGatewayList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX attached gateway":{"description":"CloudX attached gateway","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/availableapps":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get CloudX available apps list","operationId":"getCloudXAvailableApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX app list":{"description":"CloudX app list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/clientlist":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get site list","operationId":"getSiteList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX site":{"description":"CloudX site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/dialist":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get Dia site list","operationId":"getDiaList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX Dia site":{"description":"CloudX Dia site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/gatewaylist":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get gateway list","operationId":"getGatewayList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX gateway":{"description":"CloudX gateway","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/interfaces":{"post":{"tags":["Configuration - CloudExpress"],"description":"Enable cloudx gateway","operationId":"addCloudxInterfaces","requestBody":{"description":"Cloudx","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx":{"description":"Cloudx"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"}},"/template/cloudx/manage/apps":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get apps and vpns","operationId":"getApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"},"put":{"tags":["Configuration - CloudExpress"],"description":"Edit apps and vpns","operationId":"editApps","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx apps and vpns":{"description":"Cloudx apps and vpns","value":{"appList":[{"appType":"amazon_aws","longName":"Amazon AWS","appVpnList":"1,10"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Change required":{"description":"Change required","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"},"post":{"tags":["Configuration - CloudExpress"],"description":"Add apps and vpns","operationId":"addApps","requestBody":{"description":"Cloudx apps and vpns","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloudx apps and vpns":{"description":"Cloudx apps and vpns","value":{"appList":[{"appType":"amazon_aws","longName":"Amazon AWS","appVpnList":"1,5"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX apps and vpns":{"description":"CloudX apps and vpns","value":{"pushRequired":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Cloud OnRamp-write"}},"/template/cloudx/sig_tunnels":{"get":{"tags":["Configuration - Secure Internet Gateway Tunnels"],"description":"Get Secure Internet Gateway Tunnel List","operationId":"getSigTunnelList_1","parameters":[{"name":"deviceId","in":"query","description":"DeviceIp/SystemIp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/cloudx/status":{"get":{"tags":["Configuration - CloudExpress"],"description":"Get sites per application per vpn","operationId":"sitePerApp","parameters":[{"name":"appName","in":"query","description":"App name","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"query","description":"VPN Id","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"CloudX site":{"description":"CloudX site","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Cloud OnRamp-read,Cloud OnRamp-write"}},"/template/config/attach/{deviceId}":{"put":{"tags":["Configuration - Template Configuration"],"description":"Upload device config","operationId":"uploadConfig","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template config":{"description":"Template config"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Template Deploy-write"}},"/template/config/attached/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get local template attached config for given device","operationId":"getAttachedConfig","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Config type","schema":{"type":"string","enum":["CFS","RFS","DRAFT_RFS","DRAFT_CFS"],"default":"CFS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attached config":{"description":"Attached config","value":{"config":"no config\nconfig\n system\n host-name vm1\n system-ip 172.16.255.11\n site-id 100\n port-offset 1\n admin-tech-on-failure\n admin-tech-on-software-rollback\n route-consistency-check\n no vrrp-advt-with-phymac\n organization-name \"vIPtela Inc Regression\"\n vbond vbond\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n !\n logging\n disk\n enable\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n support\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n !\n !\n omp\n no shutdown\n graceful-restart\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n advertise ospf external\n advertise connected\n advertise static\n !\n security\n ipsec\n integrity-type ip-udp-esp esp\n !\n !\n vpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface ge0/1\n ip address 10.0.26.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/2\n ip address 10.0.5.11/24\n no ipv6 shutdown\n tunnel-interface\n encapsulation ipsec\n color lte\n hello-tolerance 12\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n !\n interface ge0/4\n ip address 10.0.7.11/24\n no ipv6 shutdown\n no shutdown\n !\n interface ge0/7\n ip address 10.0.100.11/24\n no ipv6 shutdown\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n !\n vpn 1\n router\n ospf\n router-id 172.16.255.11\n timers spf 200 1000 10000\n redistribute static\n redistribute omp\n area 0\n interface ge0/0\n exit\n exit\n !\n !\n interface ge0/0\n ip address 10.2.2.11/24\n no ipv6 shutdown\n no shutdown\n !\n !\n vpn 512\n interface eth0\n ip dhcp-client\n no ipv6 shutdown\n ipv6 dhcp-client\n no shutdown\n !\n !\n !\n!\n"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/template/config/device/mode/cli":{"get":{"tags":["Configuration - Template Configuration"],"description":"Generates a JSON object that contains a list of valid devices in CLI mode","operationId":"generateCLIModeDevices","parameters":[{"name":"type","in":"query","description":"Device type","required":true,"schema":{"type":"string","enum":["vedge","controller","vmanage"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":{"data":[{"deviceIP":"172.16.255.16","uuid":"C8K-0c9b3b23-bdcd-4162-8d4f-774e44e081ee","host-name":"vm6","local-system-ip":"172.16.255.16"},{"deviceIP":"172.16.255.21","uuid":"76611d8b-dca9-47fd-b204-338af931f506","host-name":"vm11","local-system-ip":"172.16.255.21"},{"deviceIP":"172.16.255.11","uuid":"9c8d59ec-e4ad-468a-8fb0-15a7747a9c30","host-name":"vm1","local-system-ip":"172.16.255.11"},{"deviceIP":"172.16.255.15","uuid":"C8K-ae0d5e97-4b0e-4a05-8582-9cc0d93c456c","host-name":"vm5","local-system-ip":"172.16.255.15"},{"deviceIP":"172.16.255.14","uuid":"554b21bf-cad3-4efe-91fa-4c68549a6616","host-name":"vm4","local-system-ip":"172.16.255.14"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-write"},"post":{"tags":["Configuration - Template Configuration"],"description":"Given a JSON list of devices not managed by any third member partners, push to devices from a CLI template","operationId":"updateDeviceToCLIMode","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":{"deviceType":"vedge","devices":[{"deviceId":"932f70dd-5815-4712-b9ed-3d34a238f2ca","deviceIP":"172.16.255.21"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template Id":{"description":"Device template Id","value":{"id":"device_config_mode_cli-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Template Deploy-write,Device Inventory > Edge-write"}},"/template/config/device/mode/vmanage":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get list of devices that are allowable for vmanage modes","operationId":"generatevManageModeDevices","parameters":[{"name":"type","in":"query","description":"Device type","required":true,"schema":{"type":"string","enum":["vedge","controller","vmanage"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":{"data":[{"deviceIP":"169.254.10.1","uuid":"8b669639-758b-4287-b07f-09b9d334ce24","configCloudxMode":"none","host-name":"vm200","local-system-ip":"172.16.255.200"},{"deviceIP":"169.254.10.2","uuid":"b0497670-2e62-404f-8136-21b226cd4c8b","configCloudxMode":"none","host-name":"vm201","local-system-ip":"172.16.255.201"},{"deviceIP":"169.254.10.3","uuid":"d22cafc2-a0d2-4f57-b0a3-d9147818084a","configCloudxMode":"none","host-name":"vm202","local-system-ip":"172.16.255.202"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/diff/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Generates a JSON object that contains the diff for a given device","operationId":"getDeviceDiff","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Config diff":{"description":"Config diff","value":{"config":"Config diff for device 9c8d59ec-e4ad-468a-8fb0-15a7747a9c30"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/quickConnect/submitDevices":{"post":{"tags":["Configuration - Quick Connect"],"description":"Creates and pushes bootstrap configurations onto day0 devices.","operationId":"submitDay0Config","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"data":{"description":"data","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/rmalist/{oldDeviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get compatible devices of model, chassis number, certificate serial number with the old device","operationId":"getCompatibleDevices","parameters":[{"name":"oldDeviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":{"data":[{"deviceModel":"vedge","chasisNumber":"71001c48-fdcf-4ac0-aaf3-ca4a20386a18","serialNumber":"f0b1985ba82e4c4889c225c59ca9a878","uuid":"67b2de20-0564-4ba6-837f-b24bc6a686ad"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/config/rmaupdate":{"put":{"tags":["Configuration - Template Configuration"],"description":"Update new device","operationId":"rmaUpdate","requestBody":{"description":"Template config","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template config":{"description":"Template config","value":{"oldDeviceUUID":"C8K-075aaa13-0f11-4f76-a02e-fe3750080fcf","newDeviceUUID":"C8K-3bb1154f-ae09-48fb-9fe1-5ddc3b16089e"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-write,Template Deploy-write"}},"/template/config/running/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get device running config","operationId":"getRunningConfig","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Running config":{"description":"Running config","value":{"config":" system\n host-name vm1\n system-ip 172.16.255.11\n site-id 100\n port-offset 1\n no daemon-restart\n admin-tech-on-failure\n admin-tech-on-software-rollback\n route-consistency-check\n no vrrp-advt-with-phymac\n organization-name \"vIPtela Inc Regression\"\n vbond vbond\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read\n task interface read\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup tenantadmin\n !\n user admin\n password $6$tebXK3g64oMdWjSp$kIbJ/qShDI4/eLQ0M8NLyCK7rlmsZAlnwGFqCVZc7rNlIE6f8O1Q6IuP4pHJinc8pSTNGAEYtoCAwDuAiGPF9/\n !\n ciscotacro-user true\n ciscotacrw-user true\n !\n logging\n disk\n enable\n !\n !\n ntp\n parent\n no enable\n stratum 5\n exit\n !\n support\n zbfw-tcp-finwait-time 30\n zbfw-tcp-idle-time 3600\n zbfw-tcp-synwait-time 30\n zbfw-udp-idle-time 30\n !\n!\nomp\n no shutdown\n graceful-restart\n timers\n holdtime 15\n graceful-restart-timer 120\n exit\n advertise ospf external\n advertise connected\n advertise static\n!\nsecurity\n ipsec\n integrity-type ip-udp-esp esp\n !\n!\nvpn 0\n host vbond ip 10.0.12.26 2001:a0:c::1a\n interface ge0/1\n ip address 10.0.26.11/24\n no shutdown\n !\n interface ge0/2\n ip address 10.0.5.11/24\n tunnel-interface\n encapsulation ipsec\n color lte\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n !\n no shutdown\n !\n interface ge0/4\n ip address 10.0.7.11/24\n no shutdown\n !\n interface ge0/7\n ip address 10.0.100.11/24\n no shutdown\n !\n ip route 0.0.0.0/0 10.0.5.13\n!\nvpn 1\n router\n ospf\n router-id 172.16.255.11\n timers spf 200 1000 10000\n redistribute static\n redistribute omp\n area 0\n interface ge0/0\n exit\n exit\n !\n !\n interface ge0/0\n ip address 10.2.2.11/24\n no shutdown\n !\n!\nvpn 512\n interface eth0\n ip dhcp-client\n ipv6 dhcp-client\n no shutdown\n !\n!\n"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/template/config/vpn/{deviceId}":{"get":{"tags":["Configuration - Template Configuration"],"description":"Get list of configured VPN (excluding reserved VPN) for a device","operationId":"getVpnForDevice","parameters":[{"name":"deviceId","in":"path","description":"Device Model ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPN":{"description":"VPN","value":["1"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write"}},"/template/cor":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get Cloud On Ramp list","operationId":"getCORStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cloud on ramp status":{"description":"Cloud on ramp status","value":{"data":[{"accountId":"010098612700","accountName":"010098612700","cloudType":"AWS","mappedAccountCount":0,"cloudRegionList":[{"cloudRegion":"us-west-1","transitVpcCount":1,"hostVpcCount":0,"deviceCount":2,"hostVpcReachableCount":0,"hostVpcUnreachableCount":0,"deviceReachableCount":0,"deviceUnreachableCount":2}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Map Host to Transit VPC/VNet","operationId":"createAndMap","requestBody":{"description":"Map host to transit VPC request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Map host to transit VPC request":{"description":"Map host to transit VPC request"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/accountid/{accountid}":{"delete":{"tags":["Configuration - Cloud On Ramp"],"description":"Delete transit VPC/VNet","operationId":"removeTransitVPC","parameters":[{"name":"accountid","in":"path","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"transitvpcid","in":"query","description":"Cloud VPC Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/acquireResourcePool":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Acquire IP from resource pool","operationId":"acquireResourcePool","requestBody":{"description":"Add IP from resource pool request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Add IP from resource pool request":{"description":"Add IP from resource pool request"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/ami":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get AMI list","operationId":"getAmiList","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"AMI":{"description":"AMI","value":"{\"data\":{\n \"amis\":[\n {\n \"amiId\":\"ami-00c8377340219e9fc\",\n \"version\":\"18.3.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-0136d4095d027e741\",\n \"version\":\"19.1.0-temp\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02a3c4c89a7e3294e\",\n \"version\":\"19.1.0\",\n \"modelType\":\"vedge\"\n },\n {\n \"amiId\":\"ami-02f9c3711e326dcb6\",\n \"version\":\"csr-CSR_SDWAN-AMI.16.12.01b-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0be17bfec080cee40.4\",\n \"modelType\":\"csr\"\n },\n {\n \"amiId\":\"ami-053eee5e68e33f25b\",\n \"version\":\"Cisco-CSR-SDWAN-16.12.03-8ffa16cf-1756-44a2-9e95-2b4369bb2fe9-ami-0379a842c0f9e5378.4\",\n \"modelType\":\"csr\"\n }\n ]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud list","operationId":"getCloudList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cloud type":{"description":"Cloud type","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud/account":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud accounts","operationId":"getCloudAccounts","parameters":[{"name":"cloudtype","in":"query","description":"Cloud type","required":true,"schema":{"type":"string"}},{"name":"cloudEnvironment","in":"query","description":"Cloud environment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud/authenticate":{"put":{"tags":["Configuration - Cloud On Ramp"],"description":"Authenticate and update cloud account credentials","operationId":"authenticateCredAndUpdate","requestBody":{"description":"Cloud account credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account credential":{"description":"Cloud account credential","value":{"cloudType":"AWS","authType":"KEY","apiKey":"dummy","secretKey":"dummy"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Authenticate cloud account credentials","operationId":"authenticateCloudOnRampCredAndAdd","requestBody":{"description":"Cloud account credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account credential":{"description":"Cloud account credential","value":{"cloudType":"AWS","authType":"KEY","apiKey":"dummy","secretKey":"dummy"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud account":{"description":"Cloud account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/cloud/host/accountdetails":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud host VPC account details","operationId":"getCloudHostVpcAccountDetails","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud host account":{"description":"Cloud host account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/cloud/mappedhostaccounts":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get cloud mapped accounts view","operationId":"getCloudMappedHostAccounts","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Cloud mapped host account":{"description":"Cloud mapped host account","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/createResourcePool":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Add resource pool","operationId":"createResourcePool","requestBody":{"description":"Add resource pool request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Add resource pool request":{"description":"Add resource pool request"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/deleteDevicepair":{"delete":{"tags":["Configuration - Cloud On Ramp"],"description":"Remove device pair","operationId":"removeDeviceId","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"transitvpcid","in":"query","description":"VPC Id","required":true,"schema":{"type":"string"}},{"name":"transitvpcname","in":"query","description":"VPC Name","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}},{"name":"devicePairId","in":"query","description":"Device pair Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/device":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get available device list","operationId":"getCloudOnRampDevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":"data"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/devicepair":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Add device pair","operationId":"addDevicePair","requestBody":{"description":"Add device pair request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Add device pair request":{"description":"Add device pair request"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/devicepair/hostvpc":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get host VPC details","operationId":"getHostVPCs","parameters":[{"name":"transitVpcId","in":"query","description":"Transit VPC Id","required":true,"schema":{"type":"string"}},{"name":"devicePairId","in":"query","description":"Device pair Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Host VPC":{"description":"Host VPC","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/externalId":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get the vManage external ID for AWS","operationId":"getExternalId","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"externalId":{"description":"externalId","value":"12345abcd"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/getTransitDevicePairAndHostList":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get device and host details","operationId":"getTransitDevicePairAndHostList","parameters":[{"name":"accountId","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudRegion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device and host":{"description":"Device and host","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/getTransitVpnList":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPN list","operationId":"getTransitVpcVpnList","parameters":[{"name":"accountId","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Transit VPN":{"description":"Transit VPN","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/hostvpc":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get host VPC/VNet list","operationId":"getCloudHostVPCs","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPC/VNet":{"description":"VPC/VNet","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/map":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get mapped VPC/VNet list","operationId":"getMappedVPCs","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Map host to transit VPC/VNet","operationId":"mapVPCs","requestBody":{"description":"Map host to VPC/VNet","content":{"application/json":{"schema":{"type":"object"},"examples":{"Map host to VPC/VNet":{"description":"Map host to VPC/VNet"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"},"delete":{"tags":["Configuration - Cloud On Ramp"],"description":"Unmap host from transit VPC/VNet","operationId":"unmapVPCs","requestBody":{"description":"Unmap host to VPC/VNet","content":{"application/json":{"schema":{"type":"object"},"examples":{"Unmap host to VPC/VNet":{"description":"Unmap host to VPC/VNet"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/pem":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPC PEM key list","operationId":"getPemKeyList","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"PEM key":{"description":"PEM key","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cor/scale/down":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Scale down cloud on ramp","operationId":"scaleDown","requestBody":{"description":"Update VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update VPC":{"description":"Update VPC"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"viptela-reserved-cloud"}},"/template/cor/scale/up":{"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Scale up cloud on ramp","operationId":"scaleUp","requestBody":{"description":"Update VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"Update VPC":{"description":"Update VPC"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"viptela-reserved-cloud"}},"/template/cor/transitvpc":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPC/VNet list","operationId":"getTransitVPCs","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}},{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPC/VNet list":{"description":"VPC/VNet list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"},"put":{"tags":["Configuration - Cloud On Ramp"],"description":"Update transit VPC/VNet","operationId":"updateTransitVPC","requestBody":{"description":"VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPC":{"description":"VPC","value":{"accountId":"010098612700","cloudRegion":"us-west-1","cloudType":"AWS","transitVpcName":"DemoVPC","transitVpcId":"vpc-0dfdd169a61492554","dia":"DISABLED"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"},"post":{"tags":["Configuration - Cloud On Ramp"],"description":"Create transit VPC/VNet","operationId":"addTransitVPC","requestBody":{"description":"VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPC":{"description":"VPC","value":{"accountId":"010098612700","cloudRegion":"us-west-1","cloudType":"AWS","transitVpcName":"DemoVPC","transitVpcSize":"c3.large","amiId":"ami-0f0f993e800121941","deviceModelType":"vedge","transitVpcSubnet":"","maxHostVpcPerDevicePair":1,"devicePairList":[{"deviceList":[{"uuid":"f21dbb35-30b3-47f4-93bb-d2b2fe092d35","preference":"active"},{"uuid":"52c7911f-c5b0-45df-b826-3155809a2a1a","preference":"backup"}],"devicePairId":"f21dbb35-30b3-47f4-93bb-d2b2fe092d35","isPrimary":true}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"b634bf94-b47b-40a2-ba72-d289036234fd"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/transitvpc/autoscale-properties":{"put":{"tags":["Configuration - Cloud On Ramp"],"description":"Update transit VPC autoscale properties","operationId":"updateTransitVpcAutoscaleProperties","requestBody":{"description":"VPC","content":{"application/json":{"schema":{"type":"object"},"examples":{"VPC":{"description":"VPC","value":{"accountId":"010098612700","cloudRegion":"us-west-1","cloudType":"AWS","transitVpcName":"DemoVPC","transitVpcId":"vpc-0dfdd169a61492554","maxHostVpcPerDevicePair":2}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":""}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-write"}},"/template/cor/transitvpc/size":{"get":{"tags":["Configuration - Cloud On Ramp"],"description":"Get transit VPC supported size","operationId":"getTransitVPCSupportedSize","parameters":[{"name":"cloudtype","in":"query","description":"Cloud type","schema":{"type":"string","default":"AWS"}},{"name":"cloudEnvironment","in":"query","description":"Cloud environment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"VPC size":{"description":"VPC size","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Cloud OnRamp-read"}},"/template/cortex":{"get":{"tags":["Configuration - Azure Connect"],"description":"Get Cortex List","operationId":"getCortexStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cortex status":{"description":"Cortex status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-read"}},"/template/cortex/cloud/authenticate":{"post":{"tags":["Configuration - Azure Connect"],"description":"Authenticate Cloud Account Credentials","operationId":"authenticateAzureConnectCredAndAdd","requestBody":{"description":"Credential","content":{"application/json":{"schema":{"type":"object"},"examples":{"Credential":{"description":"Credential"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/cortex/map":{"get":{"tags":["Configuration - Azure Connect"],"description":"Get Mapped WAN Resource Groups","operationId":"getMappedWanResourceGroups","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}},{"name":"cloudregion","in":"query","description":"Cloud region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource groups":{"description":"WAN resource groups","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/cortex/sync":{"post":{"tags":["Configuration - Azure Connect"],"description":"Sync WAN Resource Groups","operationId":"syncWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/cortex/wanrg":{"get":{"tags":["Configuration - Azure Connect"],"description":"Get WAN Resource Groups","operationId":"getWanResourceGroups","parameters":[{"name":"accountid","in":"query","description":"Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource groups":{"description":"WAN resource groups","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"},"put":{"tags":["Configuration - Azure Connect"],"description":"Edit WAN Resource Groups","operationId":"editWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"},"post":{"tags":["Configuration - Azure Connect"],"description":"Create WAN Resource Groups","operationId":"saveWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"},"delete":{"tags":["Configuration - Azure Connect"],"description":"Delete WAN Resource Groups","operationId":"deleteWanResourceGroups","requestBody":{"description":"WAN resource group","content":{"application/json":{"schema":{"type":"object"},"examples":{"WAN resource group":{"description":"WAN resource group"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cortex-write"}},"/template/device":{"get":{"tags":["Configuration - Template Master"],"description":"Generate template list
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateMasterTemplateList","parameters":[{"name":"feature","in":"query","description":"Feature","required":true,"schema":{"type":"string","enum":["lawful-interception","cloud-dock","network-design","vmanage-default","all"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":{"data":[{"deviceType":"vsmart","lastUpdatedBy":"admin","factoryDefault":false,"templateName":"vSmartConfigurationTemplate","devicesAttached":0,"draftMode":false,"templateDescription":"Config template for vSmarts","templateClass":"vedge","lastUpdatedOn":1529606745011,"configType":"file","templateId":"e1f3de23-1ded-49d8-85b1-1e6ab668775f","templateAttached":0},{"deviceType":"vedge-C1111-8PLTELA","lastUpdatedBy":"system","templateClass":"cedge","configType":"template","templateId":"b6aacdc9-ae1f-4471-a359-13657ce98204","factoryDefault":true,"templateName":"Factory_Default_C1111_8PLTELA_V01","devicesAttached":0,"draftMode":false,"templateDescription":"Factory Default template for C1111-8PLTELA","lastUpdatedOn":1588082428579,"templateAttached":15}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/cli":{"post":{"tags":["Configuration - Template Master"],"description":"Create CLI template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createCLITemplate","requestBody":{"description":"Create template request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateName":"vSmartConfigurationTemplate","templateDescription":"Config template for vSmarts","deviceType":"vsmart","templateConfiguration":"system\n host-name {{Hostname}}\n gps-location latitude {{gps-latitude}}\n gps-location longitude {{gps-longitude}}\n system-ip {{System-IP}}\n site-id {{Site-ID}}\n organization-name \"Cisco Sy1 - 19968\"\n vbond vbond.cisco.com\n aaa\n auth-order local radius tacacs\n usergroup basic\n task system read write\n task interface read write\n !\n usergroup netadmin\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n user admin\n password $6$YsNdljyTklJyRlUZ$u.vOqeMSUbzfc.aWBty9OIovNCxlUASviwfgXO2bTCJV5ddUoV7EG8Q3EA3Yl0aMv./GnJLPPbjC6uQPjtwVo.\n !\n !\n logging\n disk\n enable\n !\n !\n !\n omp\n no shutdown\n send-path-limit 8\n send-backup-paths\n graceful-restart\n !\n banner\n login \"Cisco SD-WAN/Viptela dCloud Demo V2\"\n !\n !\n vpn 0\n dns 198.18.1.1 secondary\n dns 198.18.1.254 primary\n host vbond.cisco.com ip 198.18.1.11 198.18.1.21\n interface eth0\n ip address {{Tunnel-IP-Address}}\n ipv6 dhcp-client\n tunnel-interface\n allow-service dhcp\n allow-service dns\n allow-service icmp\n allow-service sshd\n allow-service netconf\n no allow-service ntp\n no allow-service stun\n !\n no shutdown\n !\n ip route 0.0.0.0/0 {{Default GW}}\n !\n vpn 512\n !","factoryDefault":false,"configType":"file"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"templateId":"81b558c9-f575-4255-ac11-2e5437be1ea0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/config/attachBootStrap":{"post":{"tags":["Configuration - Device Template"],"description":"Attach feature device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"pushMasterTemplate_1","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"deviceTemplateList":[{"templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","device":[{"csv-status":"complete","csv-deviceId":"5e5f45e7-3062-44b2-b6f6-40c682149e05","csv-deviceIP":"172.16.255.11","csv-host-name":"vm1","//system/host-name":"vm1","//system/system-ip":"172.16.255.11","//system/site-id":"100","csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","selected":"true"}],"isEdited":false,"isMasterEdited":false,"isDraftDisabled":false}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attachcli":{"post":{"tags":["Configuration - Device Template"],"description":"Attach CLI device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"pushCLITemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":"{\n \"deviceTemplateList\":[\n {\n \"templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\",\n \"device\":[\n {\n \"csv-status\":\"complete\",\n \"csv-deviceId\":\"5e5f45e7-3062-44b2-b6f6-40c682149e05\",\n \"csv-deviceIP\":\"172.16.255.11\",\n \"csv-host-name\":\"vm1\",\n \"//system/host-name\":\"vm1\",\n \"//system/system-ip\":\"172.16.255.11\",\n \"//system/site-id\":\"100\",\n \"csv-templateId\":\"41f6a440-c5cc-4cc6-9ca1-af18e332a781\",\n \"selected\":\"true\"\n \"pseudoCommitTimer\":11\n }\n ],\n \"isEdited\":false,\n \"isMasterEdited\":false,\n \"isDraftDisabled\":false\n }\n ]\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_file_template_configuration-d13a002a-0475-43bf-85db-ef9224112a52"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attachcloudx":{"put":{"tags":["Configuration - Device Template"],"description":"Edit already enabled gateways, clients, dias
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editCloudxConfig","requestBody":{"description":"CloudX config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudX config":{"description":"CloudX config","value":{"isEdited":true,"siteList":[100,400],"siteType":"dia"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Tenant Id":{"description":"Tenant Id","value":{"id":"push_file_template_configuration-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"},"post":{"tags":["Configuration - Device Template"],"description":"Enable gateways, clients, dias","operationId":"pushCloudxConfig","requestBody":{"description":"CloudX config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudX config":{"description":"CloudX config","value":{"isEdited":false,"siteList":[100],"siteType":"dia"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Tenant Id":{"description":"Tenant Id","value":{"id":"push_file_template_configuration-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attached/{masterTemplateId}":{"get":{"tags":["Configuration - Device Template"],"description":"Get attached device list by master template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAttachedDeviceList","parameters":[{"name":"masterTemplateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Configuration-read"}},"/template/device/config/attachedconfig":{"get":{"tags":["Configuration - Device Template"],"description":"Get attached config to device
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAttachedConfigToDevice","parameters":[{"name":"deviceId","in":"query","description":"Device Model ID","required":true,"schema":{"type":"string"}},{"name":"policyId","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CLI config":{"description":"CLI config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Device Inventory-read"}},"/template/device/config/attachfeature":{"post":{"tags":["Configuration - Device Template"],"description":"Attach feature device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"pushMasterTemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"deviceTemplateList":[{"templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","device":[{"csv-status":"complete","csv-deviceId":"5e5f45e7-3062-44b2-b6f6-40c682149e05","csv-deviceIP":"172.16.255.11","csv-host-name":"vm1","//system/host-name":"vm1","//system/system-ip":"172.16.255.11","//system/site-id":"100","csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","selected":"true"}],"isEdited":false,"isMasterEdited":false,"isDraftDisabled":false}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_feature_template_configuration-4794e7ed-8912-477b-86ec-07b87621ade4"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/attachment":{"post":{"tags":["Configuration - Device Template"],"description":"Attach device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"attachDeviceTemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"deviceTemplateList":[{"templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","device":[{"csv-status":"complete","csv-deviceId":"C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0","csv-deviceIP":"172.16.255.15","csv-host-name":"vm5","//system/host-name":"vm5","//system/system-ip":"172.16.255.15","//system/site-id":"100","csv-templateId":"41f6a440-c5cc-4cc6-9ca1-af18e332a781","selected":"true"}],"isEdited":false,"isMasterEdited":false,"isDraftDisabled":false}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"push_template_configuration-3140b324-7a4b-465d-92cc-847a6c01c340"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/available/{masterTemplateId}":{"get":{"tags":["Configuration - Device Template"],"description":"Get possible device list by master template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDeviceListByMasterTemplateId","parameters":[{"name":"masterTemplateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":{"data":[{"deviceIP":"172.16.255.16","device-groups":["No groups"],"uuid":"C8K-5783e055-2703-440e-91f0-41f4af941603","site-id":"600","host-name":"vm6","local-system-ip":"172.16.255.16"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read"}},"/template/device/config/config":{"post":{"tags":["Configuration - Device Template"],"description":"Get device configuration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDeviceConfigurationPreview","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"templateId":"45d94bf1-30fb-4b00-8bde-2a62c8af97b5","device":{"csv-status":"complete","csv-deviceId":"a1d010e6-bd61-4fbd-8980-96f02db4d0b9","csv-deviceIP":"172.16.255.21","csv-host-name":"vm11","csv-templateId":"45d94bf1-30fb-4b00-8bde-2a62c8af97b5"},"isEdited":false,"isMasterEdited":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"},"examples":{"Device config":{"description":"Device config","value":"system\r\nhost-name vm11\r\ngps-location latitude 35.0\r\ngps-location longitude -78.0\r\nsystem-ip 172.16.255.21\r\nsite-id 100\norganization-name \"vIPtela Inc Regression\"\r\nclock timezone America/Los_Angeles\r\nvbond 10.0.12.26\r\naaa\r\n auth-order local radius tacacs\r\n usergroup basic\r\n task system read write\r\n task interface read write\r\n !"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write"}},"/template/device/config/detach":{"post":{"tags":["Configuration - Device Template"],"description":"Detach device template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"detachDeviceTemplate","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/template/device/config/detachcloudx":{"post":{"tags":["Configuration - Device Template"],"description":"Disable enabled gateways, clients, dias
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"detachSites","requestBody":{"description":"CloudX config","content":{"application/json":{"schema":{"type":"object"},"examples":{"CloudX config":{"description":"CloudX config","value":{"siteList":[100],"siteType":"none"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Tenant Id":{"description":"Tenant Id","value":{"id":"push_file_template_configuration-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/duplicateip":{"post":{"tags":["Configuration - Device Template"],"description":"Detects duplicate system IP from a list of devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDevicesWithDuplicateIP","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":{"device":[{"csv-deviceIP":"10.1.0.1","csv-deviceId":"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de","csv-host-name":"DC1-VEDGE1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/device/config/duplicatelocationname":{"post":{"tags":["Configuration - Device Template"],"description":"Detects duplicate system IP from a list of devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDevicesWithDuplicateLocationName","requestBody":{"description":"Device list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device list":{"description":"Device list","value":{"locations":[{"locationName":"Milpitas, CA","csv-deviceId":"ebdc8bd9-17e5-4eb3-a5e0-f438403a83de"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/device/config/exportcsv":{"post":{"tags":["Configuration - Device Template"],"description":"Export the device template to CSV format for given template id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createInputWithoutDevice","requestBody":{"description":"Device template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template","value":{"templateId":"e1f3de23-1ded-49d8-85b1-1e6ab668775f","isEdited":false,"isMasterEdited":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device input":{"description":"Device input","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/input":{"post":{"tags":["Configuration - Device Template"],"description":"Create device input
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createDeviceInput","requestBody":{"description":"Template device input","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template device input":{"description":"Template device input","value":{"templateId":"6c7d22bc-73d5-4877-9402-26c75a22bd08","deviceIds":["ebdc8bd9-17e5-4eb3-a5e0-f438403a83de"],"isEdited":false,"isMasterEdited":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device input":{"description":"Device input","value":{"data":[{"csv-status":"in_complete","csv-deviceId":"a1d010e6-bd61-4fbd-8980-96f02db4d0b9","csv-deviceIP":"172.16.255.21","csv-host-name":"vm11","//system/host-name":"vm11","//system/system-ip":"172.16.255.21","//system/site-id":"11"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/process/input/file":{"post":{"tags":["Configuration - Device Template"],"description":"Process input comma separated file
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"processInputCommaSepFile","requestBody":{"description":"Device template","content":{"multipart/form-data":{"schema":{"type":"object"},"examples":{"Device template":{"description":"Device template"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Device config":{"description":"Device config","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/quickconnectvariable":{"post":{"tags":["Configuration - Device Template"],"description":"Get connection variables to be configured","operationId":"getQuickConnectVariables","requestBody":{"description":"Device List","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device List":{"description":"Device List","value":[]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Variable list":{"description":"Variable list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"}},"/template/device/config/vbond":{"get":{"tags":["Configuration - Device Template"],"description":"Check if vBond is configured
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"checkVbond","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Is vBond configured":{"description":"Is vBond configured","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Configuration-read"}},"/template/device/config/verify":{"post":{"tags":["Configuration - Device Template"],"description":"Validate full template\"\n
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"validateTemplate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{}}}},"deprecated":true,"x-roles-required":"Template Deploy-write"}},"/template/device/feature":{"post":{"tags":["Configuration - Template Master"],"description":"Create a device template from feature templates and sub templates
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createMasterTemplate","requestBody":{"description":"Create template request","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateName":"vEdge_Device_Template","templateDescription":"Demo device template","deviceType":"vedge-100","configType":"template","factoryDefault":false,"policyId":"","featureTemplateUidRange":[],"connectionPreferenceRequired":true,"connectionPreference":true,"generalTemplates":[{"templateId":"3b30e089-2e26-44f1-b5b2-ac44f3f4279e","templateType":"aaa"},{"templateId":"0419c4f6-eb61-4048-a3fe-78ea7f7248b0","templateType":"bfd-vedge"},{"templateId":"eb7162be-b018-47c5-b1de-bbb65ff802e3","templateType":"omp-vedge"},{"templateId":"486d419f-4e6c-44a5-a6fb-7b5ccf94ff90","templateType":"security-vedge"},{"templateId":"7d7396a2-4715-44d8-8f6e-ddf0ca06be44","templateType":"system-vedge","subTemplates":[{"templateId":"edf3d309-91d4-45be-98d9-cfd57a05a479","templateType":"logging"}]},{"templateId":"171e9bd4-7a7b-460d-b692-83f0d5ce0124","templateType":"vpn-vedge","subTemplates":[{"templateId":"a632ee5f-f489-46ec-8761-1b493d5a6a40","templateType":"vpn-vedge-interface"}]},{"templateId":"45ea940a-45d2-4fd9-8da2-570a1a6d6874","templateType":"vpn-vedge"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"templateId":"81610551-9dc5-492f-ad3b-b2c30077b992"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/is_migration_required":{"get":{"tags":["Configuration - Template Master"],"description":"Check if any device templates need migration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"isMigrationRequired","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Boolean":{"description":"Boolean","value":{"data":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/migration":{"get":{"tags":["Configuration - Template Master"],"description":"Generate a list of templates which require migration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateForMigration","parameters":[{"name":"hasAAA","in":"query","description":"Return only those uses AAA","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template":{"description":"Template","value":{"data":[{"deviceType":"vedge-CSR-1000v","lastUpdatedBy":"admin","templateClass":"cedge_vedge","templateId":"c62e6fba-fb53-4562-b436-3878de0fbbc2","configType":"template","factoryDefault":false,"templateName":"BranchType1Template-CSR","devicesAttached":2,"templateDescription":"Branch Type 1 Template for CSR Routers","lastUpdatedOn":1588093291553,"templateAttached":22}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Template Master"],"description":"Migrate the device templates given the template Ids","operationId":"migrateTemplates","parameters":[{"name":"id","in":"query","description":"Template Id","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"prefix","in":"query","description":"Prefix","schema":{"type":"string","default":"cisco"}},{"name":"includeAll","in":"query","description":"Include all flag","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"status":"Template migration started","taskId":"TEMPLATE_MIGRATIONa548c416-bfb8-46dd-9866-d0aa042f17ab"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/migration_info":{"get":{"tags":["Configuration - Template Master"],"description":"Returns the mapping between old and migrated templates
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"migrationInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Migrated templates mapping":{"description":"Migrated templates mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/object/{templateId}":{"get":{"tags":["Configuration - Template Master"],"description":"Generate template by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getMasterTemplateDefinition","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateName":"Default_EQUINIX_DHCP_DNS_ICGW_CSR1000V_Template_V02","templateDescription":"Default DHCP DNS device template for Equinix Interconnect Gateway CSR1000V","deviceType":"vedge-CSR-1000v","configType":"template","factoryDefault":true,"policyId":"","featureTemplateUidRange":[],"connectionPreference":true,"connectionPreferenceRequired":true,"generalTemplates":[{"templateId":"857c21b1-6ceb-41a6-b4f1-f6f2c2fb3de6","templateType":"cedge_aaa"},{"templateId":"154fbddf-4430-4629-8fdc-6fd12d35d8b6","templateType":"cisco_bfd"},{"templateId":"c8f31360-9b6a-451e-8d21-aba3ac0c41d9","templateType":"cisco_omp"},{"templateId":"348a0dc3-2796-4b8f-9158-6faa384fa14c","templateType":"cisco_security"},{"templateId":"32372d0e-bcf6-416f-9c16-2d2ab14bd752","templateType":"cisco_system","subTemplates":[{"templateId":"8627651a-0140-42d9-925b-706e6281dbac","templateType":"cisco_logging"}]},{"templateId":"e54fc487-46d4-4f8c-8ffd-fec76ed1826c","templateType":"cisco_vpn","subTemplates":[{"templateId":"b8415ca4-16de-4bbb-90f3-05d652747370","templateType":"cisco_vpn_interface"}]},{"templateId":"db1d1bbf-a6b3-47b5-8c05-1f6004e3d68d","templateType":"cisco_vpn","subTemplates":[{"templateId":"5f0d22ae-b5ae-4c3c-afa7-53e2c8119ebd","templateType":"cisco_vpn_interface"}]},{"templateId":"b71170bc-97be-47b5-b9f8-bcf1782a8286","templateType":"cedge_global"}],"templateClass":"cedge","templateId":"067250e7-4e82-4ce0-9e42-1a58a9634afb","deviceRole":"sdwan-edge","draftMode":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/resource-group/{resourceGroupName}/{templateId}":{"post":{"tags":["Configuration - Template Master"],"description":"Change template resource group","operationId":"changeTemplateResourceGroup_1","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"path","description":"Resource group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/syncstatus":{"get":{"tags":["Configuration - Template Master"],"description":"Get template sync status
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getOutOfSyncTemplates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/syncstatus/{templateId}":{"get":{"tags":["Configuration - Template Master"],"description":"Get out of sync devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getOutOfSyncDevices","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Devices":{"description":"Devices","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/{templateId}":{"put":{"tags":["Configuration - Template Master"],"description":"Edit template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editMasterTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateId":"81610551-9dc5-492f-ad3b-b2c30077b992","templateName":"vEdge_Device_Template","templateDescription":"Demo device template","deviceType":"vedge-100","configType":"template","factoryDefault":false,"policyId":"","featureTemplateUidRange":[],"connectionPreferenceRequired":true,"connectionPreference":true,"draftMode":false,"generalTemplates":[{"templateId":"3b30e089-2e26-44f1-b5b2-ac44f3f4279e","templateType":"aaa"},{"templateId":"e1b5b6e9-3b54-4279-a532-a2aaaef3e6a1","templateType":"bfd-vedge"},{"templateId":"998725f9-3572-4950-a5e5-d48827d347cd","templateType":"omp-vedge"},{"templateId":"486d419f-4e6c-44a5-a6fb-7b5ccf94ff90","templateType":"security-vedge"},{"templateId":"7d7396a2-4715-44d8-8f6e-ddf0ca06be44","templateType":"system-vedge","subTemplates":[{"templateId":"edf3d309-91d4-45be-98d9-cfd57a05a479","templateType":"logging"}]},{"templateId":"171e9bd4-7a7b-460d-b692-83f0d5ce0124","templateType":"vpn-vedge","subTemplates":[{"templateId":"a632ee5f-f489-46ec-8761-1b493d5a6a40","templateType":"vpn-vedge-interface"}]},{"templateId":"45ea940a-45d2-4fd9-8da2-570a1a6d6874","templateType":"vpn-vedge"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Attached devices":{"description":"Attached devices","value":{"data":{"attachedDevices":[]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Template Master"],"description":"Delete template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteMasterTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/device/{templateId}/featuretemplates":{"get":{"tags":["Configuration - Template Master"],"description":"get Associated Feature Templates Details","operationId":"getAssociatedFeatureTemplatesDetails","parameters":[{"name":"templateId","in":"path","description":"TemplateId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/feature":{"get":{"tags":["Configuration - General Template"],"description":"Get feature template list
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateFeatureTemplateList","parameters":[{"name":"summary","in":"query","description":"Flag to include template definition","schema":{"type":"boolean","default":false}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit on templateId","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Feature template":{"description":"Feature template","value":{"data":[{"templateId":"07a5de3c-4dfa-4eb3-bf52-7ee8076e29a9","templateName":"Default_Azure_vWAN_C8000V_VPN0_INTF_GE1_V01","templateDescription":"Default VPN 0 Interface GigabitEthernet1 template for Azure vWAN C8000V","templateType":"cisco_vpn_interface","deviceType":["vedge-C8000V"],"lastUpdatedBy":"system","lastUpdatedOn":1631281281614,"factoryDefault":true,"devicesAttached":0,"attachedMastersCount":1,"templateMinVersion":"20.4.0","configType":"xml","createdBy":"system","createdOn":1631281281614,"resourceGroup":"global"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"},"post":{"tags":["Configuration - General Template"],"description":"Create feature template","operationId":"createFeatureTemplate","requestBody":{"description":"Feature template","content":{"application/json":{"schema":{"type":"object"},"examples":{"CedgeVoiceCard-example":{"description":"CedgeVoiceCard-example","$ref":"#/components/examples/CedgeVoiceCard"},"CedgeVoiceSrst-example":{"description":"CedgeVoiceSrst-example","$ref":"#/components/examples/CedgeVoiceSrst"},"aaa-example":{"description":"aaa-example","$ref":"#/components/examples/aaa"},"appqoe-example":{"description":"appqoe-example","$ref":"#/components/examples/appqoe"},"archive-example":{"description":"archive-example","$ref":"#/components/examples/archive"},"banner-example":{"description":"banner-example","$ref":"#/components/examples/banner"},"bfd-vedge-example":{"description":"bfd-vedge-example","$ref":"#/components/examples/bfd-vedge"},"bgp-example":{"description":"bgp-example","$ref":"#/components/examples/bgp"},"bridge-example":{"description":"bridge-example","$ref":"#/components/examples/bridge"},"cedge_aaa-example":{"description":"cedge_aaa-example","$ref":"#/components/examples/cedge_aaa"},"cedge_global-example":{"description":"cedge_global-example","$ref":"#/components/examples/cedge_global"},"cedge_igmp-example":{"description":"cedge_igmp-example","$ref":"#/components/examples/cedge_igmp"},"cedge_multicast-example":{"description":"cedge_multicast-example","$ref":"#/components/examples/cedge_multicast"},"cedge_pim-example":{"description":"cedge_pim-example","$ref":"#/components/examples/cedge_pim"},"cellular-cedge-controller-example":{"description":"cellular-cedge-controller-example","$ref":"#/components/examples/cellular-cedge-controller"},"cellular-cedge-gps-controller-example":{"description":"cellular-cedge-gps-controller-example","$ref":"#/components/examples/cellular-cedge-gps-controller"},"cellular-cedge-profile-example":{"description":"cellular-cedge-profile-example","$ref":"#/components/examples/cellular-cedge-profile"},"cellular-gateway-platform-example":{"description":"cellular-gateway-platform-example","$ref":"#/components/examples/cellular-gateway-platform"},"cellular-gateway-profile-example":{"description":"cellular-gateway-profile-example","$ref":"#/components/examples/cellular-gateway-profile"},"cellular-profile-example":{"description":"cellular-profile-example","$ref":"#/components/examples/cellular-profile"},"cisco_banner-example":{"description":"cisco_banner-example","$ref":"#/components/examples/cisco_banner"},"cisco_bfd-example":{"description":"cisco_bfd-example","$ref":"#/components/examples/cisco_bfd"},"cisco_bgp-example":{"description":"cisco_bgp-example","$ref":"#/components/examples/cisco_bgp"},"cisco_dhcp_server-example":{"description":"cisco_dhcp_server-example","$ref":"#/components/examples/cisco_dhcp_server"},"cisco_dsp_farm-example":{"description":"cisco_dsp_farm-example","$ref":"#/components/examples/cisco_dsp_farm"},"cisco_logging-example":{"description":"cisco_logging-example","$ref":"#/components/examples/cisco_logging"},"cisco_ntp-example":{"description":"cisco_ntp-example","$ref":"#/components/examples/cisco_ntp"},"cisco_omp-example":{"description":"cisco_omp-example","$ref":"#/components/examples/cisco_omp"},"cisco_ospf-example":{"description":"cisco_ospf-example","$ref":"#/components/examples/cisco_ospf"},"cisco_ospfv3-example":{"description":"cisco_ospfv3-example","$ref":"#/components/examples/cisco_ospfv3"},"cisco_secure_internet_gateway-example":{"description":"cisco_secure_internet_gateway-example","$ref":"#/components/examples/cisco_secure_internet_gateway"},"cisco_security-example":{"description":"cisco_security-example","$ref":"#/components/examples/cisco_security"},"cisco_sig_credential-example":{"description":"cisco_sig_credential-example","$ref":"#/components/examples/cisco_sig_credentials"},"cisco_snmp-example":{"description":"cisco_snmp-example","$ref":"#/components/examples/cisco_snmp"},"cisco_system-example":{"description":"cisco_system-example","$ref":"#/components/examples/cisco_system"},"cisco_thousandeye-example":{"description":"cisco_thousandeye-example","$ref":"#/components/examples/cisco_thousandeyes"},"cisco_trustsec-example":{"description":"cisco_trustsec-example","$ref":"#/components/examples/cisco_trustsec"},"cisco_vp-example":{"description":"cisco_vp-example","$ref":"#/components/examples/cisco_vpn"},"cisco_vpn_interface-example":{"description":"cisco_vpn_interface-example","$ref":"#/components/examples/cisco_vpn_interface"},"cisco_vpn_interface_gre-example":{"description":"cisco_vpn_interface_gre-example","$ref":"#/components/examples/cisco_vpn_interface_gre"},"cisco_vpn_interface_ipsec-example":{"description":"cisco_vpn_interface_ipsec-example","$ref":"#/components/examples/cisco_vpn_interface_ipsec"},"cisco_wireless_la-example":{"description":"cisco_wireless_la-example","$ref":"#/components/examples/cisco_wireless_lan"},"cli-template-example":{"description":"cli-template-example","$ref":"#/components/examples/cli-template"},"dhcp-server-example":{"description":"dhcp-server-example","$ref":"#/components/examples/dhcp-server"},"eigrp-example":{"description":"eigrp-example","$ref":"#/components/examples/eigrp"},"igmp-example":{"description":"igmp-example","$ref":"#/components/examples/igmp"},"logging-example":{"description":"logging-example","$ref":"#/components/examples/logging"},"multicast-example":{"description":"multicast-example","$ref":"#/components/examples/multicast"},"ntp-example":{"description":"ntp-example","$ref":"#/components/examples/ntp"},"omp-vedge-example":{"description":"omp-vedge-example","$ref":"#/components/examples/omp-vedge"},"omp-vsmart-example":{"description":"omp-vsmart-example","$ref":"#/components/examples/omp-vsmart"},"ospf-example":{"description":"ospf-example","$ref":"#/components/examples/ospf"},"pim-example":{"description":"pim-example","$ref":"#/components/examples/pim"},"probe-example":{"description":"probe-example","$ref":"#/components/examples/probes"},"secure-internet-gateway-example":{"description":"secure-internet-gateway-example","$ref":"#/components/examples/secure-internet-gateway"},"security-vedge-example":{"description":"security-vedge-example","$ref":"#/components/examples/security-vedge"},"security-vsmart-example":{"description":"security-vsmart-example","$ref":"#/components/examples/security-vsmart"},"sig-credential-example":{"description":"sig-credential-example","$ref":"#/components/examples/sig-credentials"},"snmp-example":{"description":"snmp-example","$ref":"#/components/examples/snmp"},"switchport-example":{"description":"switchport-example","$ref":"#/components/examples/switchport"},"system-vedge-example":{"description":"system-vedge-example","$ref":"#/components/examples/system-vedge"},"system-vsmart-example":{"description":"system-vsmart-example","$ref":"#/components/examples/system-vsmart"},"t1-e1-controller-example":{"description":"t1-e1-controller-example","$ref":"#/components/examples/t1-e1-controller"},"tenant-example":{"description":"tenant-example","$ref":"#/components/examples/tenant"},"ucse-example":{"description":"ucse-example","$ref":"#/components/examples/ucse"},"virtual-application-utd-example":{"description":"virtual-application-utd-example","$ref":"#/components/examples/virtual-application-utd"},"vpn-cedge-interface-cellular-example":{"description":"vpn-cedge-interface-cellular-example","$ref":"#/components/examples/vpn-cedge-interface-cellular"},"vpn-cedge-interface-multilink-controller-example":{"description":"vpn-cedge-interface-multilink-controller-example","$ref":"#/components/examples/vpn-cedge-interface-multilink-controller"},"vpn-interface-ethpppoe-example":{"description":"vpn-interface-ethpppoe-example","$ref":"#/components/examples/vpn-interface-ethpppoe"},"vpn-interface-ipoe-example":{"description":"vpn-interface-ipoe-example","$ref":"#/components/examples/vpn-interface-ipoe"},"vpn-interface-pppoa-example":{"description":"vpn-interface-pppoa-example","$ref":"#/components/examples/vpn-interface-pppoa"},"vpn-interface-pppoe-example":{"description":"vpn-interface-pppoe-example","$ref":"#/components/examples/vpn-interface-pppoe"},"vpn-interface-svi-example":{"description":"vpn-interface-svi-example","$ref":"#/components/examples/vpn-interface-svi"},"vpn-interface-t1-e1-example":{"description":"vpn-interface-t1-e1-example","$ref":"#/components/examples/vpn-interface-t1-e1"},"vpn-vedge-interface-bridge-example":{"description":"vpn-vedge-interface-bridge-example","$ref":"#/components/examples/vpn-vedge-interface-bridge"},"vpn-vedge-interface-cellular-example":{"description":"vpn-vedge-interface-cellular-example","$ref":"#/components/examples/vpn-vedge-interface-cellular"},"vpn-vedge-interface-gre-example":{"description":"vpn-vedge-interface-gre-example","$ref":"#/components/examples/vpn-vedge-interface-gre"},"vpn-vedge-interface-ipsec-example":{"description":"vpn-vedge-interface-ipsec-example","$ref":"#/components/examples/vpn-vedge-interface-ipsec"},"vpn-vedge-interface-natpool-example":{"description":"vpn-vedge-interface-natpool-example","$ref":"#/components/examples/vpn-vedge-interface-natpool"},"vpn-vedge-interface-ppp-example":{"description":"vpn-vedge-interface-ppp-example","$ref":"#/components/examples/vpn-vedge-interface-ppp"},"vpn-vedge-interface-vap-example":{"description":"vpn-vedge-interface-vap-example","$ref":"#/components/examples/vpn-vedge-interface-vap"},"vpn-vedge-interface-example":{"description":"vpn-vedge-interface-example","$ref":"#/components/examples/vpn-vedge-interface"},"vpn-vedge-pppoe-enabled-interface-example":{"description":"vpn-vedge-pppoe-enabled-interface-example","$ref":"#/components/examples/vpn-vedge-pppoe-enabled-interface"},"vpn-vedge-example":{"description":"vpn-vedge-example","$ref":"#/components/examples/vpn-vedge"},"vpn-vmanage-interface-example":{"description":"vpn-vmanage-interface-example","$ref":"#/components/examples/vpn-vmanage-interface"},"vpn-vsmart-interface-example":{"description":"vpn-vsmart-interface-example","$ref":"#/components/examples/vpn-vsmart-interface"},"vpn-vsmart-example":{"description":"vpn-vsmart-example","$ref":"#/components/examples/vpn-vsmart"},"wla-example":{"description":"wla-example","$ref":"#/components/examples/wlan"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Feature template":{"description":"Feature template","value":{"templateId":"ff3b31b1-0262-44d3-badf-d9cf472fb4b1"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/template/feature/clone":{"post":{"tags":["Configuration - General Template"],"description":"Clone a feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"cloneTemplate","parameters":[{"name":"id","in":"query","description":"Template Id to clone from","required":true,"schema":{"type":"string"},"example":"220a6bd0-28ef-4c88-92e6-ee7539396fd7"},{"name":"name","in":"query","description":"Name for the cloned template","required":true,"schema":{"type":"string"},"example":"BR2-VPN10-Feature"},{"name":"desc","in":"query","description":"Description for the cloned template","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{"templateId":"ff3b31b1-0262-44d3-badf-d9cf472fb4b1"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/template/feature/default/networkinterface":{"get":{"tags":["Configuration - General Template"],"description":"Get default network interface
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getNetworkInterface","parameters":[{"name":"deviceModel","in":"query","description":"Device model","required":true,"schema":{"type":"string","enum":["ENCS","C8200-UCPE","C8200-UCPEVM"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Default network Interface":{"description":"Default network Interface","value":{"data":[{"lan":["GE0-2","GE0-3","GE0-4","GE0-5"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/feature/default/networks":{"get":{"tags":["Configuration - General Template"],"description":"Get default networks
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDefaultNetworks","parameters":[{"name":"deviceModel","in":"query","description":"Device model","required":true,"schema":{"type":"string","enum":["vedge-nfvis-ENCS5400","vedge-nfvis-C8200-UCPE","vedge-nfvis-C8200-UCPEVM"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Default network":{"description":"Default network","value":{"data":[{"name":"wan-net","sriov":false,"trunk":true,"bridge":"wan-br","bridgePort":"GE0-0"},{"name":"wan2-net","sriov":false,"trunk":true,"bridge":"wan2-br","bridgePort":"GE0-1"},{"name":"lan-net","sriov":false,"trunk":true,"bridge":"lan-br","bridgePort":"int-LAN"},{"name":"GE0-0-SRIOV-1","sriov":true,"trunk":true},{"name":"GE0-0-SRIOV-2","sriov":true,"trunk":true},{"name":"GE0-1-SRIOV-1","sriov":true,"trunk":true},{"name":"GE0-1-SRIOV-2","sriov":true,"trunk":true},{"name":"LAN-SRIOV-1","sriov":true,"trunk":true},{"name":"LAN-SRIOV-2","sriov":true,"trunk":true},{"name":"LAN-SRIOV-3","sriov":true,"trunk":true}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/feature/definition/{templateId}":{"get":{"tags":["Configuration - General Template"],"description":"Get the configured template definition for given template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTemplateDefinition","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template definition":{"description":"Template definition","value":{"appnav-controller-group":{"vipObjectType":"tree","vipType":"constant","vipValue":[{"group-name":{"vipObjectType":"object","vipType":"constant","vipValue":"ACG-APPQOE"},"appnav-controllers":{"vipObjectType":"tree","vipType":"constant","vipPrimaryKey":["address"],"vipValue":[{"address":{"vipObjectType":"object","vipType":"constant","vipValue":"10.10.10.10"},"vpn":{"vipObjectType":"object","vipType":"constant","vipValue":512}}]}}],"vipPrimaryKey":["group-name"]},"service-node-group":{"vipObjectType":"tree","vipType":"constant","vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"SNG-APPQOE"},"internal":{"vipObjectType":"node-only","vipType":"constant","vipValue":false},"service-node":{"vipObjectType":"tree","vipType":"constant","vipPrimaryKey":["address"],"vipValue":[{"address":{"vipObjectType":"object","vipType":"constant","vipValue":"10.10.11.11"},"vpg-ip":{"vipObjectType":"object","vipType":"ignore","vipValue":""}}]}}],"vipPrimaryKey":["name"]},"service-context":{"appqoe":{"vipObjectType":"tree","vipType":"constant","vipPrimaryKey":["name"],"vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":"/1"},"appnav-controller-group":{"vipObjectType":"object","vipType":"constant","vipValue":"ACG-APPQOE"},"service-node-groups":{"vipObjectType":"list","vipType":"constant","vipValue":["SNG-APPQOE"]},"service-node-group":{"vipObjectType":"object","vipType":"constant","vipValue":"SNG-APPQOE"},"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true"},"vpn":{"vipObjectType":"object","vipType":"ignore","vipValue":0,"vipVariableName":"appqoe_vrf"}}]}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"}},"/template/feature/devicetemplates/{templateId}":{"get":{"tags":["Configuration - General Template"],"description":"Get all device templates for this feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getDeviceTemplatesAttachedToFeature","parameters":[{"name":"templateId","in":"path","description":"Feature template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"data":[{"templateName":"Default_SDBranch_C8000V_Template_V01","templateId":"cd72321b-9ff0-4fb3-badd-965d528e71ac"},{"templateName":"Default_BOOTSTRAP_DHCP_8000V_Template_V01","templateId":"41c50079-1978-462e-8489-d4ad5d3b3644"},{"templateName":"Default_MEGAPORT_ICGW_C8000V_Template_V01","templateId":"5880350d-bdb9-4d34-85b0-782c77c96ea9"},{"templateName":"Default_EQUINIX_DHCP_DNS_ICGW_CSR1000V_Template_V02","templateId":"600ca2bc-0cc1-4c1b-a3cd-4fa4ae4dc2e1"},{"templateName":"Default_Azure_vWAN_C8000V_Template_V01","templateId":"a1e8373a-9b9b-4d22-b275-bc1671891798"},{"templateName":"Factory_Default_C8000V_V01","templateId":"0513c5c1-b1e9-4b89-875f-fbe0f8957611"},{"templateName":"Default_BOOTSTRAP_STATIC_8000V_Template_V01","templateId":"af0119de-0223-4ddd-9515-f12a03affc77"},{"templateName":"Default_AWS_TGW_C8000V_Template_V01","templateId":"7188945f-7b44-4d45-8dbc-71a24218bcbd"},{"templateName":"Default_GCP_C8000V_Template_V01","templateId":"873e7414-dd35-4706-b776-c7d2b6d1ee55"},{"templateName":"Default_AWS_TGW_CSR1000V_Template_V01","templateId":"d4e1bd4b-bec8-4522-94c5-7047b44ee02a"},{"templateName":"Factory_Default_ISR_4331_V01","templateId":"6c69af42-5cc4-4f76-92b7-f0e20d4969e4"},{"templateName":"Factory_Default_C1111_8PLTELA_V01","templateId":"ef3a49c8-87cb-41b5-913e-042d110ca1f2"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/li":{"get":{"tags":["Configuration - General Template"],"description":"Get LI feature template","operationId":"listLITemplate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"LI template":{"description":"LI template","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Lawful Interception-read"},"post":{"tags":["Configuration - General Template"],"description":"Create LI feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createLITemplate","requestBody":{"description":"LI template","content":{"application/json":{"schema":{"type":"object"},"examples":{"LI template":{"description":"LI template","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template Id":{"description":"Template Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Lawful Interception-write"}},"/template/feature/li/{templateId}":{"put":{"tags":["Configuration - General Template"],"description":"Update LI feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editLITemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"LI template","content":{"application/json":{"schema":{"type":"object"},"examples":{"LI template":{"description":"LI template","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Lawful Interception-write"}},"/template/feature/master/{type_name}":{"get":{"tags":["Configuration - General Template"],"description":"Generate template type definition by device type
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateMasterTemplateDefinition","parameters":[{"name":"type_name","in":"path","description":"Device type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"name":"vedge","fields":[{"min":0,"deviceModels":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vedge-ISR1100-4GLTE","vedge-100-WM","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"max":1,"displayName":"AAA","name":"aaa"},{"subtree":[{"subtree":[{"min":0,"deviceModels":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vedge-ISR1100-4GLTE","vedge-100-WM","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"max":1,"displayName":"DHCPServer","name":"dhcp-server"}]}],"min":0,"deviceModels":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vedge-ISR1100-4GLTE","vedge-100-WM","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"max":62,"displayName":"VPN","name":"vpn-vedge","type":""}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/migration":{"get":{"tags":["Configuration - General Template"],"description":"Generate a list of templates which require migration
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTemplateForMigration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":{"data":[{"deviceType":"vedge-CSR-1000v","lastUpdatedBy":"admin","templateClass":"cedge_vedge","templateId":"c62e6fba-fb53-4562-b436-3878de0fbbc2","configType":"template","factoryDefault":false,"templateName":"BranchType1Template-CSR","devicesAttached":2,"templateDescription":"Branch Type 1 Template for CSR Routers","lastUpdatedOn":1588093291553,"templateAttached":22}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read,Lawful Interception-read"}},"/template/feature/object/{templateId}":{"get":{"tags":["Configuration - General Template"],"description":"Get template object definition for given template Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getGeneralTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"templateType":"cedgeVoiceCard","templateMinVersion":"15.0.0","deviceType":["vedge-ISR-4461"],"lastUpdatedBy":"admin","editedTemplateDefinition":{"voice-card":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["port-id"],"vipValue":[{"port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0/7"},"id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0","vipVariableName":"analog_id"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"SM-X-8FXS/12FXO"},"description":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_description_"},"caller-id":{"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true","vipVariableName":"analog_caller_id_"}},"port-type":{"vipObjectType":"object","vipType":"constant","vipValue":"FXS","vipVariableName":"analog_port_type_"},"secondary":{"dialtone":{"vipObjectType":"node-only","vipType":"ignore","vipValue":"false","vipVariableName":"analog_secondary_dialtone_"}},"shutdown":{"vipObjectType":"object","vipType":"constant","vipValue":"false","vipVariableName":"analog_shutdown_"},"connection":{"plar":{"plar-num":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_connection_plarnum_"},"opx-num-only":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}},"signal":{"did-type":{"vipType":"ignore","vipValue":"","vipObjectType":"object"},"signal-choice":{"vipObjectType":"object","vipType":"ignore","vipValue":"loopStart","vipVariableName":"analog_signal_choice_"}},"port-range":{"vipObjectType":"object","vipType":"constant","vipValue":"7","vipVariableName":"analog_port_range_"},"local-bypass":{"vipType":"constant","vipValue":"true","vipObjectType":"object"}}]},"voice-card-dig":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["dig-port-id"],"vipValue":[{"dig-port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1/0"},"id-dig":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1"},"framing":{"vipObjectType":"object","vipType":"notIgnore","vipValue":"esf","vipVariableName":"framing_0"},"interface":{"vipType":"constant","vipValue":[{"port-id":{"vipType":"constant","vipValue":"0/1/0","vipObjectType":"object"},"clock-priority":{"vipType":"constant","vipValue":0,"vipObjectType":"object"},"controller-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"serial-intf-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"voiceport-shutdown":{"vipType":"constant","vipValue":true,"vipObjectType":"object"},"clock-type":{"vipType":"constant","vipValue":"line","vipObjectType":"object"},"clock-position":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}],"vipObjectType":"tree","vipPrimaryKey":["port-id"]},"interface-type":{"vipObjectType":"object","vipType":"constant","vipValue":"T1 PRI"},"line-termination":{"vipObjectType":"object","vipType":"ignore","vipValue":"120-ohm","vipVariableName":"digital_line-termination"},"linecode":{"vipObjectType":"object","vipType":"constant","vipValue":"b8zs","vipVariableName":"linecode_0"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"NIM-1MFT-T1/E1"},"network-side":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"digital_network-side"},"switch-type":{"vipObjectType":"object","vipType":"constant","vipValue":"primary-4ess","vipVariableName":"digital_switch-type"},"timeslots":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"digital_timeslots"},"delay-connect-timer":{"vipObjectType":"object","vipType":"constant","vipValue":20,"vipVariableName":"digital_delay_connect_timer"},"dsp-hairpin":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"framing-australia":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"network-participation":{"vipType":"constant","vipValue":"true","vipObjectType":"object"},"isdn-timer":{"isdn-timer-T200":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"digital_isdn-timer-T200"},"isdn-timer-T203":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T203"},"isdn-timer-T301":{"vipObjectType":"object","vipType":"ignore","vipValue":300000,"vipVariableName":"digital_isdn-timer-T301"},"isdn-timer-T303":{"vipObjectType":"object","vipType":"ignore","vipValue":4000,"vipVariableName":"digital_isdn-timer-T303"},"isdn-timer-T306":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T306"},"isdn-timer-T309":{"vipObjectType":"object","vipType":"ignore","vipValue":90000,"vipVariableName":"digital_isdn-timer-T309"},"isdn-timer-T310":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T310"},"isdn-timer-T321":{"vipObjectType":"object","vipType":"ignore","vipValue":40000,"vipVariableName":"digital_isdn-timer-T321"}},"cablelength-long":{"vipObjectType":"object","vipType":"constant","vipValue":"-7.5","vipVariableName":"digital_cablelength-long"}}]},"clock-dig":{"sync":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"digital_sync"},"wait-to-restore":{"vipObjectType":"object","vipType":"ignore","vipValue":300,"vipVariableName":"digital_wait-to-restore"}}},"gTemplateClass":"cedge","templateDefinition":{"voice-card":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["port-id"],"vipValue":[{"port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0/7"},"id":{"vipObjectType":"object","vipType":"constant","vipValue":"1/0","vipVariableName":"analog_id"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"SM-X-8FXS/12FXO"},"description":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_description_"},"caller-id":{"enable":{"vipObjectType":"node-only","vipType":"constant","vipValue":"true","vipVariableName":"analog_caller_id_"}},"port-type":{"vipObjectType":"object","vipType":"constant","vipValue":"FXS","vipVariableName":"analog_port_type_"},"secondary":{"dialtone":{"vipObjectType":"node-only","vipType":"ignore","vipValue":"false","vipVariableName":"analog_secondary_dialtone_"}},"shutdown":{"vipObjectType":"object","vipType":"constant","vipValue":"false","vipVariableName":"analog_shutdown_"},"connection":{"plar":{"plar-num":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"analog_connection_plarnum_"},"opx-num-only":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}},"signal":{"did-type":{"vipType":"ignore","vipValue":"","vipObjectType":"object"},"signal-choice":{"vipObjectType":"object","vipType":"ignore","vipValue":"loopStart","vipVariableName":"analog_signal_choice_"}},"port-range":{"vipObjectType":"object","vipType":"constant","vipValue":"7","vipVariableName":"analog_port_range_"},"local-bypass":{"vipType":"constant","vipValue":"true","vipObjectType":"object"}}]},"voice-card-dig":{"vipType":"constant","vipObjectType":"tree","vipPrimaryKey":["dig-port-id"],"vipValue":[{"dig-port-id":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1/0"},"id-dig":{"vipObjectType":"object","vipType":"constant","vipValue":"0/1"},"framing":{"vipObjectType":"object","vipType":"notIgnore","vipValue":"esf","vipVariableName":"framing_0"},"interface":{"vipType":"constant","vipValue":[{"port-id":{"vipType":"constant","vipValue":"0/1/0","vipObjectType":"object"},"clock-priority":{"vipType":"constant","vipValue":0,"vipObjectType":"object"},"controller-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"serial-intf-shutdown":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"voiceport-shutdown":{"vipType":"constant","vipValue":true,"vipObjectType":"object"},"clock-type":{"vipType":"constant","vipValue":"line","vipObjectType":"object"},"clock-position":{"vipType":"ignore","vipValue":"","vipObjectType":"object"}}],"vipObjectType":"tree","vipPrimaryKey":["port-id"]},"interface-type":{"vipObjectType":"object","vipType":"constant","vipValue":"T1 PRI"},"line-termination":{"vipObjectType":"object","vipType":"ignore","vipValue":"120-ohm","vipVariableName":"digital_line-termination"},"linecode":{"vipObjectType":"object","vipType":"constant","vipValue":"b8zs","vipVariableName":"linecode_0"},"module-type":{"vipObjectType":"object","vipType":"constant","vipValue":"NIM-1MFT-T1/E1"},"network-side":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"digital_network-side"},"switch-type":{"vipObjectType":"object","vipType":"constant","vipValue":"primary-4ess","vipVariableName":"digital_switch-type"},"timeslots":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"digital_timeslots"},"delay-connect-timer":{"vipObjectType":"object","vipType":"constant","vipValue":20,"vipVariableName":"digital_delay_connect_timer"},"dsp-hairpin":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"framing-australia":{"vipType":"constant","vipValue":"false","vipObjectType":"object"},"network-participation":{"vipType":"constant","vipValue":"true","vipObjectType":"object"},"isdn-timer":{"isdn-timer-T200":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"digital_isdn-timer-T200"},"isdn-timer-T203":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T203"},"isdn-timer-T301":{"vipObjectType":"object","vipType":"ignore","vipValue":300000,"vipVariableName":"digital_isdn-timer-T301"},"isdn-timer-T303":{"vipObjectType":"object","vipType":"ignore","vipValue":4000,"vipVariableName":"digital_isdn-timer-T303"},"isdn-timer-T306":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T306"},"isdn-timer-T309":{"vipObjectType":"object","vipType":"ignore","vipValue":90000,"vipVariableName":"digital_isdn-timer-T309"},"isdn-timer-T310":{"vipObjectType":"object","vipType":"ignore","vipValue":30000,"vipVariableName":"digital_isdn-timer-T310"},"isdn-timer-T321":{"vipObjectType":"object","vipType":"ignore","vipValue":40000,"vipVariableName":"digital_isdn-timer-T321"}},"cablelength-long":{"vipObjectType":"object","vipType":"constant","vipValue":"-7.5","vipVariableName":"digital_cablelength-long"}}]},"clock-dig":{"sync":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"digital_sync"},"wait-to-restore":{"vipObjectType":"object","vipType":"ignore","vipValue":300,"vipVariableName":"digital_wait-to-restore"}}},"configType":"xml","attachedMastersCount":0,"templateId":"30ebbc4a-6596-45b8-acfb-c62fe2add788","createdOn":1652776377626,"@rid":918,"factoryDefault":false,"feature":"vmanage-default","templateName":"template_voice_card","createdBy":"admin","devicesAttached":0,"templateDescription":"template_voice_card","lastUpdatedOn":1652776377626}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Policy Configuration-read"}},"/template/feature/resource-group/{resourceGroupName}/{templateId}":{"post":{"tags":["Configuration - General Template"],"description":"Change template resource group","operationId":"changeTemplateResourceGroup","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"path","description":"Resrouce group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write"}},"/template/feature/types":{"get":{"tags":["Configuration - General Template"],"description":"Generate template types
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateTypes","parameters":[{"name":"type","in":"query","description":"Device type","required":true,"schema":{"type":"string","enum":["vedge","cedge","all","default"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template type":{"description":"Template type","value":{"data":[{"parent":"basic_info","default":"aaa/aaa.json","deviceModels":[{"name":"vedge-1000"},{"name":"vedge-2000"},{"name":"vedge-cloud"},{"name":"vedge-5000"},{"name":"vedge-ISR1100-6G"},{"name":"vedge-100-B"},{"name":"vedge-ISR1100-4G"},{"name":"vedge-100"},{"name":"vsmart"},{"name":"vedge-ISR1100-4GLTE"},{"name":"vedge-100-WM"},{"name":"vmanage"},{"name":"vbond"},{"name":"vedge-100-M"},{"name":"vedge-ISR1100X-6G"},{"name":"vedge-ISR1100X-4G"}],"displayName":"AAA","name":"aaa","typeClass":"DefaultGeneralTemplate","description":"AAA","write_permission":true,"read_permission":true,"helperType":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/types/definition/{type_name}/{version}":{"get":{"tags":["Configuration - General Template"],"description":"Generate template type definition
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateTypeDefinition","parameters":[{"name":"type_name","in":"path","description":"Feature template type","required":true,"schema":{"type":"string","example":"cisco_system"}},{"name":"version","in":"path","description":"Version","required":true,"schema":{"type":"string","example":"2"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template type":{"description":"Template type","value":{"xmlPath":[],"xmlRootTag":"system","nameSpace":"http://viptela.com/system","name":"cisco_system","fields":[{"optionType":["constant","ignore"],"description":"Enable Migration Mode to Hierarchical SDWAN","dataType":{"type":"enum","values":[{"key":"enabled","value":"Enable"},{"key":"enabled-from-bgp-core","value":"Enable from BGP Core"}]},"defaultOption":"ignore","dataPath":[],"details":"Enable migration mode to Hierarchical SDWAN","key":"enable-hsdwan-migration","objectType":"object"},{"optionType":["constant","ignore"],"description":"Migration BGP Community","dataType":{"max":4294967295,"type":"number","min":1},"defaultOption":"ignore","dataPath":[],"details":"Set BGP community during migration from BGP-core based network","key":"migration-bgp-community","objectType":"object"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Configuration-write,Template Deploy-read,Template Deploy-write"}},"/template/feature/{deviceType}":{"get":{"tags":["Configuration - General Template"],"description":"Generate template based on device
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"generateTemplateByDeviceType","parameters":[{"name":"deviceType","in":"path","description":"Device type","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Feature template":{"description":"Feature template","value":{"data":[{"templateMinVersion":"20.1.0","templateType":"logging","deviceType":["vedge-1000","vedge-2000","vedge-cloud","vedge-5000","vedge-ISR1100-6G","vedge-100-B","vedge-ISR1100-4G","vedge-100","vsmart","vedge-ISR1100-4GLTE","vedge-100-WM","vmanage","vedge-100-M","vedge-ISR1100X-6G","vedge-ISR1100X-4G"],"lastUpdatedBy":"system","editedTemplateDefinition":"{\"disk\":{\"enable\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"file\":{\"size\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"},\"rotate\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"}},\"priority\":{\"vipObjectType\":\"object\",\"vipValue\":\"information\",\"vipType\":\"ignore\"}}}","gTemplateClass":"vedge","templateDefinition":"{\"disk\":{\"enable\":{\"vipObjectType\":\"object\",\"vipValue\":\"true\",\"vipType\":\"ignore\"},\"file\":{\"size\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"},\"rotate\":{\"vipObjectType\":\"object\",\"vipValue\":10,\"vipType\":\"ignore\"}},\"priority\":{\"vipObjectType\":\"object\",\"vipValue\":\"information\",\"vipType\":\"ignore\"}}}","configType":"xml","attachedMastersCount":1,"templateId":"5f459c3b-2e77-4399-8b0d-f1d5cf048035","createdOn":1652417246799,"@rid":108,"factoryDefault":true,"feature":"vmanage-default","templateName":"Factory_Default_Logging_Template_V01","createdBy":"system","devicesAttached":0,"templateDescription":"DefaultLoggingtemplatesettingsVersion01","lastUpdatedOn":1652417246799}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/template/feature/{templateId}":{"put":{"tags":["Configuration - General Template"],"description":"Update feature template
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"editFeatureTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template","content":{"application/json":{"schema":{"type":"object"},"examples":{"CedgeVoiceCard-example":{"description":"CedgeVoiceCard-example","$ref":"#/components/examples/CedgeVoiceCard"},"CedgeVoiceSrst-example":{"description":"CedgeVoiceSrst-example","$ref":"#/components/examples/CedgeVoiceSrst"},"aaa-example":{"description":"aaa-example","$ref":"#/components/examples/aaa"},"appqoe-example":{"description":"appqoe-example","$ref":"#/components/examples/appqoe"},"archive-example":{"description":"archive-example","$ref":"#/components/examples/archive"},"banner-example":{"description":"banner-example","$ref":"#/components/examples/banner"},"bfd-vedge-example":{"description":"bfd-vedge-example","$ref":"#/components/examples/bfd-vedge"},"bgp-example":{"description":"bgp-example","$ref":"#/components/examples/bgp"},"bridge-example":{"description":"bridge-example","$ref":"#/components/examples/bridge"},"cedge_aaa-example":{"description":"cedge_aaa-example","$ref":"#/components/examples/cedge_aaa"},"cedge_global-example":{"description":"cedge_global-example","$ref":"#/components/examples/cedge_global"},"cedge_igmp-example":{"description":"cedge_igmp-example","$ref":"#/components/examples/cedge_igmp"},"cedge_multicast-example":{"description":"cedge_multicast-example","$ref":"#/components/examples/cedge_multicast"},"cedge_pim-example":{"description":"cedge_pim-example","$ref":"#/components/examples/cedge_pim"},"cellular-cedge-controller-example":{"description":"cellular-cedge-controller-example","$ref":"#/components/examples/cellular-cedge-controller"},"cellular-cedge-gps-controller-example":{"description":"cellular-cedge-gps-controller-example","$ref":"#/components/examples/cellular-cedge-gps-controller"},"cellular-cedge-profile-example":{"description":"cellular-cedge-profile-example","$ref":"#/components/examples/cellular-cedge-profile"},"cellular-gateway-platform-example":{"description":"cellular-gateway-platform-example","$ref":"#/components/examples/cellular-gateway-platform"},"cellular-gateway-profile-example":{"description":"cellular-gateway-profile-example","$ref":"#/components/examples/cellular-gateway-profile"},"cellular-profile-example":{"description":"cellular-profile-example","$ref":"#/components/examples/cellular-profile"},"cisco_banner-example":{"description":"cisco_banner-example","$ref":"#/components/examples/cisco_banner"},"cisco_bfd-example":{"description":"cisco_bfd-example","$ref":"#/components/examples/cisco_bfd"},"cisco_bgp-example":{"description":"cisco_bgp-example","$ref":"#/components/examples/cisco_bgp"},"cisco_dhcp_server-example":{"description":"cisco_dhcp_server-example","$ref":"#/components/examples/cisco_dhcp_server"},"cisco_dsp_farm-example":{"description":"cisco_dsp_farm-example","$ref":"#/components/examples/cisco_dsp_farm"},"cisco_logging-example":{"description":"cisco_logging-example","$ref":"#/components/examples/cisco_logging"},"cisco_ntp-example":{"description":"cisco_ntp-example","$ref":"#/components/examples/cisco_ntp"},"cisco_omp-example":{"description":"cisco_omp-example","$ref":"#/components/examples/cisco_omp"},"cisco_ospf-example":{"description":"cisco_ospf-example","$ref":"#/components/examples/cisco_ospf"},"cisco_ospfv3-example":{"description":"cisco_ospfv3-example","$ref":"#/components/examples/cisco_ospfv3"},"cisco_secure_internet_gateway-example":{"description":"cisco_secure_internet_gateway-example","$ref":"#/components/examples/cisco_secure_internet_gateway"},"cisco_security-example":{"description":"cisco_security-example","$ref":"#/components/examples/cisco_security"},"cisco_sig_credential-example":{"description":"cisco_sig_credential-example","$ref":"#/components/examples/cisco_sig_credentials"},"cisco_snmp-example":{"description":"cisco_snmp-example","$ref":"#/components/examples/cisco_snmp"},"cisco_system-example":{"description":"cisco_system-example","$ref":"#/components/examples/cisco_system"},"cisco_thousandeye-example":{"description":"cisco_thousandeye-example","$ref":"#/components/examples/cisco_thousandeyes"},"cisco_trustsec-example":{"description":"cisco_trustsec-example","$ref":"#/components/examples/cisco_trustsec"},"cisco_vp-example":{"description":"cisco_vp-example","$ref":"#/components/examples/cisco_vpn"},"cisco_vpn_interface-example":{"description":"cisco_vpn_interface-example","$ref":"#/components/examples/cisco_vpn_interface"},"cisco_vpn_interface_gre-example":{"description":"cisco_vpn_interface_gre-example","$ref":"#/components/examples/cisco_vpn_interface_gre"},"cisco_vpn_interface_ipsec-example":{"description":"cisco_vpn_interface_ipsec-example","$ref":"#/components/examples/cisco_vpn_interface_ipsec"},"cisco_wireless_la-example":{"description":"cisco_wireless_la-example","$ref":"#/components/examples/cisco_wireless_lan"},"cli-template-example":{"description":"cli-template-example","$ref":"#/components/examples/cli-template"},"dhcp-server-example":{"description":"dhcp-server-example","$ref":"#/components/examples/dhcp-server"},"eigrp-example":{"description":"eigrp-example","$ref":"#/components/examples/eigrp"},"igmp-example":{"description":"igmp-example","$ref":"#/components/examples/igmp"},"logging-example":{"description":"logging-example","$ref":"#/components/examples/logging"},"multicast-example":{"description":"multicast-example","$ref":"#/components/examples/multicast"},"ntp-example":{"description":"ntp-example","$ref":"#/components/examples/ntp"},"omp-vedge-example":{"description":"omp-vedge-example","$ref":"#/components/examples/omp-vedge"},"omp-vsmart-example":{"description":"omp-vsmart-example","$ref":"#/components/examples/omp-vsmart"},"ospf-example":{"description":"ospf-example","$ref":"#/components/examples/ospf"},"pim-example":{"description":"pim-example","$ref":"#/components/examples/pim"},"probe-example":{"description":"probe-example","$ref":"#/components/examples/probes"},"secure-internet-gateway-example":{"description":"secure-internet-gateway-example","$ref":"#/components/examples/secure-internet-gateway"},"security-vedge-example":{"description":"security-vedge-example","$ref":"#/components/examples/security-vedge"},"security-vsmart-example":{"description":"security-vsmart-example","$ref":"#/components/examples/security-vsmart"},"sig-credential-example":{"description":"sig-credential-example","$ref":"#/components/examples/sig-credentials"},"snmp-example":{"description":"snmp-example","$ref":"#/components/examples/snmp"},"switchport-example":{"description":"switchport-example","$ref":"#/components/examples/switchport"},"system-vedge-example":{"description":"system-vedge-example","$ref":"#/components/examples/system-vedge"},"system-vsmart-example":{"description":"system-vsmart-example","$ref":"#/components/examples/system-vsmart"},"t1-e1-controller-example":{"description":"t1-e1-controller-example","$ref":"#/components/examples/t1-e1-controller"},"tenant-example":{"description":"tenant-example","$ref":"#/components/examples/tenant"},"ucse-example":{"description":"ucse-example","$ref":"#/components/examples/ucse"},"virtual-application-utd-example":{"description":"virtual-application-utd-example","$ref":"#/components/examples/virtual-application-utd"},"vpn-cedge-interface-cellular-example":{"description":"vpn-cedge-interface-cellular-example","$ref":"#/components/examples/vpn-cedge-interface-cellular"},"vpn-cedge-interface-multilink-controller-example":{"description":"vpn-cedge-interface-multilink-controller-example","$ref":"#/components/examples/vpn-cedge-interface-multilink-controller"},"vpn-interface-ethpppoe-example":{"description":"vpn-interface-ethpppoe-example","$ref":"#/components/examples/vpn-interface-ethpppoe"},"vpn-interface-ipoe-example":{"description":"vpn-interface-ipoe-example","$ref":"#/components/examples/vpn-interface-ipoe"},"vpn-interface-pppoa-example":{"description":"vpn-interface-pppoa-example","$ref":"#/components/examples/vpn-interface-pppoa"},"vpn-interface-pppoe-example":{"description":"vpn-interface-pppoe-example","$ref":"#/components/examples/vpn-interface-pppoe"},"vpn-interface-svi-example":{"description":"vpn-interface-svi-example","$ref":"#/components/examples/vpn-interface-svi"},"vpn-interface-t1-e1-example":{"description":"vpn-interface-t1-e1-example","$ref":"#/components/examples/vpn-interface-t1-e1"},"vpn-vedge-interface-bridge-example":{"description":"vpn-vedge-interface-bridge-example","$ref":"#/components/examples/vpn-vedge-interface-bridge"},"vpn-vedge-interface-cellular-example":{"description":"vpn-vedge-interface-cellular-example","$ref":"#/components/examples/vpn-vedge-interface-cellular"},"vpn-vedge-interface-gre-example":{"description":"vpn-vedge-interface-gre-example","$ref":"#/components/examples/vpn-vedge-interface-gre"},"vpn-vedge-interface-ipsec-example":{"description":"vpn-vedge-interface-ipsec-example","$ref":"#/components/examples/vpn-vedge-interface-ipsec"},"vpn-vedge-interface-natpool-example":{"description":"vpn-vedge-interface-natpool-example","$ref":"#/components/examples/vpn-vedge-interface-natpool"},"vpn-vedge-interface-ppp-example":{"description":"vpn-vedge-interface-ppp-example","$ref":"#/components/examples/vpn-vedge-interface-ppp"},"vpn-vedge-interface-vap-example":{"description":"vpn-vedge-interface-vap-example","$ref":"#/components/examples/vpn-vedge-interface-vap"},"vpn-vedge-interface-example":{"description":"vpn-vedge-interface-example","$ref":"#/components/examples/vpn-vedge-interface"},"vpn-vedge-pppoe-enabled-interface-example":{"description":"vpn-vedge-pppoe-enabled-interface-example","$ref":"#/components/examples/vpn-vedge-pppoe-enabled-interface"},"vpn-vedge-example":{"description":"vpn-vedge-example","$ref":"#/components/examples/vpn-vedge"},"vpn-vmanage-interface-example":{"description":"vpn-vmanage-interface-example","$ref":"#/components/examples/vpn-vmanage-interface"},"vpn-vsmart-interface-example":{"description":"vpn-vsmart-interface-example","$ref":"#/components/examples/vpn-vsmart-interface"},"vpn-vsmart-example":{"description":"vpn-vsmart-example","$ref":"#/components/examples/vpn-vsmart"},"wla-example":{"description":"wla-example","$ref":"#/components/examples/wlan"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - General Template"],"description":"Delete feature template","operationId":"deleteGeneralTemplate","parameters":[{"name":"templateId","in":"path","description":"Template Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write"}},"/template/lock/{processId}":{"put":{"tags":["Configuration - Template Lock"],"description":"Update lease","operationId":"updateLeaseTime","parameters":[{"name":"processId","in":"path","description":"Process Id","required":true,"schema":{"type":"string","example":"push_feature_template_configuration-ea4fe240-520c-4aaf-b674-7dfb46b0105e"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Template Lock"],"description":"Remove lock","operationId":"removeLock","parameters":[{"name":"processId","in":"path","description":"Process Id","required":true,"schema":{"type":"string","example":"push_feature_template_configuration-ea4fe240-520c-4aaf-b674-7dfb46b0105e"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-write,Template Deploy-write,Policy Configuration-write"}},"/template/policy/assembly/security":{"post":{"tags":["Configuration - Policy Security Assembler"],"description":"Get policy assembly preview","operationId":"preview","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/security/{id}":{"get":{"tags":["Configuration - Policy Security Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vedge":{"post":{"tags":["Configuration - Policy vEdge Assembler"],"description":"Get policy assembly preview","operationId":"preview_1","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vedge/{id}":{"get":{"tags":["Configuration - Policy vEdge Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/voice":{"post":{"tags":["Configuration - Policy Voice Assembler"],"description":"Get policy assembly preview","operationId":"preview_2","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/voice/{id}":{"get":{"tags":["Configuration - Policy Voice Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vsmart":{"post":{"tags":["Configuration - Policy vSmart Assembler"],"description":"Get policy assembly preview","operationId":"preview_3","requestBody":{"description":"Policy assembly","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly":{"description":"Policy assembly","value":{"assembly":[{"definitionId":"aee2adc2-7b10-437e-8d74-fc52557f7cb7","type":"appRoute","entries":[{"siteLists":["cf4bbb13-0a3f-4302-adfa-6cfce6b3950c"],"vpnLists":["ab2b3ffa-b390-4143-95f3-14d084efc85f"]}]},{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":"{\n \"preview\":\"viptela-policy:policy\n sla-class VoiceVideoSLA\n latency 100\n !\n sla-class WebSLA\n latency 150\n !\n control-policy control_-1240443936\n \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/assembly/vsmart/{id}":{"get":{"tags":["Configuration - Policy vSmart Assembler"],"description":"Get policy assembly preview for feature policy","operationId":"previewById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy assembly preview":{"description":"Policy assembly preview","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Security Policy Configuration-read,Security Policy Configuration-write"}},"/template/policy/clouddiscoveredapp":{"get":{"tags":["Configuration - Policy Cloud Application Builder"],"description":"Get all cloud discovered applications","operationId":"getCloudDiscoveredApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Cloud Discovered App":{"description":"Cloud Discovered App","value":{"data":[{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05","appName":"DemoApp","lastUpdated":"1590201349732","owner":"admin"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Set SLA class for policy cloud discovered applications","operationId":"MapTrafficProfiles","requestBody":{"description":"App payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"App payload":{"description":"App payload","value":"[\n {\n \"appId\":\"71001c48-fdcf-4ac0-aaf3-ca4a20386a18\",\n \"slaClass\":\"video\",\n }\n]"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App":{"description":"App","value":{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/customapp":{"get":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Get all policy custom applications","operationId":"getCustomApps","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Custom App":{"description":"Custom App","value":{"data":[{"appId":"679cdb6f-67d8-45bd-9de0-a73138a9ca05","appName":"DemoApp","lastUpdated":"1590201349732","owner":"admin"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Create a policy custom applications","operationId":"createCustomApp","requestBody":{"description":"App payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"App payload":{"description":"App payload","value":{"appName":"DemoApp"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"App Id":{"description":"App Id","value":{"appId":"4645f376-a16b-474e-8107-9e864d7c7e98","taskId":"sdavc_rest_api_call-27166314-0a04-4bc3-8af5-27b78684c902","log":"Successfully created custom app aasar in SD-AVC. Successfully created custom app aasar in vManage."}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/customapp/{id}":{"get":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Get a policy custom applications","operationId":"getCustomAppById","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Custom App":{"description":"Custom App","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Edit a policy custom applications","operationId":"editCustomApp","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"App payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"App Id":{"description":"App Id","value":"{\n \"taskId\":\"sdavc_rest_api_call-27166314-0a04-4bc3-8af5-27b78684c902\",\n}"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Policy Custom Application Builder"],"description":"Delete a policy custom applications","operationId":"deleteCustomApp","parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/definition/acl":{"get":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"post":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_8","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/acl/bulk":{"put":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_8","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/acl/multiple/{id}":{"put":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/acl/preview":{"post":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_8","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/acl/preview/{id}":{"get":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/acl/{id}":{"get":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"put":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"},"delete":{"tags":["Configuration - Policy Access List Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/aclv6":{"get":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"post":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_9","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/aclv6/bulk":{"put":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_9","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/aclv6/multiple/{id}":{"put":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/aclv6/preview":{"post":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_9","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/aclv6/preview/{id}":{"get":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/aclv6/{id}":{"get":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,ACL Policy-read,ACL Policy-write"},"put":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"},"delete":{"tags":["Configuration - Policy IPv6 Access Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,ACL Policy-write"}},"/template/policy/definition/advancedMalwareProtection":{"get":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_11","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedMalwareProtection/bulk":{"put":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_11","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedMalwareProtection/multiple/{id}":{"put":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedMalwareProtection/preview":{"post":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_11","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedMalwareProtection/preview/{id}":{"get":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedMalwareProtection/{id}":{"get":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy AMP Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile":{"get":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Get policy definitions","operationId":"getDefinitions_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_10","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile/bulk":{"put":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_10","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile/multiple/{id}":{"put":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/advancedinspectionprofile/preview":{"post":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_10","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedinspectionprofile/preview/{id}":{"get":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/advancedinspectionprofile/{id}":{"get":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Advanced Inspection Profile Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/approute":{"get":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write"},"post":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_12","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-writeAppRoute Policy-write"}},"/template/policy/definition/approute/bulk":{"put":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_12","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/approute/multiple/{id}":{"put":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/approute/preview":{"post":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_12","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/approute/preview/{id}":{"get":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/approute/{id}":{"get":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,AppRoute Policy-read,AppRoute Policy-write"},"put":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-writeAppRoute Policy-write"},"delete":{"tags":["Configuration - Policy AppRoute Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-writeAppRoute Policy-write"}},"/template/policy/definition/cflowd":{"get":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write"},"post":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_13","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,CFlowD Policy-write"}},"/template/policy/definition/cflowd/bulk":{"put":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_13","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/cflowd/multiple/{id}":{"put":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/cflowd/preview":{"post":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_13","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/cflowd/preview/{id}":{"get":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/cflowd/{id}":{"get":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,CFlowD Policy-read,CFlowD Policy-write"},"put":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,CFlowD Policy-write"},"delete":{"tags":["Configuration - Policy Cflowd Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,CFlowD Policy-write"}},"/template/policy/definition/control":{"get":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"post":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_14","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/control/bulk":{"put":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_14","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/control/multiple/{id}":{"put":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/control/preview":{"post":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_14","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/control/preview/{id}":{"get":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/control/{id}":{"get":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"put":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Control Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/data":{"get":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_15","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/data/bulk":{"put":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_15","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/data/multiple/{id}":{"put":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/data/preview":{"post":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_15","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/data/preview/{id}":{"get":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/data/{id}":{"get":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicy":{"get":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"post":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_16","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/deviceaccesspolicy/bulk":{"put":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_16","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicy/multiple/{id}":{"put":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicy/preview":{"post":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_16","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicy/preview/{id}":{"get":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicy/{id}":{"get":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"put":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"},"delete":{"tags":["Configuration - Policy Device Access Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/deviceaccesspolicyv6":{"get":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"post":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_17","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/deviceaccesspolicyv6/bulk":{"put":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_17","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicyv6/multiple/{id}":{"put":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/deviceaccesspolicyv6/preview":{"post":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_17","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicyv6/preview/{id}":{"get":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/deviceaccesspolicyv6/{id}":{"get":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Device Access Policy-readDevice Access Policy-write"},"put":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"},"delete":{"tags":["Configuration - Policy IPv6 Device Access Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Device Access Policy-write"}},"/template/policy/definition/dialpeer":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_25","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dialpeer/bulk":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_25","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dialpeer/multiple/{id}":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dialpeer/preview":{"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_25","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dialpeer/preview/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dialpeer/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity":{"get":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity/bulk":{"put":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity/multiple/{id}":{"put":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/dnssecurity/preview":{"post":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dnssecurity/preview/{id}":{"get":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/dnssecurity/{id}":{"get":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Local Domain Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport":{"get":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_26","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport/bulk":{"put":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_26","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport/multiple/{id}":{"put":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxoport/preview":{"post":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_26","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxoport/preview/{id}":{"get":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxoport/{id}":{"get":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy FXO Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport":{"get":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_28","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport/bulk":{"put":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_28","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport/multiple/{id}":{"put":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsdidport/preview":{"post":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_28","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsdidport/preview/{id}":{"get":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsdidport/{id}":{"get":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy FXSDID Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport":{"get":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_27","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport/bulk":{"put":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_27","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport/multiple/{id}":{"put":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/fxsport/preview":{"post":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_27","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsport/preview/{id}":{"get":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/fxsport/{id}":{"get":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy FXS Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/hubandspoke":{"get":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"post":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_4","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/hubandspoke/bulk":{"put":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_4","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/hubandspoke/multiple/{id}":{"put":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/hubandspoke/preview":{"post":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_4","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/hubandspoke/preview/{id}":{"get":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/hubandspoke/{id}":{"get":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"put":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Hub and Spoke Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/intrusionprevention":{"get":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_18","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/intrusionprevention/bulk":{"put":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_18","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/intrusionprevention/multiple/{id}":{"put":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/intrusionprevention/preview":{"post":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_18","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/intrusionprevention/preview/{id}":{"get":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/intrusionprevention/{id}":{"get":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Intrusion Prevention Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/mesh":{"get":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"post":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_5","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/mesh/bulk":{"put":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_5","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/mesh/multiple/{id}":{"put":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/mesh/preview":{"post":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_5","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/mesh/preview/{id}":{"get":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/mesh/{id}":{"get":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Topology Policy-read,Topology Policy-write"},"put":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Mesh Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,Policy Configuration-write"}},"/template/policy/definition/priisdnport":{"get":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_29","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_29","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/priisdnport/bulk":{"put":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_29","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/priisdnport/multiple/{id}":{"put":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/priisdnport/preview":{"post":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_29","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/priisdnport/preview/{id}":{"get":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/priisdnport/{id}":{"get":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy PRI ISDN Port Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/qosmap":{"get":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write"},"post":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_1","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/qosmap/bulk":{"put":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_1","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/qosmap/multiple/{id}":{"put":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/qosmap/preview":{"post":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_1","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/qosmap/preview/{id}":{"get":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/qosmap/{id}":{"get":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write"},"put":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Qos Map Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/rewriterule":{"get":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write"},"post":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_19","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Rewrite Policy-write"}},"/template/policy/definition/rewriterule/bulk":{"put":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_19","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/rewriterule/multiple/{id}":{"put":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/rewriterule/preview":{"post":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_19","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/rewriterule/preview/{id}":{"get":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/rewriterule/{id}":{"get":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Rewrite Policy-read,Rewrite Policy-write"},"put":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Rewrite Policy-write"},"delete":{"tags":["Configuration - Policy Rewrite Rule Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Rewrite Policy-write"}},"/template/policy/definition/ruleset":{"get":{"tags":["Configuration - Rule Set Definition"],"description":"Get policy definitions","operationId":"getDefinitions_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Rule Set Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_20","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ruleset/bulk":{"put":{"tags":["Configuration - Rule Set Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_20","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ruleset/multiple/{id}":{"put":{"tags":["Configuration - Rule Set Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ruleset/preview":{"post":{"tags":["Configuration - Rule Set Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_20","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ruleset/preview/{id}":{"get":{"tags":["Configuration - Rule Set Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ruleset/{id}":{"get":{"tags":["Configuration - Rule Set Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Rule Set Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Rule Set Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup":{"get":{"tags":["Configuration - Security Group Definition"],"description":"Get policy definitions","operationId":"getDefinitions_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Security Group Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_21","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup/bulk":{"put":{"tags":["Configuration - Security Group Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_21","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup/multiple/{id}":{"put":{"tags":["Configuration - Security Group Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/securitygroup/preview":{"post":{"tags":["Configuration - Security Group Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_21","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/securitygroup/preview/{id}":{"get":{"tags":["Configuration - Security Group Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/securitygroup/{id}":{"get":{"tags":["Configuration - Security Group Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Security Group Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Security Group Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_30","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_30","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile/bulk":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_30","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile/multiple/{id}":{"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/srstphoneprofile/preview":{"post":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_30","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/srstphoneprofile/preview/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/srstphoneprofile/{id}":{"get":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy DialPeer Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption":{"get":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_3","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption/bulk":{"put":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_3","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption/multiple/{id}":{"put":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/ssldecryption/preview":{"post":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_3","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ssldecryption/preview/{id}":{"get":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/ssldecryption/{id}":{"get":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - SSL Decryption Policy Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile":{"get":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Get policy definitions","operationId":"getDefinitions_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Create policy definition","operationId":"createPolicyDefinition_22","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile/bulk":{"put":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_22","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile/multiple/{id}":{"put":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/sslutdprofile/preview":{"post":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_22","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/sslutdprofile/preview/{id}":{"get":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/sslutdprofile/{id}":{"get":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - SSL Decryption UTD Profile Definition"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering":{"get":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_23","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering/bulk":{"put":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_23","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering/multiple/{id}":{"put":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/urlfiltering/preview":{"post":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_23","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/urlfiltering/preview/{id}":{"get":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/urlfiltering/{id}":{"get":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL Filtering Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vedgeroute":{"get":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write"},"post":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_24","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Route Policy-write"}},"/template/policy/definition/vedgeroute/bulk":{"put":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_24","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vedgeroute/multiple/{id}":{"put":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vedgeroute/preview":{"post":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_24","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vedgeroute/preview/{id}":{"get":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vedgeroute/{id}":{"get":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,Route Policy-read,Route Policy-write"},"put":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Route Policy-write"},"delete":{"tags":["Configuration - Policy vEdge Route Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write,Route Policy-write"}},"/template/policy/definition/vpnmembershipgroup":{"get":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write"},"post":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_6","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,VPN Membership Policy-write"}},"/template/policy/definition/vpnmembershipgroup/bulk":{"put":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_6","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnmembershipgroup/multiple/{id}":{"put":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnmembershipgroup/preview":{"post":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_6","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnmembershipgroup/preview/{id}":{"get":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnmembershipgroup/{id}":{"get":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write,VPN Membership Policy-read,VPN Membership Policy-write"},"put":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,VPN Membership Policy-write"},"delete":{"tags":["Configuration - Policy VPN Membership Group Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Policy-write,VPN Membership Policy-write"}},"/template/policy/definition/vpnqosmap":{"get":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,QoSMap Policy-write,Policy Configuration-write"},"post":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_2","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/vpnqosmap/bulk":{"put":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_2","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnqosmap/multiple/{id}":{"put":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/vpnqosmap/preview":{"post":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_2","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnqosmap/preview/{id}":{"get":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/vpnqosmap/{id}":{"get":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,QoSMap Policy-read,Policy Configuration-write,QoSMap Policy-write"},"put":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"},"delete":{"tags":["Configuration - Policy VPN-Qos Map Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"QoSMap Policy-write,Policy Configuration-write"}},"/template/policy/definition/zonebasedfw":{"get":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Get policy definitions","operationId":"getDefinitions_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Create policy definition","operationId":"createPolicyDefinition_7","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["10","20"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":false,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"","fileAnalysisFileTypes":[],"fileAnalysisAlert":"","targetVpns":["10","20"]}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":true,"umbrellaDefault":true,"childOrgId":"7999118","localDomainBypassEnabled":true,"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}},"HubandSpoke definition":{"description":"HubandSpoke definition","value":{"name":"Demo-Hub-n-Spoke-Policy","type":"hubAndSpoke","description":"Demo-Hub-n-Spoke-Policy","definition":{"vpnList":"cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf","subDefinitions":[{"name":"My Hub-and-Spoke","equalPreference":false,"advertiseTloc":true,"spokes":[{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","hubs":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","preference":"20","prefixLists":["b5c4d764-20bc-4de3-9bac-52ef70f1186c"],"ipv6PrefixLists":[]}]}],"tlocList":"1e97c258-4323-4754-9dc0-44e9656d43bf"}]}}},"VPN membership group definition":{"description":"VPN membership group definition","value":{"name":"Demo-VPN-Membership-Policy","type":"vpnMembershipGroup","description":"Demo-VPN-Membership-Policy","definition":{"sites":[{"siteList":"24747ccd-4f7f-4dfa-8800-34f565fb65b4","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]},{"siteList":"5c58c36c-9cd6-468f-8434-ee6d5801c6ba","vpnList":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]}}},"AppRoute definition":{"description":"AppRoute definition","value":{"name":"Demo-AAR-Policy","type":"appRoute","description":"Demo-AAR-Policy","sequences":[{"sequenceId":1,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"request"},{"field":"dscp","value":"46"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"1025"},{"field":"destinationDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]},{"sequenceId":11,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"saasAppList","ref":"1e6688ce-2d21-4d7a-9a93-ae6a8ebd4a06"}]},"actions":[{"type":"cloudSaas","parameter":""}]},{"sequenceId":21,"sequenceName":"App Route","sequenceType":"appRoute","sequenceIpType":"ipv6","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"},{"field":"sourceIpv6","value":"2001::/8"},{"field":"sourcePort","value":"65000"},{"field":"destinationIpv6","value":"2001::/8"},{"field":"destinationPort","value":"65000"}]},"actions":[{"type":"backupSlaPreferredColor","parameter":"biz-internet"},{"type":"count","parameter":"Demo-Counter"},{"type":"log","parameter":""},{"type":"slaClass","parameter":[{"field":"name","ref":"46cea5a1-1570-4921-b87a-837d590eb37e"},{"field":"preferredColor","value":"public-internet"},{"field":"strict"}]}]}]}},"Data policy definition":{"description":"Data policy definition","value":{"name":"Demo-Data-Policy","type":"data","description":"Demo-Data-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dnsAppList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"},{"field":"dns","value":"response"},{"field":"dscp","value":"46"},{"field":"packetLength","value":"1504"},{"field":"plp","value":"high"},{"field":"protocol","value":"6"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.0.0.0/12"},{"field":"destinationPort","value":"65000"},{"field":"tcp","value":"syn"}]},"actions":[{"type":"count","parameter":"Demo-Counter"},{"type":"set","parameter":[{"field":"dscp","value":"34"},{"field":"forwardingClass","value":"ef-class"},{"field":"localTlocList","value":{"color":"public-internet","restrict":"","encap":"ipsec"}},{"field":"nextHop","value":"10.0.0.1"},{"field":"policer","ref":"ecf250c7-bef0-405b-8e74-4d67440cac90"}]},{"type":"cflowd"},{"type":"log","parameter":""},{"type":"nat","parameter":{"field":"pool","value":"1"}},{"type":"redirectDns","parameter":{"field":"dnsType","value":"umbrella"}}]},{"sequenceId":11,"sequenceName":"Custom","baseAction":"accept","sequenceType":"data","sequenceIpType":"ipv4","match":{"entries":[{"field":"appList","ref":"b6752dba-969b-46de-a7e7-da11910fb1bf"}]},"actions":[{"type":"set","parameter":[{"field":"service","value":{"type":"FW","vpn":"10","tloc":{"ip":"10.0.0.1","color":"biz-internet","encap":"ipsec"}}}]},{"type":"tcpOptimization","parameter":""},{"type":"lossProtect","parameter":"fecAdaptive"},{"type":"lossProtectFec","parameter":"fecAdaptive"},{"type":"sig","parameter":""}]}]}},"CFlowd definition":{"description":"CFlowd definition","value":{"name":"Demo-cflowd-Policy","type":"cflowd","description":"Demo-cflowd-Policy","definition":{"flowActiveTimeout":3600,"flowInactiveTimeout":3600,"flowSamplingInterval":65513,"templateRefresh":86400,"collectors":[{"vpn":"10","address":"10.0.0.1","port":9912,"transport":"transport_tcp","sourceInterface":"ge0/1"},{"vpn":"20","address":"10.0.0.1","port":1025,"transport":"transport_udp","sourceInterface":"GigabitEthernet0/0/1"}],"protocol":"ipv4"}}},"QoS map definition":{"description":"QoS map definition","value":{"name":"Demo-QoS-Policy","type":"qosMap","description":"Demo-QoS-Policy","definition":{"qosSchedulers":[{"queue":"0","bandwidthPercent":"75","bufferPercent":"75","burst":"15000","scheduling":"llq","drops":"tail-drop","classMapRef":""},{"queue":"7","bandwidthPercent":"25","bufferPercent":"25","scheduling":"wrr","drops":"red-drop","classMapRef":"4484c444-b956-4016-bd15-538b74fc2785"}]}}},"VPN-QoS map definition":{"description":"VPN-QoS map definition","value":{"name":"Demo-VPN-QoS-Policy","type":"vpnQosMap","description":"Demo-VPN-QoS-Policy","definition":{"vpnQosSchedulers":[{"vpnListRef":"","bandwidthRate":"100000","shapingRate":"120000","childMapRef":""},{"childMapRef":""}]}}},"Rewrite rule definition":{"description":"Rewrite rule definition","value":{"name":"Demo-Rewrite-Rule","type":"rewriteRule","description":"Demo-Rewrite-Rule","definition":{"rules":[{"class":"4484c444-b956-4016-bd15-538b74fc2785","plp":"low","dscp":"46","layer2Cos":"2"}]}}},"Device access policy definition":{"description":"Device access policy definition","value":{"name":"Demo-DeviceAccess-Policy","type":"deviceaccesspolicy","description":"Demo-DeviceAccess-Policy","defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Device Access Control List","baseAction":"accept","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"22"},{"field":"sourceIp","value":"10.10.24.0/24"},{"field":"sourcePort","value":"65000"},{"field":"destinationIp","value":"10.10.10.1/32"},{"field":"vpn","value":"10"}]},"actions":[]},{"sequenceId":11,"sequenceName":"Device Access Control List","baseAction":"drop","sequenceType":"deviceaccesspolicy","sequenceIpType":"ipv4","match":{"entries":[{"field":"destinationPort","value":"161"},{"field":"sourceDataPrefixList","ref":"6c2b7164-5de2-4775-938c-b443504324ab"}]},"actions":[]}]}},"vEdge route definition":{"description":"vEdge route definition","value":{"name":"Demo-Route-Policy","type":"vedgeRoute","description":"Demo-Route-Policy","defaultAction":{"type":"reject"},"sequences":[{"sequenceId":1,"sequenceName":"Route","baseAction":"accept","sequenceType":"vedgeRoute","sequenceIpType":"ipv4","match":{"entries":[{"field":"address","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"asPath","ref":"79f8c180-1a23-4f09-800d-62652b571258"},{"field":"community","matchFlag":"or","ref":"33de059b-27ec-4a83-be28-8985128381eb"},{"field":"localPreference","value":"200"},{"field":"metric","value":"100"},{"field":"nextHop","ref":"b5c4d764-20bc-4de3-9bac-52ef70f1186c"},{"field":"ompTag","value":"10"},{"field":"affinity","value":"10"},{"field":"origin","value":"igp"},{"field":"ospfTag","value":"10"},{"field":"peer","value":"10.0.0.1"}]},"actions":[{"type":"set","parameter":[{"field":"asPath","value":{"exclude":"120 130","prepend":"65521 65521"}},{"field":"localPreference","value":"200"},{"field":"metricType","value":"type1"},{"field":"metric","value":"100"},{"field":"nextHop","value":"10.0.0.1"},{"field":"ompTag","value":"100"},{"field":"weight","value":"200"},{"field":"ospfTag","value":"122"},{"field":"originator","value":"10.0.0.1"},{"field":"origin","value":"igp"},{"field":"community","value":"1000:10000"}]}]}]}},"vSmart definition":{"description":"vSmart definition","value":{"policyDescription":"Demo-Centralized-Policy","policyType":"feature","policyName":"Demo-Centralized-Policy","policyDefinition":{"assembly":[{"definitionId":"eb0daba9-7fc4-4f4f-bae7-cd958f81f863","type":"cflowd","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"]}]},{"definitionId":"3e33fa50-a30d-4586-9d69-106121feaaf4","type":"data","entries":[{"direction":"service","siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"8b2e7c44-2666-48a7-87a0-36a43c2d003e","type":"appRoute","entries":[{"siteLists":["5c58c36c-9cd6-468f-8434-ee6d5801c6ba","24747ccd-4f7f-4dfa-8800-34f565fb65b4"],"vpnLists":["cb3ef8e0-9c70-4bb5-85f1-25f22cda76bf"]}]},{"definitionId":"1b76052e-1cb5-44b1-8e5e-4096cb261736","type":"vpnMembershipGroup"},{"definitionId":"62960276-c797-41fd-bebb-c017fc752f4e","type":"hubAndSpoke"}]},"isPolicyActivated":false}},"vEdge definition":{"description":"vEdge definition","value":{"policyDescription":"Demo-Local-Policy","policyType":"feature","policyName":"Demo-Local-Policy","policyDefinition":{"assembly":[{"definitionId":"56283dcf-6dda-4831-bcd1-d9cf62d33fdc","type":"qosMap"},{"definitionId":"a75ead1f-f6ab-4a80-af29-79b742b31c5c","type":"rewriteRule"},{"definitionId":"555dd393-e7b6-4861-866f-f227f5f780b7","type":"deviceAccessPolicy"},{"definitionId":"22655824-d0df-4a8b-9be0-9808938a0e6b","type":"vedgeRoute"}],"settings":{"flowVisibility":true,"flowVisibilityIPv6":true,"appVisibility":true,"cloudQos":true,"cloudQosServiceSide":true,"implicitAclLogging":true,"appVisibilityIPv6":true}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"definitionId":"00f718df-4f95-4363-8639-1fe855c9eb09"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/zonebasedfw/bulk":{"put":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Create/Edit policy definitions in bulk","operationId":"savePolicyDefinitionInBulk_7","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/zonebasedfw/multiple/{id}":{"put":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Edit multiple policy definitions","operationId":"editMultiplePolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/definition/zonebasedfw/preview":{"post":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinition_7","requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/zonebasedfw/preview/{id}":{"get":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Preview policy definition","operationId":"previewPolicyDefinitionById_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/definition/zonebasedfw/{id}":{"get":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Get a specific policy definitions","operationId":"getPolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Edit a policy definitions","operationId":"editPolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy definition","content":{"application/json":{"schema":{"type":"object"},"examples":{"ACL policy":{"description":"ACL policy","value":{"name":"Demo-ACL","type":"acl","description":"Demo-ACL","defaultAction":{"type":"accept"},"sequences":[{"sequenceId":1,"sequenceName":"Access Control List","baseAction":"accept","sequenceType":"acl","sequenceIpType":"ipv4","match":{"entries":[{"field":"dscp","value":"46"},{"field":"protocol","value":"6"}]},"actions":[{"type":"class","parameter":{"ref":"89d20034-7149-4492-b392-b5c4f7903235"}}]}]}},"ZBFW definition":{"description":"ZBFW definition","value":{"name":"Demo-ZBFW","type":"zoneBasedFW","description":"Demo-ZBFW","definition":{"defaultAction":{"type":"drop"},"sequences":[{"sequenceId":1,"sequenceName":"Demo-Rule-1","baseAction":"inspect","sequenceType":"zoneBasedFW","match":{"entries":[{"field":"sourceDataPrefixList","ref":"ecbea5de-b200-4ff7-aa76-f537b5f858e9"}]},"actions":[]}],"entries":[{"sourceZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53","destinationZone":"5f35c58e-234e-4013-9e1a-77c7fa6aec53"}]}}},"IPS definition":{"description":"IPS definition","value":{"name":"Demo-IPS-Policy","type":"intrusionPrevention","description":"Testing","definition":{"signatureSet":"security","inspectionMode":"detection","signatureWhiteList":{"ref":"ad189f08-af06-4799-97d6-0a7c7409cb8d"},"logLevel":"error","logging":[],"targetVpns":["10","20"]}}},"URL filtering definition":{"description":"URL filtering definition","value":{"name":"Demo-URL-Filtering-Policy","type":"urlFiltering","description":"","definition":{"webCategoriesAction":"block","webCategories":["auctions","bot-nets","news-and-media"],"webReputation":"moderate-risk","urlWhiteList":{"ref":"c20e31fb-fcea-4f48-93e3-09d2c6492d8b"},"urlBlackList":{"ref":"557ed432-6cf8-495b-a445-d340d4c6236e"},"blockPageAction":"text","blockPageContents":"Access to the requested page has been denied. Please contact your Network Administrator","enableAlerts":true,"alerts":["blacklist","whitelist","categories-reputation"],"logging":[],"targetVpns":["30"]}}},"AMP definition":{"description":"AMP definition","value":{"name":"Demo-AMP-Policy","type":"advancedMalwareProtection","description":"","definition":{"matchAllVpn":true,"fileReputationCloudServer":"nam","fileReputationEstServer":"nam","fileReputationAlert":"critical","fileAnalysisCloudServer":"nam","fileAnalysisFileTypes":["pdf","ms-exe"],"fileAnalysisAlert":"critical","targetVpns":["10","20"],"fileAnalysisEnabled":true}}},"DNS definition":{"description":"DNS definition","value":{"name":"Demo-DNS-Policy","type":"DNSSecurity","description":"Testing","definition":{"localDomainBypassList":{"ref":"143f753f-8d51-4be6-805d-bc330f09982f"},"matchAllVpn":false,"targetVpns":[{"vpns":["10"],"umbrellaDefault":false,"childOrgId":"7999118","dnsServerIP":"10.10.10.1","localDomainBypassEnabled":true}],"dnsCrypt":true,"umbrellaData":{"ref":"e6d85acd-fb1c-4cd9-ad77-e5bce620ccfa"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy definition":{"description":"Policy definition","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Zone Based Firewall Definition Builder"],"description":"Delete policy definition","operationId":"deletePolicyDefinition_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/ise/identity/deleteAllLists":{"delete":{"tags":["Configuration - Ise Server"],"description":"Delete all lists of the specified list type","operationId":"deleteAllLists","requestBody":{"description":"type of list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAllListsBody"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"},"examples":{"Delete All Lists":{"description":"Delete All Lists","value":true},"Delete Some Or No Lists":{"description":"Delete Some Or No Lists","value":false}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/referenced/{listType}":{"get":{"tags":["Configuration - Ise Server"],"description":"Get all referenced Lists","operationId":"getListReference","parameters":[{"name":"listType","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferencedList"}}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/sgt":{"get":{"tags":["Configuration - Ise Server"],"description":"Get trustsec Scalable Group Tags","operationId":"sgts","responses":{"200":{"description":"All Scalable Group Tags","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SGTResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/usergroups":{"post":{"tags":["Configuration - Ise Server"],"description":"Get all identity user groups","operationId":"getIdentityUserGroups","requestBody":{"description":"Get Users Groups from ISE associated with Active Directory Domain. Body can be an empty object or null to return all User Groups. For filtering a group must be specified, you cannot use a regex.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupsBody"},"examples":{"User Group Filter":{"description":"User Group Filter","value":{"filter":"Cert Publishers"}},"User Group Filter Empty Braces":{"description":"User Group Filter Empty Braces","value":{}},"User Group Filter No Entry":{"description":"User Group Filter No Entry"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupsResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/ise/identity/users":{"post":{"tags":["Configuration - Ise Server"],"description":"Get all identity users","operationId":"getIdentityUsers","requestBody":{"description":"Get Users from ISE associated with Active Directory Domain. Body can be empty object or null to return all users. For filtering can be like the example with a regex or a specific user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersBody"},"examples":{"User Filter":{"description":"User Filter","value":{"filter":"admin"}},"User Filter Wild Card":{"description":"User Filter Wild Card","value":{"filter":"a*"}},"User Filter Empty Braces":{"description":"User Filter Empty Braces","value":{}},"User Filter No Entry":{"description":"User Filter No Entry"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list":{"get":{"tags":["Configuration - Policy List Builder"],"description":"Get all policy lists","operationId":"getAllPolicyLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/app":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_3","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Create policy list","operationId":"createPolicyList_3","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_3","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/app/filtered":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_3","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/app/preview":{"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_3","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/app/preview/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/app/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Application List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_3","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/appprobe":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_4","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_4","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_4","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/appprobe/filtered":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_4","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/appprobe/preview":{"post":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_4","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/appprobe/preview/{id}":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/appprobe/{id}":{"get":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy App Probe Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_4","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/aspath":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_5","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Create policy list","operationId":"createPolicyList_5","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_5","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/aspath/filtered":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_5","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/aspath/preview":{"post":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_5","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/aspath/preview/{id}":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/aspath/{id}":{"get":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy ASPath List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_5","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/class":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_13","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_14","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_14","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/class/filtered":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_14","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/class/preview":{"post":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_14","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/class/preview/{id}":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/class/{id}":{"get":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Forwarding Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_14","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/color":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_6","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Color List Builder"],"description":"Create policy list","operationId":"createPolicyList_6","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Color List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_6","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/color/filtered":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_6","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/color/preview":{"post":{"tags":["Configuration - Policy Color List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_6","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/color/preview/{id}":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/color/{id}":{"get":{"tags":["Configuration - Policy Color List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Color List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Color List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_6","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/community":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_7","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Community List Builder"],"description":"Create policy list","operationId":"createPolicyList_7","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Community List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_7","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/community/filtered":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_7","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/community/preview":{"post":{"tags":["Configuration - Policy Community List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_7","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/community/preview/{id}":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/community/{id}":{"get":{"tags":["Configuration - Policy Community List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Community List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Community List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_7","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataipv6prefix":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_8","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_8","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_8","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataipv6prefix/filtered":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_8","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataipv6prefix/preview":{"post":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_8","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataipv6prefix/preview/{id}":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataipv6prefix/{id}":{"get":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data IPV6 Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_8","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataprefix":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_9","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_10","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_10","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefix/filtered":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_10","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefix/preview":{"post":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_10","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefix/preview/{id}":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefix/{id}":{"get":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_10","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataprefixall":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Get policy lists for all data prefixes","operationId":"getListsForAllDataPrefixes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Create policy list","operationId":"createPolicyList_9","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_9","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixall/filtered":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_9","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixall/preview":{"post":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_9","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixall/preview/{id}":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixall/{id}":{"get":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix All Types Of Lists Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_9","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/dataprefixfqdn":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Get lists for all all data-prefix(IPv4) and Fqdn lists","operationId":"getAllDataPrefixAndFQDNLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Data prefix and FQDN":{"description":"Data prefix and FQDN","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Create policy list","operationId":"createPolicyList_15","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_15","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixfqdn/filtered":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_15","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/dataprefixfqdn/preview":{"post":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_15","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixfqdn/preview/{id}":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/dataprefixfqdn/{id}":{"get":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Data Prefix and FQDN All Types Of Lists Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_15","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/expandedcommunity":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_10","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Create policy list","operationId":"createPolicyList_11","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_11","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/expandedcommunity/filtered":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_11","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/expandedcommunity/preview":{"post":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_11","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/expandedcommunity/preview/{id}":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/expandedcommunity/{id}":{"get":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Expanded Community List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_11","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/extcommunity":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_11","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Create policy list","operationId":"createPolicyList_12","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_12","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/extcommunity/filtered":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_12","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/extcommunity/preview":{"post":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_12","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/extcommunity/preview/{id}":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/extcommunity/{id}":{"get":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Extended Community List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_12","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/faxprotocol":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_12","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Create policy list","operationId":"createPolicyList_13","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_13","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/faxprotocol/filtered":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_13","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/faxprotocol/preview":{"post":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_13","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/faxprotocol/preview/{id}":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/faxprotocol/{id}":{"get":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Fax Protocol List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_13","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/fqdn":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_14","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - FQDN List Builder"],"description":"Create policy list","operationId":"createPolicyList_16","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - FQDN List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_16","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/fqdn/filtered":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_16","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/fqdn/preview":{"post":{"tags":["Configuration - FQDN List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_16","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/fqdn/preview/{id}":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/fqdn/{id}":{"get":{"tags":["Configuration - FQDN List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - FQDN List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - FQDN List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_16","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/geolocation":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_15","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Create policy list","operationId":"createPolicyList_17","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_17","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/geolocation/entries":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get list of countries and continents for geo location","operationId":"getGeoLocationLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/geolocation/filtered":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_17","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/geolocation/preview":{"post":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_17","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/geolocation/preview/{id}":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/geolocation/{id}":{"get":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Geo Location List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_17","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/identity":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_16","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Identity List Builder"],"description":"Create policy list","operationId":"createPolicyList_18","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Identity List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_18","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/identity/filtered":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_18","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/identity/preview":{"post":{"tags":["Configuration - Policy Identity List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_18","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/identity/preview/{id}":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/identity/{id}":{"get":{"tags":["Configuration - Policy Identity List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Identity List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Identity List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_18","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/ipprefixall":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Get lists for all prefixes","operationId":"getListsForAllPrefixes","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Prefixes":{"description":"Prefixes","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Create policy list","operationId":"createPolicyList_21","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_21","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipprefixall/filtered":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_21","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipprefixall/preview":{"post":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_21","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipprefixall/preview/{id}":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipprefixall/{id}":{"get":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix for All Types of Lists Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_21","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/ipssignature":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_17","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Create policy list","operationId":"createPolicyList_19","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_19","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipssignature/filtered":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_19","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipssignature/preview":{"post":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_19","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipssignature/preview/{id}":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipssignature/{id}":{"get":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPS Signature List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_19","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/ipv6prefix":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_18","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_20","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_20","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipv6prefix/filtered":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_20","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/ipv6prefix/preview":{"post":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_20","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipv6prefix/preview/{id}":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/ipv6prefix/{id}":{"get":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy IPv6 Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_20","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/localapp":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_19","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Create policy list","operationId":"createPolicyList_22","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_22","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localapp/filtered":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_22","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localapp/preview":{"post":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_22","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localapp/preview/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localapp/{id}":{"get":{"tags":["Configuration - Policy Application List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Application List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Application List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_22","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/localdomain":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_20","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Create policy list","operationId":"createPolicyList_23","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_23","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localdomain/filtered":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_23","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/localdomain/preview":{"post":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_23","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localdomain/preview/{id}":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/localdomain/{id}":{"get":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Local Domain Name List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_23","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/mediaprofile":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Get policy lists","operationId":"getPolicyLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Create policy list","operationId":"createPolicyList","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mediaprofile/filtered":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mediaprofile/preview":{"post":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mediaprofile/preview/{id}":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mediaprofile/{id}":{"get":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Media Profile List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/mirror":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_21","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Create policy list","operationId":"createPolicyList_24","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_24","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mirror/filtered":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_24","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/mirror/preview":{"post":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_24","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mirror/preview/{id}":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/mirror/{id}":{"get":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Mirror List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_24","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/modempassthrough":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_22","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Create policy list","operationId":"createPolicyList_25","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_25","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/modempassthrough/filtered":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_25","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/modempassthrough/preview":{"post":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_25","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/modempassthrough/preview/{id}":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/modempassthrough/{id}":{"get":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Modem Passthrough List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_25","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/policer":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_23","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_26","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_26","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/policer/filtered":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_26","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/policer/preview":{"post":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_26","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/policer/preview/{id}":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/policer/{id}":{"get":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Policer Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_26","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/port":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_24","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Port List Builder"],"description":"Create policy list","operationId":"createPolicyList_27","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Port List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_27","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/port/filtered":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_27","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/port/preview":{"post":{"tags":["Configuration - Policy Port List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_27","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/port/preview/{id}":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/port/{id}":{"get":{"tags":["Configuration - Policy Port List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Port List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Port List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_27","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/preferredcolorgroup":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_25","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Create policy list","operationId":"createPolicyList_28","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_28","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/preferredcolorgroup/filtered":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_28","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/preferredcolorgroup/preview":{"post":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_28","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/preferredcolorgroup/preview/{id}":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/preferredcolorgroup/{id}":{"get":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Preferred Color Group List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_28","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/prefix":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_26","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Create policy list","operationId":"createPolicyList_29","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_29","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/prefix/filtered":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_29","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/prefix/preview":{"post":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_29","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/prefix/preview/{id}":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/prefix/{id}":{"get":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Prefix List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_29","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/protocolname":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_27","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Create policy list","operationId":"createPolicyList_30","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_30","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/protocolname/filtered":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_30","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/protocolname/preview":{"post":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_30","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/protocolname/preview/{id}":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/protocolname/{id}":{"get":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Protocol Name List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_30","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/region":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_28","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Region List Builder"],"description":"Create policy list","operationId":"createPolicyList_31","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Region List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_31","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/region/filtered":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_31","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/region/preview":{"post":{"tags":["Configuration - Policy Region List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_31","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/region/preview/{id}":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/region/{id}":{"get":{"tags":["Configuration - Policy Region List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Region List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Region List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_31","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/scalablegrouptag":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_29","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Create policy list","operationId":"createPolicyList_32","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_32","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/scalablegrouptag/filtered":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_32","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/scalablegrouptag/preview":{"post":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_32","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/scalablegrouptag/preview/{id}":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/scalablegrouptag/{id}":{"get":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Scalable Group Tag List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_32","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/site":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_30","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Site List Builder"],"description":"Create policy list","operationId":"createPolicyList_33","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Site List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_33","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/site/defaultsite":{"post":{"tags":["Configuration - Policy Site List Builder"],"description":"Create default site list for sites missing from centralized policy","operationId":"createDefaultSiteList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Site list":{"description":"Site list","value":{"name":"Demo_site_list","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"200"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy-read,Policy-write"}},"/template/policy/list/site/filtered":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_33","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/site/preview":{"post":{"tags":["Configuration - Policy Site List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_33","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/site/preview/{id}":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/site/{id}":{"get":{"tags":["Configuration - Policy Site List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Site List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Site List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_33","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/sla":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_31","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Create policy list","operationId":"createPolicyList_34","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_34","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/sla/filtered":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_34","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/sla/preview":{"post":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_34","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/sla/preview/{id}":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/sla/{id}":{"get":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy SLA Class List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_34","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/supervisorydisc":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_32","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Create policy list","operationId":"createPolicyList_35","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_35","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/supervisorydisc/filtered":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_35","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/supervisorydisc/preview":{"post":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_35","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/supervisorydisc/preview/{id}":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/supervisorydisc/{id}":{"get":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Supervisory Disc List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_35","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/tgapikey":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Get policy lists","operationId":"getPolicyLists_33","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Create policy list","operationId":"createPolicyList_36","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_36","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tgapikey/filtered":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_36","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tgapikey/preview":{"post":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_36","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tgapikey/preview/{id}":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tgapikey/{id}":{"get":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Get a specific policy list based on the id","operationId":"getListsById_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Threat Grid Api Key List"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_36","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/tloc":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_34","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Create policy list","operationId":"createPolicyList_37","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_37","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tloc/filtered":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_37","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/tloc/preview":{"post":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_37","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tloc/preview/{id}":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/tloc/{id}":{"get":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TLOC List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_37","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/translationprofile":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Create policy list","operationId":"createPolicyList_1","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_1","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationprofile/filtered":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_1","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationprofile/preview":{"post":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_1","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationprofile/preview/{id}":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationprofile/{id}":{"get":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationProfile List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_1","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/translationrules":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_2","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Create policy list","operationId":"createPolicyList_2","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_2","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationrules/filtered":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_2","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/translationrules/preview":{"post":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_2","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationrules/preview/{id}":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/translationrules/{id}":{"get":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy TranslationRules List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_2","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/trunkgroup":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_35","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Create policy list","operationId":"createPolicyList_38","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_38","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/trunkgroup/filtered":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_38","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/trunkgroup/preview":{"post":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_38","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/trunkgroup/preview/{id}":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/trunkgroup/{id}":{"get":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Trunk Group List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_38","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/umbrelladata":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_36","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Create policy list","operationId":"createPolicyList_39","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_39","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/umbrelladata/filtered":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_39","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/umbrelladata/preview":{"post":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_39","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/umbrelladata/preview/{id}":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/umbrelladata/{id}":{"get":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Umbrella Data List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_39","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/urlblacklist":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Get policy lists","operationId":"getPolicyLists_37","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Create policy list","operationId":"createPolicyList_40","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_40","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlblacklist/filtered":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_40","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlblacklist/preview":{"post":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_40","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlblacklist/preview/{id}":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlblacklist/{id}":{"get":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL BlackList Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_40","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/urlwhitelist":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Get policy lists","operationId":"getPolicyLists_38","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Create policy list","operationId":"createPolicyList_41","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_41","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlwhitelist/filtered":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_41","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/urlwhitelist/preview":{"post":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_41","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlwhitelist/preview/{id}":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/urlwhitelist/{id}":{"get":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy URL WhiteList Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_41","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/vpn":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_39","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy VPN List Builder"],"description":"Create policy list","operationId":"createPolicyList_42","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy VPN List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_42","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/vpn/filtered":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_42","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/vpn/preview":{"post":{"tags":["Configuration - Policy VPN List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_42","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/vpn/preview/{id}":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/vpn/{id}":{"get":{"tags":["Configuration - Policy VPN List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy VPN List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy VPN List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_42","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/list/webex":{"post":{"tags":["Configuration - Policy List Builder"],"description":"TEMP-Create Webex policy lists","operationId":"createWebexPrefixLists","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/webex/update":{"post":{"tags":["Configuration - Policy List Builder"],"description":"TEMP-Update Webex policy lists from Webex config","operationId":"createWebexPrefixLists_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/zone":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Get policy lists","operationId":"getPolicyLists_40","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"App Policy":{"description":"App Policy","value":"{ \"data\": [\n {\n \"listId\": \"be6eb8f9-29df-48a6-ab18-b46af0c60cde\",\n \"name\": \"Google_Apps\",\n \"type\": \"app\",\n \"description\": \"Google Applications List\",\n \"entries\": [\n {\n \"app\": \"gcs\"\n },\n ],\n \"lastUpdated\": 1588001890181,\n \"owner\": \"system\",\n \"readOnly\": true,\n \"version\": \"4.2\",\n \"infoTag\": \"\",\n \"referenceCount\": 0,\n \"references\": [],\n \"isActivatedByVsmart\": false\n },"},"Prefix List":{"description":"Prefix List","value":{"data":[{"listId":"8bc43c09-f72c-40b8-aa90-608c7005e607","name":"Example","type":"prefix","description":"Desc Not Required","entries":[{"ipPrefix":"10.0.0.0/24"}],"lastUpdated":1588178457305,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"post":{"tags":["Configuration - Policy Zone List Builder"],"description":"Create policy list","operationId":"createPolicyList_43","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Zone list":{"description":"Zone list","value":{"name":"Demo-Zone","description":"Desc Not Required","type":"zone","entries":[{"vpn":"10"}]}},"IPS list":{"description":"IPS list","value":{"name":"Demo-IPS-list","description":"Desc Not Required","type":"ipssignature","entries":[{"generatorId":"1111","signatureId":"4444"}]}},"URL white list":{"description":"URL white list","value":{"name":"Demo-Whitelist","description":"Desc Not Required","type":"urlwhitelist","entries":[{"pattern":"https://www.youtube.com"}]}},"URL black list":{"description":"URL black list","value":{"name":"Demo-Black-list","description":"Desc Not Required","type":"urlblacklist","entries":[{"pattern":"www.facebook.com"}]}},"TG API key list":{"description":"TG API key list","value":{"name":"threatGridApiKeyList","description":"","type":"threatGridApiKey","entries":[{"region":"nam","apikey":"1234567"},{"region":"eur","apikey":"1234567"}]}},"Local domain list":{"description":"Local domain list","value":{"name":"Demo-Domain-Name-List","description":"Desc Not Required","type":"localdomain","entries":[{"nameServer":"cisco.com"}]}},"Umbrella data list":{"description":"Umbrella data list","value":{"name":"umbrellaTokenList","description":"","type":"umbrellaData","entries":[{"apiKey":"abcd","secret":"12345","umbOrgId":"23405","token":"abcedabcedabcedabcedabcedabcedabcedabced"}]}},"App family":{"description":"App family","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"appFamily":"web"},{"appFamily":"audio-video"}]}},"App list":{"description":"App list","value":{"name":"Demo-App-List","description":"Desc Not Required","type":"app","entries":[{"app":"facebook"},{"app":"netshow"}]}},"Color list":{"description":"Color list","value":{"name":"Demo-Color-List","description":"Desc Not Required","type":"color","entries":[{"color":"biz-internet"},{"color":"public-internet"}]}},"Data prefix":{"description":"Data prefix","value":{"name":"Demo-Data-Prefix-List","description":"Desc Not Required","type":"dataprefix","entries":[{"ipPrefix":"10.1.0.0/16"},{"ipPrefix":"10.2.0.0/16"}]}},"Policer":{"description":"Policer","value":{"name":"Demo-Policer-list","description":"Desc Not Required","type":"policer","entries":[{"burst":"16000","exceed":"drop","rate":"10000"}]}},"Prefix":{"description":"Prefix","value":{"name":"Demo-Prefix-list","description":"Desc Not Required","type":"prefix","entries":[{"ipPrefix":"10.0.0.0/12","le":"32"}]}},"Site":{"description":"Site","value":{"name":"Demo-Site-List","description":"Desc Not Required","type":"site","listId":null,"entries":[{"siteId":"100"},{"siteId":"200"},{"siteId":"300-500"}]}},"Class":{"description":"Class","value":{"name":"Demo-Class-Map","description":"Desc Not Required","type":"class","entries":[{"queue":"4"}]}},"App probe":{"description":"App probe","value":{"name":"Demo-Probe-Class","type":"appProbe","entries":[{"map":[{"color":"biz-internet","dscp":46},{"color":"public-internet","dscp":20}],"forwardingClass":"391c5977-0af8-46b2-a9b2-e48702593d70"}]}},"SLA":{"description":"SLA","value":{"name":"Demo-SLA-Class","description":"Desc Not Required","type":"sla","entries":[{"latency":"100","loss":"10","jitter":"10","appProbeClass":"39269a77-9592-4a5a-8b35-633a5615c47d"}]}},"TLOC":{"description":"TLOC","value":{"name":"Demo-TLOC-List","description":"Desc Not Required","type":"tloc","entries":[{"tloc":"10.1.1.1","color":"biz-internet","encap":"ipsec","preference":"10"},{"tloc":"10.2.2.2","color":"biz-internet","encap":"ipsec","preference":"20"}]}},"VPN":{"description":"VPN","value":{"name":"Demo-VPN-List","description":"Desc Not Required","type":"vpn","listId":null,"entries":[{"vpn":"100"},{"vpn":"200"},{"vpn":"300-500"}]}},"AS path":{"description":"AS path","value":{"name":"Demo-AS-Path-List","description":"Desc Not Required","type":"aspath","listId":null,"entries":[{"asPath":"100"},{"asPath":"200"},{"asPath":"65002"}]}},"Community":{"description":"Community","value":{"name":"Demo-Community-List","description":"Desc Not Required","type":"community","listId":null,"entries":[{"community":"1000:10000"}]}},"Ext community":{"description":"Ext community","value":{"name":"Demo-Extended-Community-List","description":"Desc Not Required","type":"extcommunity","listId":null,"entries":[{"community":"rt 100:10"}]}},"Mirror":{"description":"Mirror","value":{"name":"Demo-Mirror-List","description":"Desc Not Required","type":"mirror","entries":[{"remoteDest":"10.1.1.1","source":"20.1.1.1"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Zone List Builder"],"description":"Delete policy lists with specific info tag","operationId":"deletePolicyListsWithInfoTag_43","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/zone/filtered":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Get policy lists with specific info tag","operationId":"getPolicyListsWithInfoTag_43","parameters":[{"name":"infoTag","in":"query","description":"InfoTag","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy list":{"description":"Policy list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/list/zone/preview":{"post":{"tags":["Configuration - Policy Zone List Builder"],"description":"Preview a policy list based on the policy list type","operationId":"previewPolicyList_43","requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/zone/preview/{id}":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Preview a specific policy list entry based on id provided","operationId":"previewPolicyListById_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Preview policy list":{"description":"Preview policy list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"}},"/template/policy/list/zone/{id}":{"get":{"tags":["Configuration - Policy Zone List Builder"],"description":"Get a specific policy list based on the id","operationId":"getListsById_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","name":"Community","type":"community","description":"Desc Not Required","entries":[{"community":"1000:5000"}],"lastUpdated":1590184928436,"owner":"admin","readOnly":false,"version":"0","infoTag":"","referenceCount":0,"references":[],"isActivatedByVsmart":false}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-read,Policy Configuration-write,Template Deploy-read,Template Deploy-write,Policy Deploy-read,Policy Deploy-write"},"put":{"tags":["Configuration - Policy Zone List Builder"],"description":"Edit policy list entries for a specific type of policy list","operationId":"editPolicyList_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy list","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy list":{"description":"Policy list","value":{"name":"Community","description":"Desc Not Required","type":"community","listId":"1066ffec-e6ab-426a-b303-434d41b0a4a6","entries":[{"community":"1000:8000"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy":{"description":"Policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"},"delete":{"tags":["Configuration - Policy Zone List Builder"],"description":"Delete policy list entry for a specific type of policy list","operationId":"deletePolicyList_43","parameters":[{"name":"id","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Configuration-write"}},"/template/policy/security":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Generate template list","operationId":"generateSecurityTemplateList","parameters":[{"name":"mode","in":"query","description":"Mode","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Security Template Policy"],"description":"Create Template","operationId":"createSecurityTemplate","requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"Security Policy","policyType":"feature","policyName":"securitypolicy","policyUseCase":"guestAccess","policyDefinition":{"assembly":[{"definitionId":"840f9d3e-b31d-48b6-8365-79b75ba206a9","type":"urlFiltering"}],"settings":{"logging":[{"vpn":"512","serverIP":"10.0.0.1"}],"failureMode":"open"}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/definition/{policyId}":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get Template","operationId":"getSecurityTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/devices":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get device list","operationId":"getSecurityPolicyDeviceList_1","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/devices/{policyId}":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get device list by Id","operationId":"getDeviceListById","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/staging/{policyId}":{"put":{"tags":["Configuration - Security Template Policy"],"description":"Edit Template","operationId":"editTemplateWithLenientLock","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/summary":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Generate security policy summary","operationId":"generateSecurityPolicySummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Security policy summary":{"description":"Security policy summary","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/{deviceModel}":{"get":{"tags":["Configuration - Security Template Policy"],"description":"Get templates that map a device model","operationId":"getSecurityTemplatesForDevice","parameters":[{"name":"deviceModel","in":"path","description":"Device model","required":true,"schema":{"$ref":"#/components/schemas/DeviceModel"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/security/{policyId}":{"put":{"tags":["Configuration - Security Template Policy"],"description":"Edit Template","operationId":"editSecurityTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"Security Policy","policyType":"feature","policyName":"securitypolicy","policyUseCase":"guestAccess","policyDefinition":{"assembly":[{"definitionId":"f41167bd-6948-42ff-bc06-94f450e43999","type":"zoneBasedFW"},{"definitionId":"840f9d3e-b31d-48b6-8365-79b75ba206a9","type":"urlFiltering"}],"settings":{"zoneToNozoneInternet":"deny","logging":[{"vpn":"512","serverIP":"10.0.0.1"}],"failureMode":"open"}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template":{"description":"Template","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Security Template Policy"],"description":"Delete Template","operationId":"deleteSecurityTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get policy details","operationId":"generatePolicyTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - vEdge Template Policy"],"description":"Create template","operationId":"createVEdgeTemplate","requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"policyDescription":"Demo","policyType":"feature","policyName":"demo-policy","policyDefinition":{"assembly":[{"definitionId":"b628d664-d4ec-428f-831c-aff2b688c54c","type":"vedgeRoute"},{"definitionId":"e4b25c74-f594-49db-b78b-61bbb41464ba","type":"acl"}],"settings":{"appVisibility":true,"logFrequency":60}},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy Id":{"description":"Policy Id","value":{"policyId":"f8efb9ed-7524-41ff-aa12-1b6635087ce1"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/definition/{policyId}":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get template","operationId":"getVEdgeTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"data":[{"mastersAttached":0,"lastUpdatedBy":"admin","policyName":"AppVisibility","policyDefinition":"policy\n app-visibility\n flow-visibility\n!\n","policyDefinitionEdit":"policy\n app-visibility\n flow-visibility\n!\n","createdOn":1505676829880,"policyDescription":"Application Visibility Only","@rid":481,"policyId":"0b860b3a-9446-4c19-86f4-49699f4ed2c7","createdBy":"admin","devicesAttached":0,"lastUpdatedOn":1505676829880,"policyType":"cli"},{"mastersAttached":1,"lastUpdatedBy":"admin","policyName":"BaselinePolicy","policyDefinition":"{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}","policyDefinitionEdit":"{\"assembly\":[{\"definitionId\":\"48a7a27a-54e9-443b-a254-cc87ef13f3f5\",\"type\":\"qosMap\"},{\"definitionId\":\"dfe3891d-ee1f-44e1-ba84-caa2e5e9f128\",\"type\":\"acl\"},{\"definitionId\":\"7bdedee2-f87d-4f26-855b-4338b14716a1\",\"type\":\"acl\"},{\"definitionId\":\"e4b25c74-f594-49db-b78b-61bbb41464ba\",\"type\":\"acl\"},{\"definitionId\":\"b628d664-d4ec-428f-831c-aff2b688c54c\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"cloudQos\":true,\"cloudQosServiceSide\":true,\"flowVisibility\":true,\"logFrequency\":10}}","createdOn":1548341101877,"policyDescription":"Baseline dCloud Policy for all WAN Edge","@rid":2095,"policyId":"f73b285f-72eb-4f6d-865f-eae0e453bd8e","createdBy":"admin","devicesAttached":2,"policyType":"feature","lastUpdatedOn":1548341101877}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/devices":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get device list","operationId":"getVEdgePolicyDeviceList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/devices/{policyId}":{"get":{"tags":["Configuration - vEdge Template Policy"],"description":"Get device list by policy","operationId":"getDeviceListByPolicy","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/{policyId}":{"put":{"tags":["Configuration - vEdge Template Policy"],"description":"Edit template","operationId":"editVEdgeTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":"{\n \"policyId\":\"8715a21d-9367-47ea-9bc6-e25163ed9513\",\n \"policyState\":\"edit\",\n \"mastersAttached\":2,\n \"lastUpdatedBy\":\"admin\",\n \"policyName\":\"LocalizedPolicyBaseline\",\n \"policyDefinition\": \"\"\n \"policyDefinitionEdit\":\"\"\n \"createdOn\":1548015105326,\n \"policyDescription\":\"Baseline Localized Policiy for dcloud\",\n \"@rid\":483,\n \"createdBy\":\"admin\",\n \"devicesAttached\":2,\n \"policyType\":\"cli\",\n \"lastUpdatedOn\":1548015105326\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - vEdge Template Policy"],"description":"Delete template","operationId":"deleteVEdgeTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vedge/{resourceGroupName}/{policyId}":{"post":{"tags":["Configuration - vEdge Template Policy"],"description":"Change policy resource group","operationId":"changePolicyResourceGroup","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}},{"name":"resourceGroupName","in":"path","description":"Resrouce group name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Generate template list","operationId":"generateVoiceTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":{"data":[{"lastUpdatedBy":"admin","mastersAttached":0,"policyName":"SIPpolicy","virtualApplicationTemplates":[],"policyDefinition":"{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}","policyDefinitionEdit":"{\"assembly\":[{\"definitionId\":\"5557cab0-b8f7-43d6-97d5-2dc572007aac\",\"type\":\"dialPeer\",\"portType\":\"sipDialPeer\"}]}","createdOn":1590272854518,"policyDescription":"SIP dail peers","policyUseCase":"custom","@rid":1124,"policyId":"87fed5e0-3b95-47a3-9dae-bed8b68562ed","createdBy":"admin","devicesAttached":0,"policyType":"feature","lastUpdatedOn":1590272854518,"supportedDevices":["vedge-C8300-2N2S-4T2X","vedge-C8200-1N-4T","vedge-C8200L-1N-4T","vedge-C8300-2N2S-6T","vedge-C8300-1N1S-4T2X","vedge-C8300-1N1S-6T","vedge-ISR-4451-X","vedge-ISR-4351","vedge-ISR-4461","vedge-ISR-4431","vedge-ISR-4321","vedge-ISR-4331"]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - Voice Template Policy"],"description":"Create Template","operationId":"createVoiceTemplate","requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"SIP dail peers","policyType":"feature","policyName":"SIPpolicy","policyDefinition":{"assembly":[{"definitionId":"5557cab0-b8f7-43d6-97d5-2dc572007aac","type":"dialPeer","portType":"sipDialPeer"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy Id":{"description":"Policy Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/definition/{policyId}":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get templates by policy Id","operationId":"getTemplateById","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/devices":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get all device list","operationId":"getVoicePolicyDeviceList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/devices/{policyId}":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get device list by policy Id","operationId":"getDeviceListByPolicyId","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Device list":{"description":"Device list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/summary":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get templates that map a device model","operationId":"generateVoicePolicySummary","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Policy summary":{"description":"Policy summary","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/{deviceModel}":{"get":{"tags":["Configuration - Voice Template Policy"],"description":"Get templates that map a device model","operationId":"getVoiceTemplatesForDevice","parameters":[{"name":"deviceModel","in":"path","description":"Device model","required":true,"schema":{"$ref":"#/components/schemas/DeviceModel"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template list":{"description":"Template list","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/voice/{policyId}":{"put":{"tags":["Configuration - Voice Template Policy"],"description":"Edit Template","operationId":"editVoiceTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy template","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"policyDescription":"SIP dail peers","policyType":"feature","policyName":"SIPpolicy","policyDefinition":{"assembly":[{"definitionId":"5557cab0-b8f7-43d6-97d5-2dc572007aac","type":"dialPeer","portType":"sipDialPeer"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy template":{"description":"Policy template","value":{"masterTemplatesAffected":[]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Voice Template Policy"],"description":"Delete Template","operationId":"deleteVoiceTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Get all template vsmart policy list","operationId":"generateVSmartPolicyTemplateList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template vSmart policy list":{"description":"Template vSmart policy list","value":{"data":[{"policyVersion":"12282017T235740495","lastUpdatedBy":"admin","policyName":"StrictHub-n-Spoke","policyDefinition":"{\"assembly\":[{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"4ddd51c0-d8a4-4dff-8874-09c24742b518\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}","createdOn":1514732091489,"isPolicyActivated":false,"policyDescription":"BFD/IPSec based Hub-n-Spoke Topology","@rid":6,"policyId":"a8205140-92d9-4688-a127-c70d5f1b93a5","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514732091489},{"policyVersion":"12302017T143348286","lastUpdatedBy":"admin","policyName":"MultiTopologyPolicy","policyDefinition":"{\"assembly\":[{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]}]}","createdOn":1514732164516,"isPolicyActivated":false,"policyDescription":"Multi-Topology Policy","@rid":7,"policyId":"45f0b251-bce6-4b6b-bb8c-de7dbf13ea0f","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514732164516},{"policyVersion":"12312017T143840434","lastUpdatedBy":"admin","policyName":"MultiTopologyPlusFWInsertion","policyDefinition":"{\"assembly\":[{\"definitionId\":\"1ded189f-4c6b-41cf-a686-655120fdf179\",\"type\":\"vpnMembershipGroup\"},{\"definitionId\":\"73096eaf-8bfe-43bd-a67a-9fcaaa2f8c38\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]}]}","createdOn":1514732296993,"isPolicyActivated":false,"policyDescription":"Adding FW for inter-branch communication in VPN 10","@rid":8,"policyId":"b33477d1-1ebc-4080-ba44-b89dbf14fef7","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514732296993},{"policyVersion":"12312017T153128841","lastUpdatedBy":"admin","policyName":"MultiTopologyPlusACL","policyDefinition":"{\"assembly\":[{\"definitionId\":\"968d1ce3-7ff7-4f97-8b69-01e4e06ecad2\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"19f53630-0ce6-4f6b-8e4f-6a527cd15ca4\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}","createdOn":1514734542150,"isPolicyActivated":false,"policyDescription":"Application/ACL Policy for inter-branch traffic in VPN 20","@rid":9,"policyId":"7f156d32-537d-493f-9a7d-53d9e1f05a19","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514734542150},{"policyVersion":"04092018T121824907","lastUpdatedBy":"admin","policyName":"MultiTopologyPlusAppRoute","policyDefinition":"{\"assembly\":[{\"definitionId\":\"433db0fb-c89a-4642-a498-e3b9a257faef\",\"type\":\"appRoute\",\"entries\":[{\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]},{\"siteLists\":[\"1baf2339-97c0-43fb-98d2-285428a61820\"],\"vpnLists\":[\"67c9a7e1-e1b2-4a31-bd7c-7d0bbf9b7bbb\"]}]},{\"definitionId\":\"ce4afddc-3674-4d74-86f2-1005b15e22dc\",\"type\":\"control\",\"entries\":[{\"direction\":\"out\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"]}]},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"a8390569-3aef-4f99-9e6f-678c21bf9dac\",\"type\":\"vpnMembershipGroup\"}]}","createdOn":1514736045181,"isPolicyActivated":false,"policyDescription":"App Aware Routing Policy based on SLA","@rid":10,"policyId":"12df3ed9-6b1f-4b0a-91a2-377cefb8039f","createdBy":"admin","policyType":"feature","lastUpdatedOn":1514736045181},{"policyVersion":"06212018T190131728","lastUpdatedBy":"admin","policyName":"cflowd_policy","policyDefinition":"policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n\n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template","createdOn":1530540307108,"isPolicyActivated":false,"policyDescription":"cflowd","@rid":12,"policyId":"1c865c35-05ac-43a7-a6ee-6328138cd1c4","createdBy":"admin","policyType":"cli","lastUpdatedOn":1530540307108},{"policyVersion":"02242019T10524417","lastUpdatedBy":"admin","policyName":"Hub-Spoke-Policy-PCI","policyDefinition":"{\"assembly\":[{\"definitionId\":\"605fabbd-4c99-4be4-8842-aebb256f7010\",\"type\":\"hubAndSpoke\"},{\"definitionId\":\"c41897b6-b17c-4a1c-b6d9-403af38ef418\",\"type\":\"data\",\"entries\":[{\"direction\":\"service\",\"siteLists\":[\"5d4384b7-b2ab-4d05-9e93-76851304092d\"],\"vpnLists\":[\"f4955f7d-f7b1-4fb5-b0d5-365c40829c51\"]}]},{\"definitionId\":\"207bd271-5008-4271-bd51-a58b14a8dd31\",\"type\":\"vpnMembershipGroup\"}]}","createdOn":1551005623067,"isPolicyActivated":false,"policyDescription":"Enforce PCI VPN to be Hub and Spoke per corporate requirements","@rid":1365,"policyId":"67b2d453-671f-4eaf-b79a-d1c4c0069f1a","createdBy":"admin","policyType":"feature","lastUpdatedOn":1551005623067}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Create template for given policy","operationId":"createVSmartTemplate","requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"policyDescription":"demoVPN","policyType":"feature","policyName":"demoVPN","policyDefinition":{"assembly":[{"definitionId":"605fabbd-4c99-4be4-8842-aebb256f7010","type":"hubAndSpoke"}]},"isPolicyActivated":false}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Policy Id":{"description":"Policy Id","value":{"policyId":"05917007-14e4-42b0-9575-3d3d11f8a371"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/activate/central/{policyId}":{"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Activate vsmart policy for a given policy id","operationId":"activatePolicyForCloudServices","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/activate/{policyId}":{"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Activate vsmart policy for a given policy id","operationId":"activatePolicy","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Activate policy":{"description":"Activate policy","value":{"isEdited":false}},"Deactivate policy":{"description":"Deactivate policy","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"vsmart_policy_config-01242017T020647984"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/central/{policyId}":{"put":{"tags":["Configuration - vSmart Template Policy"],"description":"Edit template for given policy id to allow for multiple component edits","operationId":"editTemplateWithoutLockChecks","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template policy":{"description":"Template policy","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/connectivity/status":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Check VSmart Connectivity Status","operationId":"checkVSmartConnectivityStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Connectivity Status":{"description":"Connectivity Status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/deactivate/{policyId}":{"post":{"tags":["Configuration - vSmart Template Policy"],"description":"Deactivate vsmart policy for a given policy id","operationId":"deActivatePolicy","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{"id":"vsmart_policy_config-60851f10-d9f0-4f41-a27e-9eedbd1bae65"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/definition/{policyId}":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Get template policy definition by policy id","operationId":"getTemplateByPolicyId","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template vSmart policy":{"description":"Template vSmart policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/qosmos_nbar_migration_warning":{"get":{"tags":["Configuration - vSmart Template Policy"],"description":"Qosmos Nbar migration","operationId":"QosmosNbarMigrationWarning","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"NBAR list":{"description":"NBAR list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/policy/vsmart/{policyId}":{"put":{"tags":["Configuration - vSmart Template Policy"],"description":"Edit template for given policy id","operationId":"editVSmartTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Template policy","content":{"application/json":{"schema":{"type":"object"},"examples":{"Template policy":{"description":"Template policy","value":{"policyId":"1c865c35-05ac-43a7-a6ee-6328138cd1c4","policyState":"edit","policyVersion":"06212018T190131728","lastUpdatedBy":"admin","policyName":"cflowd_policy","policyDefinition":"policy\ndata-policy cflowd-policy\n vpn-list vpn_10-20\n default-action accept\n !\n!\ncflowd-template lab-cflowd-template\n flow-inactive-timeout 10\n\n flow-active-timeout 60\n\n template-refresh 600\n collector vpn 10 address 198.18.133.34 port 2055 transport transport_udp\n!\nlists\n vpn-list vpn_10-20\n vpn 10-20\n !\n site-list cflowd-sites\n site-id 100-400\n !\n\n apply-policy\nsite-list cflowd-sites\n data-policy cflowd-policy all\n cflowd-template lab-cflowd-template","createdOn":1530540307108,"isPolicyActivated":false,"policyDescription":"cflowd","@rid":12,"createdBy":"admin","policyType":"cli","lastUpdatedOn":1530540307108,"isEdited":true}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Template policy":{"description":"Template policy","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - vSmart Template Policy"],"description":"Delete template for a given policy id","operationId":"deleteVSmartTemplate","parameters":[{"name":"policyId","in":"path","description":"Policy Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/template/security/encryptText/encrypt":{"post":{"tags":["Configuration - General Template"],"description":"Get Type 6 Encryptedd String for a given value","operationId":"getEncryptedString","requestBody":{"description":"Type6 Encryption","content":{"application/json":{"schema":{"type":"object"},"examples":{"Encryption":{"description":"Encryption","value":{"inputString":"string "}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Encrypted String":{"description":"Encrypted String","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Configuration-read,Template Deploy-read,Template Deploy-write"}},"/tenant":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Lists all the tenants on the vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAllTenants","parameters":[{"name":"deviceId","in":"query","description":"List all tenants associated with a vSmart or MTEdge","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Tenant models":{"description":"Tenant models","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca,Manage LI-read"},"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Create a new tenant in Multi-Tenant vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createTenant","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/async":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Create a new tenant in Multi-Tenant vManage asynchronously
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createTenantAsync","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"orgName\": \"fq-tenan1 - 19442\",\n \"subDomain\": \"tenant1-fq-dev-dev.viptela.info\",\n \"name\": \"fq-tenan1 - 19442\",\n \"desc\": \"fq-tenan1 - 19442\"\n \"wanEdgeForecast\": \"100\"\n}"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/bulk/async":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Create multiple tenants on vManage asynchronously
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"createTenantAsyncBulk","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":[{"orgName":"fq-tenan1 - 19442","subDomain":"tenant1-fq-dev-dev.viptela.info","name":"fq-tenan1 - 19442","desc":"fq-tenan1 - 19442","wanEdgeForecast":"100"},{"orgName":"fq-tenan2 - 19442","subDomain":"tenant1-fq-dev-dev.viptela.info","name":"fq-tenan1 - 19442","desc":"fq-tenan1 - 19442","wanEdgeForecast":"100","vSmarts":"[vSmartUUID1, vSmartUUID2]"}]}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"[{\n \"id\": \u201c537911061561\u201d .\n \"name\" :\" fq-tenan1 - 19442 \",\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"},"delete":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Delete multiple tenants on vManage asynchronously
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteTenantAsyncBulk","requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{"password":"12345","tenantIdList":["0f4f1c6e-47da-40c4-8517-9d1e918965d9","6b7b23bf-5dba-4cca-a36c-1c3cc2254d68"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":"{[\n \"id\": \u201c537911061561\u201d .\n]}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/vsmart":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Retrieve mapping of tenants to vSmarts
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantvSmartMapping","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart tenant mapping":{"description":"vSmart tenant mapping","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca"}},"/tenant/vsmart-mt/migrate":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Migrate tenants from single tenant vSmarts to multi-tenant capable vSmarts
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"tenantvSmartMtMigrate","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/vsmart/capacity":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Lists all the vsmarts on the vManage and its tenant hosting capacity
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenantHostingCapacityOnvSmarts","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"vSmart Capacity":{"description":"vSmart Capacity","value":"[\"data\": [\n {\n \"vSmartUuid\": \"6dbf3f8d-d537-4650-9200-154d8b98b302\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"05aab9ac-44f7-4292-b8c5-2cc40f3afb5a\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n },\n {\n \"vSmartUuid\": \"b20b4468-7a5f-48f1-8ee6-f393afd3ac72\",\n \"totalTenantCapacity\": 24,\n \"currentTenantCount\": 2\n }\n ]]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca"}},"/tenant/{tenantId}":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Get a tenant by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read"},"put":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Update a tenant in Multi-Tenant vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"updateTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{"orgName":"fq-tenan1 - 19442","subDomain":"tenant1-fq-dev-dev.viptela.info","desc":"fq-tenan1 - 19442"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":"{\n \"id\": \u201c537911061561\u201d .\n \"desc\": \" fq-tenan1 - 19442\" ,\n \"orgName'\" : \" fq-tenan1 - 19442\",\n \"subDomain\" : \" tenant1-fq-dev-dev.viptela.info \",\n \"vBondAddress\" : \u201cfq-cluster1-vb-dev.viptela.info \"\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/{tenantId}/delete":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Delete a tenant by Id
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"Tenant model":{"description":"Tenant model","value":{"password":"password"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenant/{tenantId}/switch":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Switch to a specific tenant
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"switchTenant","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vSession model":{"description":"vSession model","value":"{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read"}},"/tenant/{tenantId}/vsessionid":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Get VSessionId for a specific tenant
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"vSessionId","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"vSession model":{"description":"vSession model","value":"{\n \u201cVSessionId\u201d: \u201cMTU0MTA4MDUwODM5OQ==\u201d\n}"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,dca"}},"/tenant/{tenantId}/vsmart":{"put":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Update placement of the Tenant from source vSmart to destination vSmart
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"updateTenantvSmartPlacement","parameters":[{"name":"tenantId","in":"path","description":"Tenant Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tenant model","content":{"application/json":{"schema":{"type":"object"},"examples":{"UpdateTenantvSmartModel":{"description":"UpdateTenantvSmartModel","value":{"srcvSmartUuid":"UUID","destvSmartUuid":"UUID"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/tenantbackup/delete":{"delete":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Delete all or a specific backup file stored in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deleteTenantBackup","parameters":[{"name":"fileName","in":"query","description":"File name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Deleted file list":{"description":"Deleted file list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write,Tenant Status-write"}},"/tenantbackup/download/{path}":{"get":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Download a Backup File that is already stored in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"downloadExistingBackupFile","parameters":[{"name":"path","in":"path","description":"File path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Backup file stream":{"description":"Backup file stream"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write"}},"/tenantbackup/export":{"get":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Trigger a backup of configuration database and store it in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"exportTenantBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write"}},"/tenantbackup/import":{"post":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"Submit a previously backed up file and import the data and apply it to the configuraion database
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"importTenantBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task status":{"description":"Task status","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write,Tenant Status-write"}},"/tenantbackup/list":{"get":{"tags":["Tenant Backup Restore","Multitenant APIs - Provider"],"description":"List all backup files of a tenant stored in vManage
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"listTenantBackup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Backup file list":{"description":"Backup file list","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read,Tenant Management-write,Tenant Status-read,Tenant Status-write"}},"/tenantmigration/download/{path}":{"get":{"tags":["Tenant Migration"],"description":"Download tenant data","operationId":"downloadTenantData","parameters":[{"name":"path","in":"path","description":"File path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"object"},"examples":{"Tenant data":{"description":"Tenant data","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/export":{"post":{"tags":["Tenant Migration"],"description":"Export tenant data","operationId":"exportTenantData","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/MigrateTenantModel"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/import/{migrationKey}":{"post":{"tags":["Tenant Migration"],"description":"Import tenant data","operationId":"importTenantData","parameters":[{"name":"migrationKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/migrationToken":{"get":{"tags":["Tenant Migration"],"description":"Get migration token","operationId":"getMigrationToken","parameters":[{"name":"migrationId","in":"query","description":"Migration Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Migration token":{"description":"Migration token","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantmigration/networkMigration":{"get":{"tags":["Tenant Migration"],"description":"Re-trigger network migration","operationId":"reTriggerNetworkMigration","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"},"post":{"tags":["Tenant Migration"],"description":"Migrate network","operationId":"migrateNetwork","requestBody":{"description":"Network migration","content":{"application/json":{"schema":{"type":"object"},"examples":{"Network migration":{"description":"Network migration","value":{}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Task Id":{"description":"Task Id","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"admin"}},"/tenantstatus":{"get":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"List all tenant status
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"getAllTenantStatuses","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Tenant status":{"description":"Tenant status","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-read"}},"/tenantstatus/force":{"post":{"tags":["Tenant Management","Multitenant APIs - Provider"],"description":"Force tenant status collection
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"forceStatusCollection","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tenant Management-write"}},"/token/{regionBaseUri}/{clientId}":{"post":{"tags":["Monitoring - SecureX Integration"],"description":"Get Access Token and Refresh Token for authorized user","operationId":"token","parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string"}},{"name":"regionBaseUri","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tokens"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/topology":{"get":{"tags":["Configuration - Topology"],"description":"Create full topology","operationId":"createFullTopology","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"Topologies":{"description":"Topologies","value":[]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/topology/device":{"get":{"tags":["Configuration - Topology"],"description":"Create device topology","operationId":"createDeviceTopology","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topology":{"description":"Topology","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/topology/device/site/{siteId}":{"get":{"tags":["Configuration - Topology"],"description":"Get topology for a given site id","operationId":"getSiteTopology","parameters":[{"name":"siteId","in":"path","description":"Site Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read,Template Deploy-write,System-read"}},"/topology/monitor/site/{siteId}":{"get":{"tags":["Configuration - Topology"],"description":"Get topology monitor data for a given site id","operationId":"getSiteTopologyMonitorData","parameters":[{"name":"siteId","in":"path","description":"Site Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Site topology monitor":{"description":"Site topology monitor","value":{"data":[{"device-id":"C8K-9272137f-9fd1-424b-9f0e-8df10fe7dc88","device-health":"yellow","circuits":[{"color":"lte","system_ip":"172.16.255.14","circuit-health":"yellow","tunnels":[{"name":"172.16.255.14:lte-172.16.255.15:lte","health":"yellow","state":"Up","vqoe_score":7}]}],"if-speed":[{"interface":"GigabitEthernet1","count":34,"tx_kbps":0,"rx_kbps":0}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write"}},"/topology/physical":{"get":{"tags":["Configuration - Topology"],"description":"Create pysical topology","operationId":"createPhysicalTopology","parameters":[{"name":"deviceId","in":"query","description":"Device Id list","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceIP"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Topology":{"description":"Topology","value":{}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read"}},"/troubleshooting/control/{uuid}":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Troubleshoot control connections","operationId":"getControlConnections","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetControlConnections"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/troubleshooting/devicebringup":{"get":{"tags":["Troubleshooting Tools - Device Connectivity"],"description":"Debug device bring up","operationId":"getDeviceConfiguration","parameters":[{"name":"uuid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceConfiguration"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read"}},"/umbrella/getkeys":{"get":{"tags":["Umbrella"],"description":"Get keys from Umbrella","operationId":"getAllKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/getkeys/management":{"get":{"tags":["Umbrella"],"description":"Get management keys from Umbrella","operationId":"getManagementKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/getkeys/networkdevices":{"get":{"tags":["Umbrella"],"description":"Get network devices keys from Umbrella","operationId":"getNetworkKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/getkeys/reporting":{"get":{"tags":["Umbrella"],"description":"Get reporting keys from Umbrella","operationId":"getReportingKeysFromUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default"}},"/umbrella/syncnow":{"get":{"tags":["Umbrella"],"description":"Get metadata from db and send to Umbrella","operationId":"sendMetaDataToUmbrella","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/ump/status":{"get":{"tags":["Monitoring - UMP Details"],"description":"Get last N minutes UMP historic data","operationId":"getStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"UMP_Summary":{"description":"UMP_Summary","value":"total_db_query=23684439, total_return_size=387230767, totoal_sdn_query=1874632 umpKey=execute_select, last_60s_query=7813 umpKey=execute_update, last_60s_query=8"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/url/monitor":{"get":{"tags":["url monitor"],"summary":"List url monitoring information.","description":"List url's with monitoring configuration and details about the current state of alarm.","operationId":"getUrlMonitor","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlMonitoringInfo"}}}},"204":{"description":"No content"}}},"put":{"tags":["url monitor"],"summary":"Update url monitor configuration","description":"Update monitor configuration related to the url","operationId":"updateUrlMonitor","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"URL Monitor Payload":{"description":"URL Monitor Payload","value":{"threshold":20,"url":"/client/server/ready"}}}}},"required":true},"responses":{"202":{"description":"Accepted"},"400":{"description":"invalid url"},"404":{"description":"url not monitored"}}},"post":{"tags":["url monitor"],"summary":"Create url monitor.","description":"Monitor the url with specified configuration.","operationId":"createUrlMonitor","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"URL Monitor Payload":{"description":"URL Monitor Payload","value":{"threshold":20,"url":"/client/server/ready"}}}}},"required":true},"responses":{"201":{"description":"url monitor created"},"400":{"description":"invalid url"}}},"delete":{"tags":["url monitor"],"summary":"Delete monitored url.","description":"Delete an url which is already being monitored.","operationId":"deleteUrlMonitor","parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"404":{"description":"url not monitored"}}}},"/util/configdb/metrics":{"get":{"tags":["Utility - Configuration DB"],"summary":"Return the values of the specific metric within the timeframe","description":"By passing in the appropriate metric, it will return the values of the respective metric within the timeframe provided ","operationId":"returnMetric","parameters":[{"name":"metricName","in":"query","description":"Pass the metric name","required":true,"schema":{"type":"string"},"example":"neo4j.bolt.connections_running"},{"name":"startDate","in":"query","description":"Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as and respectively.","required":true,"schema":{"type":"string"},"examples":{"yyyy-MM-dd":{"description":"yyyy-MM-dd","value":"2022-11-20"},"number (minutes)":{"description":"number (minutes)","value":10}}},{"name":"endDate","in":"query","description":"Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.","schema":{"type":"string"},"example":"2022-11-23"},{"name":"start","in":"query","description":"Start Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":142430},{"name":"end","in":"query","description":"End Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":235830},{"name":"pageNo","in":"query","description":"Page Number","schema":{"type":"integer","format":"int32","default":1}},{"name":"limit","in":"query","description":"The numbers of items to return on given Page Number","schema":{"type":"integer","format":"int32","default":500}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neo4jMetricsResponse"}}}},"400":{"description":"Bad input parameter"},"500":{"description":"Internal Error"}}}},"/util/configdb/metrics/downloadfiles":{"get":{"tags":["Utility - Configuration DB"],"summary":"Return the tar file consisting of files of the specific metric within the timeframe","description":"By passing in the appropriate metric, date, start and end time, it will return a tar file consisting of all the metric files of the respective metric within the timeframe provided ","operationId":"returnMetricFiles","parameters":[{"name":"metricName","in":"query","description":"Pass the metric name","required":true,"schema":{"type":"string"},"example":"neo4j.bolt.connections_running"},{"name":"startDate","in":"query","description":"Date in yyyy-MM-dd format or any Number format. If a number is passed, that will be the number of minutes. The start/end will be translated as and respectively.","required":true,"schema":{"type":"string"},"examples":{"yyyy-MM-dd":{"description":"yyyy-MM-dd","value":"2022-11-20"},"number (minutes)":{"description":"number (minutes)","value":10}}},{"name":"endDate","in":"query","description":"Date in yyyy-MM-dd format. The end date is given if data from multiple dates needs to be extracted. If single date data needed then endDate can be empty. endDate cannot be a previous date to the startDate.","schema":{"type":"string"},"example":"2022-11-23"},{"name":"start","in":"query","description":"Start Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":142430},{"name":"end","in":"query","description":"End Time in HHMMSS format; Time in UTC timezone","schema":{"type":"string"},"example":235830}],"responses":{"200":{"description":"return tarball file matching criteria","content":{"application/gzip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad input parameter"},"500":{"description":"Internal Error"}}}},"/util/configdb/metrics/listmetrics":{"get":{"tags":["Utility - Configuration DB"],"summary":"Provides the list of all the generated metrics","description":"Fetches the list of enabled metrics","operationId":"getMetricsList","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/configdb/size":{"get":{"tags":["Utility - Configuration DB"],"description":"Fetches the disk usage by configuration-db","operationId":"getDBSizeOnFile","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/logfile/appserver":{"get":{"tags":["Utility - Logging"],"description":"Lists content of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.","operationId":"listLogFileDetails","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"object"},"example":"14-Mar-2024 00:00:00,001 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message\n14-Mar-2024 00:00:00,002 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 2\n14-Mar-2024 00:00:00,003 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 3\n"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/logfile/appserver/lastnlines":{"get":{"tags":["Utility - Logging"],"description":"List last N lines of log file. This API accepts content type as text/plain. It is mandatory to provide response content type. Any other content type would result in empty response.","operationId":"listVManageServerLogLastNLines","parameters":[{"name":"lines","in":"query","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"object"},"example":"14-Mar-2024 00:00:00,001 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message\n14-Mar-2024 00:00:00,002 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 2\n14-Mar-2024 00:00:00,003 UTC INFO [] [vm12] [ClassName] (ThreadName) || test log message 3\n"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/logging/debuglog":{"post":{"tags":["Utility - Logging"],"description":"Test whether logging works","operationId":"debugLog","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"loggerName":{"type":"string"},"logMessage":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/util/logging/level":{"post":{"tags":["Utility - Logging"],"description":"Set log level for logger","operationId":"setLogLevel","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"loggerName":{"type":"string"},"logLevel":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Set logger"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/logging/loggers":{"get":{"tags":["Utility - Logging"],"description":"List loggers","operationId":"listLoggers","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Loggers"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/olapdb/migration/action/{action}":{"post":{"tags":["Utility - OLAP DB"],"description":"Migration actions - start pause or restart migration","operationId":"postStatsMigrationAction","parameters":[{"name":"action","in":"path","description":"Migration action","required":true,"schema":{"type":"string","enum":["START","PAUSE","STOP","RESTART","RESTART-STAGE-2-ONLY","WIPE-DATA"]}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Successful response of START":{"description":"Successful response of START","value":{"type":"ok","message":"START"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/util/olapdb/migration/rangefrom":{"get":{"tags":["Utility - OLAP DB"],"description":"Get migration historical data range configuration from upgrade time","operationId":"getStatsMigrationRangeConfig","responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object"},"examples":{"Configuration of rangefrom":{"description":"Configuration of rangefrom","value":{"default":-1,"sitehealth":1000001,"perfmon":1000008,"interface":1000005,"qos":1000006,"sleofflinereport":1000027,"alarm":1000012,"tracker":1000026,"deviceevent":1000003,"ulogging":1000017,"devicehealth":1000000,"dpi":1000015,"aggregatedapp":1000007,"umts":1000009,"art":1000013,"auditlog":1000011,"utd":1000016,"fwall":1000018,"umbrella":1000019,"deviceconfiguration":1000029,"eiolte":1000022,"vnf":1000020,"nwpi":1000014,"devicesystemstatus":1000004,"wlan":1000021,"sdra":1000024,"cloudx":1000025,"approutestats":1000002,"bridge":1000010,"apphosting":1000028,"speedtest":1000023}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Utility - OLAP DB"],"description":"Config migration historical data range from upgrade time in seconds. -1 to keep all.","operationId":"postStatsMigrationRangeConfig","requestBody":{"description":"Range from config","content":{"application/json":{"schema":{"type":"string"},"examples":{"Configuration of rangefrom":{"description":"Configuration of rangefrom","value":{"default":-1,"sitehealth":1000001,"perfmon":1000008,"interface":1000005,"qos":1000006,"sleofflinereport":1000027,"alarm":1000012,"tracker":1000026,"deviceevent":1000003,"ulogging":1000017,"devicehealth":1000000,"dpi":1000015,"aggregatedapp":1000007,"umts":1000009,"art":1000013,"auditlog":1000011,"utd":1000016,"fwall":1000018,"umbrella":1000019,"deviceconfiguration":1000029,"eiolte":1000022,"vnf":1000020,"nwpi":1000014,"devicesystemstatus":1000004,"wlan":1000021,"sdra":1000024,"cloudx":1000025,"approutestats":1000002,"bridge":1000010,"apphosting":1000028,"speedtest":1000023}}}}},"required":true},"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/olapdb/migration/settings":{"get":{"tags":["Utility - OLAP DB"],"description":"Get migration generic settings","operationId":"getStatsMigrationSettings","responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object"},"examples":{"Settings example":{"description":"Settings example","value":{"vol_threshold_start":80,"vol_threshold_pause":85,"max_auto_retry_count":20,"stage1_max_threads_count_percentage_to_cpu_core":65}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Utility - OLAP DB"],"description":"Config generic settings","operationId":"postStatsMigrationSettings","requestBody":{"description":"generic settings","content":{"application/json":{"schema":{"type":"string"},"examples":{"Settings example":{"description":"Settings example","value":{"vol_threshold_start":80,"vol_threshold_pause":85,"max_auto_retry_count":20,"stage1_max_threads_count_percentage_to_cpu_core":65}}}}},"required":true},"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/olapdb/migration/statsdbinfo":{"get":{"tags":["Utility - OLAP DB"],"description":"Get stats db table information","operationId":"getStatsMigrationStatsDbInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/util/olapdb/migration/status":{"get":{"tags":["Utility - OLAP DB"],"description":"Get migration status","operationId":"getStatsMigrationStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Status example":{"description":"Status example","value":{"running_state":false,"cur_stage_info":{"stage":"DONE","retries":0},"migrate_exception_indices":[],"cleanup_exception_indices":[],"migrated_indices":["approutestatsstatistics_2023_10_17t12_22_42","devicehealthstatistics_2023_10_17t12_24_14"],"stats_db_info":{"total_count":2884,"total_bytes":1461800},"migrated_stats_docs":2884,"vmanage_upgraded_timestamp":1697547496112}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/cloudonramp/saas":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get Cloud On Ramp For Saas apps status","operationId":"getCloudOnRampSaasStatus","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/cloud_tunnels":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get Secure Internet Gateway Tunnel List","operationId":"getCloudTunnelList","parameters":[{"name":"deviceIp","in":"query","description":"DeviceIp/SystemIp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/configuration":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get Policy Groups that are deployed with Cloud on Ramp for Saas intent","operationId":"getPolicyGroupsWithCorSaasApps","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/devices":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get site, apps and device role information for cloud on ramp devices","operationId":"getCorSitesPerDevice","responses":{"200":{"description":"Success"},"400":{"description":"BadRequest"},"403":{"description":"Forbidden"},"500":{"description":"InternalServerError"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/inactivesites":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get inactive sites","operationId":"getInactiveCorSaasSites","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/legacydevicelist":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get Legacy Devices List","operationId":"getLegacyDeviceList","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/status":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get Cloud On Ramp App details per device","operationId":"getCorSaasStatusPerDevice","parameters":[{"name":"deviceIp","in":"query","description":"DeviceIp/SystemIp","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/cloudonramp/saas/webexsyncstatus":{"get":{"tags":["Configuration - Cloud On Ramp SaaS"],"description":"Get Webex's sync Status for devices with COR Saas enabled via config group or device template","operationId":"getWebexSyncStatus","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Cloud OnRamp-read"}},"/v1/config-group":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get a Configuration Group by Solution","operationId":"GetConfigGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConfigGroup"}},"examples":{"West coast retail stores":{"value":[{"description":" group for west coast retail stores","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"West coast retail stores","profiles":[{"description":"Profile file description","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"system feature profile","solution":"sdwan","type":"system"}],"solution":"sdwan","source":"retail_workflow","state":" Group Deployment state.Initial state Deployed "}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"},"post":{"tags":["Configuration - Configuration Group"],"description":"Create a new Configuration Group","operationId":"CreateConfigGroup","requestBody":{"description":"Config Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema"},"examples":{"CEDGE-ConfigGroup1-NY":{"$ref":"#/components/examples/CEDGE-ConfigGroup1-NY"},"AON-ConfigGroup1-SF":{"$ref":"#/components/examples/AON-ConfigGroup1-SF"},"CEDGE-ConfigGroup2-DualDeviceSiteDeployment":{"$ref":"#/components/examples/CEDGE-ConfigGroup2-DualDeviceSiteDeployment"},"NFVIRTUAL-ConfigGroup1-SF":{"$ref":"#/components/examples/NFVIRTUAL-ConfigGroup1-SF"},"CEDGE-ConfigGroup1-COPY":{"$ref":"#/components/examples/CEDGE-ConfigGroup1-COPY"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema"},"examples":{"example_1":{"$ref":"#/components/examples/example_1"},"example_2":{"$ref":"#/components/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"}},"/v1/config-group/{configGroupId}":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get a Configuration Group by ID","operationId":"GetConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deviceList","in":"query","description":"Including associated devices list","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigGroup"},"examples":{"West coast retail stores":{"value":{"description":" group for west coast retail stores","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"West coast retail stores","profiles":[{"description":"Profile file description","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"system feature profile","solution":"sdwan","type":"system"}],"solution":"sdwan","source":"retail_workflow","state":" Group Deployment state.Initial state Deployed "}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"},"put":{"tags":["Configuration - Configuration Group"],"description":"Edit a Configuration Group","operationId":"EditConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Config Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-2"},"examples":{"CEDGE-ConfigGroup1-NY":{"$ref":"#/components/examples/CEDGE-ConfigGroup1-NY"},"AON-ConfigGroup1-SF":{"$ref":"#/components/examples/AON-ConfigGroup1-SF"},"CEDGE-ConfigGroup2-DualDeviceSiteDeployment":{"$ref":"#/components/examples/CEDGE-ConfigGroup2-DualDeviceSiteDeployment"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-2"},"examples":{"example_1":{"$ref":"#/components/examples/example_1"},"example_2":{"$ref":"#/components/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"},"delete":{"tags":["Configuration - Configuration Group"],"description":"Delete Config Group","operationId":"DeleteConfigGroup","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deleteProfiles","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"}},"/v1/config-group/{configGroupId}/device/associate":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get devices association with a config group","operationId":"GetConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-3"},"examples":{"Config Group Associate":{"description":"Config Group Associate","$ref":"#/components/examples/associate"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-read"},"put":{"tags":["Configuration - Configuration Group"],"description":"Move the devices from one config group to another","operationId":"UpdateConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-3"},"examples":{"example_1":{"$ref":"#/components/examples/examples-example_1"},"example_2":{"$ref":"#/components/examples/examples-example_2"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-write"},"post":{"tags":["Configuration - Configuration Group"],"description":"Create associations with device and a config group","operationId":"CreateConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-4"},"examples":{"example_1":{"$ref":"#/components/examples/examples-example_1"},"example_2":{"$ref":"#/components/examples/examples-example_2"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-write"},"delete":{"tags":["Configuration - Configuration Group"],"description":"Delete Config Group Association from devices","operationId":"DeleteConfigGroupAssociation","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-5"},"examples":{"example_1":{"$ref":"#/components/examples/examples-example_1"},"example_2":{"$ref":"#/components/examples/examples-example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device-write"}},"/v1/config-group/{configGroupId}/device/deploy":{"post":{"tags":["Configuration - Configuration Group"],"description":"deploy config group to devices
Note: In a multitenant vManage system, this API is only available in the Provider view.","operationId":"deployConfigGroup","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-6"},"examples":{"example_1":{"$ref":"#/components/examples/Schema2HubGeneratedDocumentation-examples-example_1"},"example_2":{"$ref":"#/components/examples/Schema2HubGeneratedDocumentation-examples-example_2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-4"},"examples":{"example_1":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device > Deploy-write"}},"/v1/config-group/{configGroupId}/device/variables":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get device variables","operationId":"getConfigGroupDeviceVariables","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}},{"name":"device-id","in":"query","description":"Comma separated device id's like d1,d2","schema":{"type":"string"}},{"name":"suggestions","in":"query","description":"Suggestions for possible values","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-5"},"examples":{"Config Group Device Variables":{"description":"Config Group Device Variables","$ref":"#/components/examples/variables"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"},"put":{"tags":["Configuration - Configuration Group"],"description":"assign values to device variables","operationId":"createConfigGroupDeviceVariables","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-write"},"post":{"tags":["Configuration - Configuration Group"],"description":"Fetch device variables","operationId":"fetchConfigGroupDeviceVariables","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"}},"/v1/config-group/{configGroupId}/device/variables/schema":{"get":{"tags":["Configuration - Configuration Group"],"description":"get device variables schema","operationId":"getConfigGroupDeviceVariablesSchema","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}},{"name":"all","in":"query","description":"All variables(including sub-feature)","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"TODO":{"description":"TODO","value":"TODO"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group-read"}},"/v1/config-group/{configGroupId}/device/{deviceId}/preview":{"post":{"tags":["Configuration - Configuration Group"],"description":"Get a preview of the configuration for a device","operationId":"getConfigGroupDeviceConfigurationPreview","parameters":[{"name":"configGroupId","in":"path","description":"Config Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-6"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Config Group > Device > Deploy-read"}},"/v1/config-group/{configGroupId}/rules":{"get":{"tags":["Configuration - Configuration Group"],"description":"Get Rule by associated object Id, example : get rules by config group Id","operationId":"getRuleAssociationByConfigGroupId","parameters":[{"name":"configGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Config Group":{"description":"Config Group","value":{"name":"C8KV_East_Coast_Rule","description":"All C8KV devices in the east cost","useCase":"config-group-device","matchCriteria":{"match-type":"all","conditions":[{"attribute":"tags","operator":"equals","value":"East_Coast"},{"attribute":"model","operator":"equals","value":"C8000v"}]}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/device/analyzeCliConfig":{"post":{"tags":["Monitoring - Device Details"],"description":"Analyze CLI Config for device","operationId":"analyzeCliConfig","requestBody":{"description":"CLI Configs for device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzeCliConfig"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"CLI Configs example":{"description":"CLI Configs example","value":{"cliOutput":"interface GigabitEthernet3\n no shutdown\n negotiation auto\nexit\n","iosCliOutput":"rf definition Mgmt-intf\n address-family ipv4\n exit-address-family\n !\n!"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/v1/device/runningIosCliConfig/{deviceUUID}":{"get":{"tags":["Monitoring - Device Details"],"description":"Get Running iOS CLI Config for device","operationId":"getRunningIosCliConfig","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"iOS Running iOs CLI Config example":{"description":"iOS Running iOs CLI Config example","value":{"runningIosCliConfig":"ip host vbond 10.0.12.26 2001:A0:C::1A\npae\nip ssh pubkey-chain\n username admin\n key-hash ssh-rsa 97DECCBC0021386299C5806E2C18BFFA vtest@sdwan-laas-vt43\nipv6 route ::/0 2001:A0:C::C\nline con 0\n exec-timeout 0 0\nline vty 0 4\n exec-timeout 0 0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/v1/device/unsupportedCliConfig/{deviceUUID}":{"get":{"tags":["Monitoring - Device Details"],"description":"Get Unsupported CLI Config for device","operationId":"getUnsupportedCliConfig","parameters":[{"name":"deviceUUID","in":"path","required":true,"schema":{"type":"string"}},{"name":"highlightUnsupportedClis","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Unsupported CLI Config example":{"description":"Unsupported CLI Config example","value":{"unsupportedCliConfig":"ip host vbond 10.0.12.26 2001:A0:C::1A\npae\nip ssh pubkey-chain\n username admin\n key-hash ssh-rsa 97DECCBC0021386299C5806E2C18BFFA vtest@sdwan-laas-vt43\nipv6 route ::/0 2001:A0:C::C\nline con 0\n exec-timeout 0 0\nline vty 0 4\n exec-timeout 0 0"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Inventory-read,Device Inventory-write,Template Deploy-read,Template Deploy-write,Device Inventory > Edge-read,Device Inventory > Controller-read,Device Inventory > Edge-write"}},"/v1/feature-profile/mobility/cli":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Mobility Cli Feature Profiles","operationId":"GetMobilityCliFeatureProfile","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"referenceCount","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On-read"}},"/v1/feature-profile/mobility/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get a Mobility Feature Profile with Cli profile type","operationId":"GetMobilityCliFeatureProfileByCliId","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On-read"}},"/v1/feature-profile/mobility/cli/{cliId}/config":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get config Features for cli feature profile","operationId":"GetAllConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a config Feature for cli feature profile","operationId":"CreateConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-9"},"examples":{"CliConfigParcel1":{"$ref":"#/components/examples/CliConfigParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-write"}},"/v1/feature-profile/mobility/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get config Feature by configId for cli feature profile","operationId":"GetConfigFeatureForMobilityByParcelId","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a config Feature for cli feature profile","operationId":"EditConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-10"},"examples":{"CliConfigParcel1":{"$ref":"#/components/examples/CliConfigParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a config Feature for cli feature profile","operationId":"DeleteConfigFeatureForMobility","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker CLI Add On > Config-write"}},"/v1/feature-profile/mobility/global":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Mobility Global Feature Profiles","operationId":"GetMobilityGlobalFeatureProfile","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"referenceCount","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker-read"}},"/v1/feature-profile/mobility/global/basic/schema":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get a Mobility Global Basic Parcel Schema by Schema Type","operationId":"GetMobilityGlobalBasicParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/mobility/global/basic/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/mobility/global/basic/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-read"}},"/v1/feature-profile/mobility/global/{globalId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get a Mobility Global Feature Profile by profileId","operationId":"GetMobilityFeatureProfileByGlobalId","parameters":[{"name":"globalId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker-read"}},"/v1/feature-profile/mobility/global/{globalId}/qos":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Qos Feature for Global feature profile","operationId":"GetQosFeatureForGlobal","parameters":[{"name":"globalId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalQosPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalQosExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Qos-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a Qos Feature for Global feature profile","operationId":"CreateQosFeatureForGlobal","parameters":[{"name":"globalId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Qos Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-11"},"examples":{"AonQoSParcelConfig":{"$ref":"#/components/examples/AonQoSParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Qos-write"}},"/v1/feature-profile/mobility/global/{globalId}/qos/{qosId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Qos Feature by parcelId for Global feature profile","operationId":"GetQosFeatureByParcelIdForGlobal","parameters":[{"name":"globalId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"qosId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalQosPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalQosExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Qos-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Qos Feature for Global feature profile","operationId":"EditQosFeatureForGlobal","parameters":[{"name":"globalId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"qosId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Qos Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-11"},"examples":{"AonQoSParcelConfig":{"$ref":"#/components/examples/AonQoSParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Qos-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Qos Feature for Global feature profile","operationId":"DeleteQosFeatureForGlobal","parameters":[{"name":"globalId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"qosId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Qos-write"}},"/v1/feature-profile/mobility/global/{profileId}/aaaservers":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get aaaservers Profile Parcels for Mobility Global Feature Profile","operationId":"GetAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalAaaserversPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalAaaserversExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a aaaservers Profile Parcel for Mobility Global Feature Profile","operationId":"CreateAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"aaaservers Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-12"},"examples":{"AonAAAServersParcelConfig":{"$ref":"#/components/examples/AonAAAServersParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-write"}},"/v1/feature-profile/mobility/global/{profileId}/aaaservers/{aaaserversId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get aaaservers Profile Parcel by parcelId for Mobility Global Feature Profile","operationId":"GetAaaServersProfileParcelByParcelIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaserversId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalAaaserversPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalAaaserversExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a aaaservers Profile Parcel for Mobility Global Feature Profile","operationId":"EditAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaserversId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"aaaservers Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-13"},"examples":{"AonAAAServersParcelConfig":{"$ref":"#/components/examples/examples-AonAAAServersParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a aaaservers Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteAaaServersProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaserversId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > AaaServers-write"}},"/v1/feature-profile/mobility/global/{profileId}/basic":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Basic Profile Parcels for Mobility Global Feature Profile","operationId":"GetBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalBasicPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalBasicExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a Basic Profile Parcel for Mobility Global Feature Profile","operationId":"CreateBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-14"},"examples":{"AonBasicParcelConfig":{"$ref":"#/components/examples/AonBasicParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-write"}},"/v1/feature-profile/mobility/global/{profileId}/basic/{parcelId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Basic Profile Parcel by parcelId for Mobility Global Feature Profile","operationId":"GetBasicProfileParcelByParcelIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"parcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalBasicPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalBasicExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Basic Profile Parcel for Mobility Global Feature Profile","operationId":"EditBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"parcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-15"},"examples":{"AonBasicParcelConfig":{"$ref":"#/components/examples/AonBasicParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Basic Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteBasicProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"parcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Basic-write"}},"/v1/feature-profile/mobility/global/{profileId}/cellular":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility Cellular Profile Parcel list for Mobility Global Feature Profile","operationId":"GetCellularProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalCellularPayload"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729307062},"data":[{"parcelId":"8b698d5b-be6e-47bd-8567-1e5087b4b8d9","parcelType":"cellular","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729253148,"lastUpdatedOn":1628729253148,"payload":{"id":"1","name":"ATTSingleSimPap","variables":null,"simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none","userName":null,"password":null}],"dataProfileIdList":[1],"attachProfile":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none","userName":null,"password":null}],"dataProfileIdList":[1],"attachProfile":1},"primarySlot":1,"wanConfig":null,"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"cellular"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an cellular Profile Parcel for Mobility Global Feature Profile","operationId":"CreateCellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CellularProfile"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"type":"cellular","simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"primarySlot":1,"id":"1","name":"ATTSingleSimPap"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/cellular/{cellularId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility Cellular Profile Parcel for Mobility Global Feature Profile","operationId":"GetCellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalCellularPayload"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"type":"cellular","simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"primarySlot":1,"id":"1","name":"ATTSingleSimPap"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Cellular Profile Parcel for Mobility Global Feature Profile","operationId":"EditCellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cellular"},"examples":{"Cellular Profile Parcel For Mobility Global Feature Profile":{"description":"Cellular Profile Parcel For Mobility Global Feature Profile","value":{"type":"cellular","simSlot0":{"carrierName":"AT&T","slotNumber":0,"profileList":[{"id":1,"apn":"att-apn1","pdnType":"IPv4","authMethod":"pap","userName":"att1","password":"admin1"},{"id":2,"apn":"att-apn11","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"simSlot1":{"carrierName":"AT&T","slotNumber":1,"profileList":[{"id":1,"apn":"att-apn2","pdnType":"IPv4","authMethod":"chap","userName":"att2","password":"admin2"},{"id":2,"apn":"att-apn22","pdnType":"IPv6","authMethod":"none"}],"dataProfileIdList":[1],"attachProfileId":1},"primarySlot":1,"id":"1","name":"ATTSingleSimPap"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Cellular Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteACellularProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Cellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/esimcellular":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get EsimCellular Profile Features for Mobility Global Feature Profile","operationId":"GetEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalEsimcellularPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalEsimcellularExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a EsimCellular Profile Feature for Mobility Global Feature Profile","operationId":"CreateEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-16"},"examples":{"AON_CG1_eSim_Cellular_Profile_Feature1":{"$ref":"#/components/examples/AON_CG1_eSim_Cellular_Profile_Feature1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/esimcellular/{esimCellularId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get EsimCellular Profile Feature by Feature Id for Mobility Global Feature Profile","operationId":"GetEsimCellularProfileFeatureByEsimCellularIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalEsimcellularPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalEsimcellularExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a EsimCellular Profile Feature for Mobility Global Feature Profile","operationId":"EditEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-17"},"examples":{"AON_CG1_eSim_Cellular_Profile_Feature1":{"$ref":"#/components/examples/AON_CG1_eSim_Cellular_Profile_Feature1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a EsimCellular Profile Feature for Mobility Global Feature Profile","operationId":"DeleteEsimCellularProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > eSimCellular-write"}},"/v1/feature-profile/mobility/global/{profileId}/ethernet":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Ethernet Profile Parcels for feature profile","operationId":"GetEthernetProfileParcels","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalEthernetPayload"},"examples":{"Ethernet Profile Parcel For Mobility Global Feature Profile":{"description":"Ethernet Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","portType":"WAN","wanConfiguration":"Active","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"5.5.5.5"},{"interfaceName":"GigabitEthernet0/1","portType":"LAN","adminState":"enabled","corporateLan":true},{"interfaceName":"GigabitEthernet0/2","portType":"LAN","adminState":"disabled"}],"parcelType":"ethernet","subparcels":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an ethernet Profile Parcel for Mobility Global Feature Profile","operationId":"CreateEthernetProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ethernet"},"examples":{"Ethernet Profile Parcel For Aon Feature Profile":{"description":"Ethernet Profile Parcel For Aon Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","portType":"WAN","wanConfiguration":"Active","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"5.5.5.5"},{"interfaceName":"GigabitEthernet0/1","portType":"LAN","adminState":"enabled","corporateLan":true},{"interfaceName":"GigabitEthernet0/2","portType":"LAN","adminState":"disabled"}],"parcelType":"ethernet","subparcels":[]}]}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"ethernetId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-write"}},"/v1/feature-profile/mobility/global/{profileId}/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Ethernet Profile Parcels for feature profile","operationId":"GetEthernetProfileParcel","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Ethernet Profile Parcel For Mobility Global Feature Profile":{"description":"Ethernet Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","portType":"WAN","wanConfiguration":"Active","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"5.5.5.5"},{"interfaceName":"GigabitEthernet0/1","portType":"LAN","adminState":"enabled","corporateLan":true},{"interfaceName":"GigabitEthernet0/2","portType":"LAN","adminState":"disabled"}],"parcelType":"ethernet","subparcels":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Ethernet Profile Parcel for feature profile","operationId":"EditEthernetProfileParcelForSystem","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ethernet Profile Parcel","content":{"application/json":{"schema":{"type":"string"},"examples":{"Ethernet Profile Parcel For Mobility Global Feature Profile":{"description":"Ethernet Profile Parcel For Mobility Global Feature Profile","value":{"type":"ethernet","ethernetInterfaceList":[{"interfaceName":"GigabitEthernet0/0","wanConfiguration":"Active","portType":"WAN","ipAssignment":"static","staticIpAddress":"1.1.1.2","staticIpAddressSubnetMask":"255.255.0.0","staticRouteIp":"3.3.3.3"},{"interfaceName":"GigabitEthernet0/1","adminState":"enabled"},{"interfaceName":"GigabitEthernet0/2","adminState":"disabled"}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Ethernet Profile Parcel for feature profile","operationId":"DeleteEthernetProfileParcelForSystem","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Ethernet-write"}},"/v1/feature-profile/mobility/global/{profileId}/logging":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Logging Profile Features for Mobility Global Feature Profile","operationId":"GetLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalLoggingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalLoggingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a Logging Profile Feature for Mobility Global Feature Profile","operationId":"CreateLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-18"},"examples":{"AON_CG1_MOBILITY_Logging_parcel1":{"$ref":"#/components/examples/AON_CG1_MOBILITY_Logging_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-write"}},"/v1/feature-profile/mobility/global/{profileId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Logging Profile Feature by parcelId for Mobility Global Feature Profile","operationId":"GetLoggingProfileFeatureByFeatureIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalLoggingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalLoggingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a Logging Profile Feature for Mobility Global Feature Profile","operationId":"EditLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-19"},"examples":{"AON_CG1_MOBILITY_Logging_parcel1":{"$ref":"#/components/examples/AON_CG1_MOBILITY_Logging_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Logging Profile Feature for Mobility Global Feature Profile","operationId":"DeleteLoggingProfileFeatureForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Logging-write"}},"/v1/feature-profile/mobility/global/{profileId}/networkProtocol":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility NetworkProtocol Profile Parcel list for Mobility Global Feature Profile","operationId":"GetNetworkProtocolProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalNetworkprotocolPayload"},"examples":{"NetworkProtocol Profile Parcel For Mobility Global Feature Profile":{"description":"NetworkProtocol Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729936548},"data":[{"parcelId":"4e958a77-03dc-4558-a45b-eeba554bb873","parcelType":"networkProtocol","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729896431,"lastUpdatedOn":1628729896431,"payload":{"id":null,"name":null,"variables":null,"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":2,"startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DNSSettings":"1.1.1.1","NTPInherit":false,"NTPSettings":["1.1.1.1","1.1.1.2"],"DHCPOptions":[{"type":2,"dhcpValue":"2","dataType":"integer"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test","interface":"Cellular1/0"}],"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"networkProtocol"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an NetworkProtocol Profile Parcel for Mobility Global Feature Profile","operationId":"CreateNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NetworkProtocol Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkProtocol"},"examples":{"NetworkProtocol Profile Parcel For Mobility Global Feature Profile":{"description":"NetworkProtocol Profile Parcel For Mobility Global Feature Profile","value":{"type":"networkProtocol","DNSSettings":"1.1.1.1","NTPInherit":false,"NTPSettings":["1.1.1.1","1.1.1.2"],"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":"2","startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DHCPOptions":[{"type":2,"dataType":"integer","dhcpValue":"2"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-write"}},"/v1/feature-profile/mobility/global/{profileId}/networkProtocol/{networkProtocolId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility NetworkProtocol Profile Parcel for Mobility Global Feature Profile","operationId":"GetNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"networkProtocolId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalNetworkprotocolPayload"},"examples":{"NetworkProtocol Profile Parcel For Mobility Global Feature Profile":{"description":"NetworkProtocol Profile Parcel For Mobility Global Feature Profile","value":{"type":"networkProtocol","DNSSettings":"1.1.1.1","NTPInherit":false,"NTPSettings":["1.1.1.1","1.1.1.2"],"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":"2","startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DHCPOptions":[{"type":2,"dataType":"integer","dhcpValue":"2"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Network Protocol Profile Parcel for Mobility Global Feature Profile","operationId":"EditNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"networkProtocolId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Network Protocol Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkProtocol"},"examples":{"Network Protocol Profile Parcel For Mobility Global Feature Profile":{"description":"Network Protocol Profile Parcel For Mobility Global Feature Profile","value":{"type":"networkProtocol","DNSSettings":"1.1.1.1","NTPInherit":true,"DHCPPool":{"poolNetwork":"192.168.0.0/24","leaseTime":"2","startAddress":"1.1.1.2","endAddress":"1.1.1.3"},"DHCPOptions":[{"type":2,"dataType":"integer","dhcpValue":"2"}],"NATRules":[{"protocol":"udp","outPort":23,"inPort":2,"insideIp":"1.1.1.1","description":"test"}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Network Protocol Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteNetworkProtocolProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"networkProtocolId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > NetworkProtocol-write"}},"/v1/feature-profile/mobility/global/{profileId}/securityPolicy":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility SecurityPolicy Profile Parcel list for Mobility Global Feature Profile","operationId":"GetSecurityPolicyProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalSecuritypolicyPayload"},"examples":{"SecurityPolicy Profile Parcel For Mobility Global Feature Profile":{"description":"SecurityPolicy Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729560981},"data":[{"parcelId":"b79d5ede-263f-4229-aa9b-7b6581058c50","parcelType":"securityPolicy","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729517699,"lastUpdatedOn":1628729517699,"payload":{"policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}],"type":"securityPolicy"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an SecurityPolicy Profile Parcel for Mobility Global Feature Profile","operationId":"CreateSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SecurityPolicy Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityPolicy"},"examples":{"SecurityPolicy Profile Parcel For Mobility Global Feature Profile":{"description":"SecurityPolicy Profile Parcel For Mobility Global Feature Profile","value":{"type":"securityPolicy","policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-write"}},"/v1/feature-profile/mobility/global/{profileId}/securityPolicy/{securityPolicyId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Mobility SecurityPolicy Profile Parcel for Mobility Global Feature Profile","operationId":"GetSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalSecuritypolicyPayload"},"examples":{"SecurityPolicy Profile Parcel For Mobility Global Feature Profile":{"description":"SecurityPolicy Profile Parcel For Mobility Global Feature Profile","value":{"type":"securityPolicy","policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Security Policy Profile Parcel for Mobility Global Feature Profile","operationId":"EditSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Policy Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityPolicy"},"examples":{"Security Policy Profile Parcel For Mobility Global Feature Profile":{"description":"Security Policy Profile Parcel For Mobility Global Feature Profile","value":{"type":"securityPolicy","policyName":"security-policy","defaultAction":"pass","policyRules":[{"protocolType":["tcp","udp"],"sourceIp":"10.10.1.2/32","destIp":"10.10.10.1/32","sourcePort":2000,"destPort":3000,"action":"pass"},{"protocolType":["icmp"],"sourceIp":"11.11.1.1/32","destIp":"11.11.2.2/32","action":"drop"},{"protocolType":["tcp"],"sourceIp":"12.12.1.1/32","destIp":"12.12.5.1/32","sourcePort":4000,"destPort":5000,"action":"pass"}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a Security Policy Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteSecurityPolicyProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > SecurityPolicy-write"}},"/v1/feature-profile/mobility/global/{profileId}/vpn":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get VPN Profile Parcels for Mobility Global Feature Profile","operationId":"GetVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListMobilityGlobalVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"CreateVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-20"},"examples":{"AonVPNParcelConfig":{"$ref":"#/components/examples/AonVPNParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-write"}},"/v1/feature-profile/mobility/global/{profileId}/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get VPN Profile Parcel by parcelId for Mobility Global Feature Profile","operationId":"GetVpnProfileParcelByParcelIdForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleMobilityGlobalVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Update a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"EditVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VPN Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-21"},"examples":{"AonVPNParcelConfig":{"$ref":"#/components/examples/AonVPNParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete a VPN Profile Parcel for Mobility Global Feature Profile","operationId":"DeleteVpnProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Vpn-write"}},"/v1/feature-profile/mobility/global/{profileId}/wifi":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get Wifi Profile Parcel List for Mobility feature profile","operationId":"GetWifiProfileParcelListForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListMobilityGlobalWifiPayload"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"header":{"generatedOn":1628729177130},"data":[{"parcelId":"70c55c19-5043-4c6f-9b64-d710ee174bfd","parcelType":"wifi","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628729108424,"lastUpdatedOn":1628729108424,"payload":{"id":null,"name":null,"ssid0":{"ssid":"myWIFI","security":"WLAN_VAP_SECURITY_WPA","password":"mypasswd","qosSettings":"WLAN_QOS_BEST_EFFORT","visibility":true},"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_NONE","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1","encryptionKey":"B1C2DE1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1WPA2","encryptionKey":"A4B5EA1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_8021X","wpaEncryptionMode":"WPA2","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"}}},"variables":null,"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"wifi"}},{"parcelId":"ef215fe9-af7f-4fa1-83c5-0d1e281749a0","parcelType":"wifi","createdBy":"admin","lastUpdatedBy":"admin","createdOn":1628716782903,"lastUpdatedOn":1628716782903,"payload":{"id":null,"name":null,"ssid0":{"ssid":"myWIFI","security":"WLAN_VAP_SECURITY_WPA","password":"mypasswd","qosSettings":"WLAN_QOS_BEST_EFFORT","visibility":true},"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_NONE","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1","encryptionKey":"B1C2DE1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_WPA","wpaEncryptionMode":"WPA1WPA2","encryptionKey":"A4B5EA1","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WLAN_VAP_SECURITY_8021X","wpaEncryptionMode":"WPA2","encryptionKey":"","encryptionType":"cipherAES","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":11,"transmitPower":1,"channelWidth":"RADIO_CHANNEL_WIDTH_AUTO"}}},"variables":null,"lastUpdatedBy":null,"lastUpdatedOn":null,"createdBy":null,"createdOn":null,"type":"wifi"}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-read"},"post":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Create an Wifi Profile Parcel for Mobility feature profile","operationId":"CreateWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wifi Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wifi"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"OPEN","wpaPskKey":"","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"B1C2DE1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A4B5EA1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WPA2-Enterprise","wpaPskKey":"","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":"11","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":"36","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"}}},"parcelType":"wifi","subparcels":[]}]}]}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post response example":{"description":"post response example","value":{"parcelId":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-write"}},"/v1/feature-profile/mobility/global/{profileId}/wifi/{wifiId}":{"get":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Get an Wifi Profile Parcel for Mobility feature profile","operationId":"GetWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wifiId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleMobilityGlobalWifiPayload"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"OPEN","wpaPskKey":"","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"B1C2DE1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A4B5EA1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WPA2-Enterprise","wpaPskKey":"","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":"11","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":"36","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"}}},"parcelType":"wifi","subparcels":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-read"},"put":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Edit an Wifi Profile Parcel for Mobility feature profile","operationId":"EditWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wifiId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wifi Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wifi"},"examples":{"Wifi Profile Parcel For Mobility Global Feature Profile":{"description":"Wifi Profile Parcel For Mobility Global Feature Profile","value":{"name":"config_grp_test","description":"config_grp_test","family":"aon","featureprofiles":[{"profileName":"config_grp_test_aon","description":"","profileType":"aon","parcels":[{"ssidConfigList":[{"ssid":"myssid1","visibility":true,"securityAuthType":"OPEN","wpaPskKey":"","qosSettings":"WLAN_QOS_VIDEO"},{"ssid":"myssid2","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"B1C2DE1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid3","visibility":true,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A4B5EA1","qosSettings":"WLAN_QOS_BEST_EFFORT"},{"ssid":"myssid4","visibility":true,"securityAuthType":"WPA2-Enterprise","wpaPskKey":"","qosSettings":"WLAN_QOS_BEST_EFFORT","radiusServer":[{"host":"1.2.3.4","port":1812,"secret":"secret1"},{"host":"5.6.7.8","port":1814,"secret":"secret2"}]}],"guestWifi":{"ssid":"Guest123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60"},"corporateWifi":{"ssid":"Corporate123","visibility":false,"securityAuthType":"WPA2-PSK_AES","wpaPskKey":"A2BC3ED","encryptionType":"cipherAES","wpaEncryptionMode":"WPA2","validityPeriod":"60","corporateWlan":true},"advancedRadioSetting":{"countryRegionSettings":{"countryRegion":"United State","regulatoryDomain":"REG_DOMAIN_A"},"channelPowerSettings":{"radioBand2Dot4Ghz":{"band":"RADIO_2_DOT_4_GHZ","channel":"11","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"},"radioBand5Ghz":{"band":"RADIO_5_GHZ","channel":"36","transmitPower":"1","channelWidth":"RADIO_CHANNEL_WIDTH_20_MHZ"}}},"parcelType":"wifi","subparcels":[]}]}]}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-write"},"delete":{"tags":["Configuration - Feature Profile (Mobility)"],"description":"Delete an Wifi Profile Parcel for Mobility feature profile","operationId":"DeleteWifiProfileParcelForMobility","parameters":[{"name":"profileId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wifiId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Teleworker > Wifi-write"}},"/v1/feature-profile/nfvirtual/cli":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual CLI Feature Profiles","operationId":"GetAllNfvirtualCLIFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListNfvirtualCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListNfvirtualCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-read"},"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a Nfvirtual CLI Feature Profile","operationId":"CreateNfvirtualCLIFeatureProfile","requestBody":{"description":"Nfvirtual Feature profile for CLI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-write"}},"/v1/feature-profile/nfvirtual/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get nfvirtual CLI Feature Profile with cliId","operationId":"GetNfvirtualCLIFeatureProfileByid","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Nfvirtual CLI Feature Profile","operationId":"EditNfvirtualCLIFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nfvirtual Feature profile fo CLI","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete nfvirtual CLI Feature Profile","operationId":"DeleteNfvirtualCLIFeatureProfile","parameters":[{"name":"cliId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On-write"}},"/v1/feature-profile/nfvirtual/cli/{cliId}/config":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create CLI Profile Parcel for CLI feature profile","operationId":"CreateNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"CLI Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-24"},"examples":{"CliConfigParcel1":{"$ref":"#/components/examples/examples-CliConfigParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-write"}},"/v1/feature-profile/nfvirtual/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get CLI Profile Parcels for CLI feature profile","operationId":"getNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit CLI Profile Parcel for CLI feature profile","operationId":"EditNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"CLI Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-24"},"examples":{"CliConfigParcel1":{"$ref":"#/components/examples/examples-CliConfigParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete CLI Profile Parcel for CLI feature profile","operationId":"DeleteNfvirtualCLIParcel","parameters":[{"name":"cliId","in":"path","description":"CLI Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual CLI Add On > Cli-write"}},"/v1/feature-profile/nfvirtual/networks":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual Feature Profiles","operationId":"GetAllNfvirtualNetworksFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","required":true,"schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Pagination limit","required":true,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListNfvirtualNetworksPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListNfvirtualNetworksExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a nfvirtual Networks Feature Profile","operationId":"CreateNfvirtualNetworksFeatureProfile","requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/networks/ovsnetwork/{networkId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual OVS Networks Feature Profile with networkId","operationId":"GetAllNfvirtualOvsNetworksFeatureProfileByProfileId","parameters":[{"name":"networkId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","required":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksOvsnetworkPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksOvsnetworkExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"}},"/v1/feature-profile/nfvirtual/networks/{networkId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get a Nfvirtual Networks Feature Profile with networkId","operationId":"GetNfvirtualNetworksFeatureProfileByProfileId","parameters":[{"name":"networkId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","required":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Nfvirtual Networks Feature Profile","operationId":"EditNfvirtualNetworksFeatureProfile","parameters":[{"name":"networkId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Nfvirtual Networks Feature Profile","operationId":"DeleteNfvirtualNetworksFeatureProfile","parameters":[{"name":"networkId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/lan":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create LAN Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"LAN config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-26"},"examples":{"LANParcelGlobalDefault":{"$ref":"#/components/examples/LANParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/lan/{lanId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get LAN Profile Parcels for Networks feature profile","operationId":"GetNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"lanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksLanPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksLanExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a LAN Profile Parcel for networks feature profile","operationId":"EditNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"lanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"LAN Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-27"},"examples":{"LANParcelGlobalDefault":{"$ref":"#/components/examples/examples-LANParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a LAN Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualLANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"lanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Lan-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/ovsnetwork":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create OVS Network Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OVS Network Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-28"},"examples":{"NetworkParcelGlobalDefault":{"$ref":"#/components/examples/NetworkParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/ovsnetwork/{ovsNetworkId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get OVS Network Profile Parcels for Networks feature profile","operationId":"GetNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ovsNetworkId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksOvsnetworkPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksOvsnetworkExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a OVS Network Profile Parcel for Networks feature profile","operationId":"EditNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ovsNetworkId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OVS Network Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-25"},"examples":{"NetworkParcelGlobalDefault":{"$ref":"#/components/examples/NetworkParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a OVS Network Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualOVSNetworkParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ovsNetworkId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Ovsnetwork-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/routes":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Routes Profile config for Networks feature profile","operationId":"CreateNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routes config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-29"},"examples":{"RoutesParcelGlobalDefault":{"$ref":"#/components/examples/RoutesParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/routes/{routesId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Routes Profile Parcels for Networks feature profile","operationId":"GetNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"routesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksRoutesPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksRoutesExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Routes Profile Parcel for networks feature profile","operationId":"EditNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"routesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routes Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-30"},"examples":{"RoutesParcelGlobalDefault":{"$ref":"#/components/examples/RoutesParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete Routes Profile config for Networks feature profile","operationId":"DeleteNfvirtualRoutesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"routesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Routes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/switch":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Switch Profile config for Networks feature profile","operationId":"CreateNfvirtualSwitchParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Switch config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-31"},"examples":{"SwitchParcelGlobalDefault":{"$ref":"#/components/examples/SwitchParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Switch-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/switch/{switchId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Switch Profile Parcels for Networks feature profile","operationId":"GetNfvirtualSwitchParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksSwitchPayload"},"examples":{"get response example":{"description":"get response example","value":{"payload":{"name":"switch","description":"","data":{"interfaces":[{"interface_name":{"optionType":"global","value":"gigabitEthernet1/0"},"vlan":{"optionType":"global","value":"255-257"},"mode":{"optionType":"global","value":"trunk"},"native_vlan":{"optionType":"global","value":1}}]}}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Switch-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Switch Profile Parcel for networks feature profile","operationId":"EditNfvirtualSwitchParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Switch Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-32"},"examples":{"SwitchParcelGlobalDefault":{"$ref":"#/components/examples/SwitchParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Switch-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete Switch Profile config for Networks feature profile","operationId":"DeleteNfvirtualSwitchParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Switch-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create VNF Attributes Profile config for Networks feature profile","operationId":"CreateNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF Attributes config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-33"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get VNF Attributes Profile Parcels for Networks feature profile","operationId":"GetNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksVnfAttributesPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksVnfAttributesExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a VNF Attributes Profile Parcel for networks feature profile","operationId":"EditNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF Attributes Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-34"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete VNF Attributes Profile config for Networks feature profile","operationId":"DeleteNfvirtualVNFAttributesParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}/vnf":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create VNF Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-35"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/vnf-attributes/{vnfAttributesId}/vnf/{vnfId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get VNF Profile Parcels for Networks feature profile","operationId":"GetNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"vnfId","in":"path","description":"VNF Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksVnfAttributesVnfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksVnfAttributesVnfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a VNF Profile Parcel for networks feature profile","operationId":"EditNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"vnfId","in":"path","description":"VNF Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"VNF Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-36"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a VNF Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualVNFParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vnfAttributesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"vnfId","in":"path","description":"VNF Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Vnf attributes > Vnf-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/wan":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a WAN Profile Parcel for Networks feature profile","operationId":"CreateNfvirtualWanParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WAN config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-37"},"examples":{"WANInterfaceParcelGlobalDefault":{"$ref":"#/components/examples/WANInterfaceParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-write"}},"/v1/feature-profile/nfvirtual/networks/{networksId}/wan/{wanId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get WAN Profile Parcels for Networks feature profile","operationId":"GetNfvirtualWANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualNetworksWanPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualNetworksWanExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a WAN Profile Parcel for networks feature profile","operationId":"EditNfvirtualWANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WAN Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-38"},"examples":{"WANInterfaceParcelGlobalDefault":{"$ref":"#/components/examples/WANInterfaceParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a WAN Profile Parcel for Networks feature profile","operationId":"DeleteNfvirtualWANParcel","parameters":[{"name":"networksId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual Networks > Wan-write"}},"/v1/feature-profile/nfvirtual/system":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get all Nfvirtual System Feature Profiles","operationId":"GetAllNfvirtualSystemFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListNfvirtualSystemPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListNfvirtualSystemExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create a nfvirtual System Feature Profile","operationId":"CreateNfvirtualSystemFeatureProfile","requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get a Nfvirtual System Feature Profile with systemId","operationId":"GetNfvirtualSystemFeatureProfileByProfileId","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Nfvirtual System Feature Profile","operationId":"EditNfvirtualSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nfvirtual Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Nfvirtual System Feature Profile","operationId":"DeleteNfvirtualSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/aaa":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create AAA Profile Parcel for System feature profile","operationId":"CreateNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"AAA config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-39"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/aaa/{aaaId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get AAA Profile Parcels for System feature profile","operationId":"GetNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemAaaPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemAaaExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a AAA Profile Parcel for System feature profile","operationId":"EditNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"AAA Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-40"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a AAA Profile Parcel for System feature profile","operationId":"DeleteNfvirtualAAAParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Aaa-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/banner":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Banner Profile Parcel for System feature profile","operationId":"CreateNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-41"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/banner/{bannerId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Banner Profile Parcels for System feature profile","operationId":"GetNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemBannerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemBannerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Banner Profile Parcel for System feature profile","operationId":"EditNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-42"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Banner Profile Parcel for System feature profile","operationId":"DeleteNfvirtualBannerParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Banner-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/logging":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create Logging Profile Parcel for System feature profile","operationId":"CreateNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-43"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get Logging Profile Parcels for System feature profile","operationId":"GetNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemLoggingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemLoggingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a Logging Profile Parcel for System feature profile","operationId":"EditNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-44"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a Logging Profile Parcel for System feature profile","operationId":"DeleteNfvirtualLoggingParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Logging-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/ntp":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create NTP Profile Parcel for System feature profile","operationId":"CreateNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NTP config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-45"},"examples":{"NtpParcelGlobalDefault":{"$ref":"#/components/examples/NtpParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/ntp/{ntpId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get NTP Profile Parcels for System feature profile","operationId":"GetNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemNtpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemNtpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a NTP Profile Parcel for System feature profile","operationId":"EditNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"NTP Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-46"},"examples":{"NtpParcelGlobalDefault":{"$ref":"#/components/examples/NtpParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a NTP Profile Parcel for System feature profile","operationId":"DeleteNfvirtualNTPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Ntp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/snmp":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create SNMP Profile Parcel for System feature profile","operationId":"CreateNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SNMP config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-47"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault-2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/snmp/{snmpId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get SNMP Profile Parcels for System feature profile","operationId":"GetNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemSnmpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemSnmpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a SNMP Profile Parcel for System feature profile","operationId":"EditNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SNMP Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-48"},"examples":{"[parcelType]ParcelGlobalDefault":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-[parcelType]ParcelGlobalDefault-2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete a SNMP Profile Parcel for System feature profile","operationId":"DeleteNfvirtualSNMPParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > Snmp-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/system-settings":{"post":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Create System settings Profile Parcel for System feature profile","operationId":"CreateNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"System Settings config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-49"},"examples":{"SystemSettingsParcelGlobalDefault":{"$ref":"#/components/examples/SystemSettingsParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-write"}},"/v1/feature-profile/nfvirtual/system/{systemId}/system-settings/{systemSettingsId}":{"get":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Get System Settings Profile Parcels for System feature profile","operationId":"GetNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"systemSettingsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleNfvirtualSystemSystemSettingsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleNfvirtualSystemSystemSettingsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-read"},"put":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Edit a System Settings Profile Parcel for System feature profile","operationId":"EditNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"systemSettingsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"System Settings Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-50"},"examples":{"SystemSettingsParcelGlobalDefault":{"$ref":"#/components/examples/SystemSettingsParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-write"},"delete":{"tags":["Configuration - Feature Profile (NFVirtual)"],"description":"Delete System settings Profile Parcel for System feature profile","operationId":"DeleteNfvirtualSystemSettingsParcel","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"systemSettingsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Nfvirtual System > System Settings-write"}},"/v1/feature-profile/sd-routing":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Feature Profiles","operationId":"GetSdroutingFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On-read"}},"/v1/feature-profile/sd-routing/cli":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing CLI Feature Profiles","operationId":"GetSdroutingCliFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing CLI Feature Profile","operationId":"CreateSdroutingCliFeatureProfile","requestBody":{"description":"SD-Routing CLI Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On-write"}},"/v1/feature-profile/sd-routing/cli/features":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"GetSdroutingFeatureProfilesByFamilyAndType","operationId":"Get","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"featureType","in":"query","description":"feature type","schema":{"type":"string","default":"config"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-read"}},"/v1/feature-profile/sd-routing/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing CLI Feature Profile","operationId":"GetSdroutingCliFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Cli Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing CLI Feature Profile","operationId":"EditSdroutingCliFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Cli Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing CLI Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing CLI Feature Profile","operationId":"DeleteSdroutingCliFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Cli Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On-write"}},"/v1/feature-profile/sd-routing/cli/{cliId}/config":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing CLI Add-On Features for CLI Feature Profile","operationId":"GetSdroutingCLIAddOnFeatures","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Config-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing CLI Add-On Feature for CLI Feature Profile","operationId":"CreateSdroutingCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing CLI Add-On Feature for CLI Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-51"},"examples":{"CliAddOnFeature1":{"$ref":"#/components/examples/CliAddOnFeature1"},"CliAddOnFeature2":{"$ref":"#/components/examples/CliAddOnFeature2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Config-write"}},"/v1/feature-profile/sd-routing/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing CLI Add-On Feature for CLI Feature Profile","operationId":"GetSdroutingCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Config Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Config-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing CLI Add-On Feature for CLI Feature Profile","operationId":"EditSdroutingCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Config Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing CLI Add-On Feature for CLI Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-52"},"examples":{"CliAddOnFeature1":{"$ref":"#/components/examples/CliAddOnFeature1"},"CliAddOnFeature2":{"$ref":"#/components/examples/CliAddOnFeature2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Config-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing CLI Add-On Feature for CLI Feature Profile","operationId":"DeleteSdroutingCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Config Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Config-write"}},"/v1/feature-profile/sd-routing/cli/{cliId}/full-config":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the CLI Configuration by CLI profile ID","operationId":"GetSdroutingCliConfigGroupFeatures","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingCliFullConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingCliFullConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Full Config-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing CLI Configuration Group","operationId":"CreateSdroutingCliConfigGroupFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing CLI Configuration Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-53"},"examples":{"CliFullConfigFeature":{"$ref":"#/components/examples/CliFullConfigFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Full Config-write"}},"/v1/feature-profile/sd-routing/cli/{cliId}/full-config/{fullConfigId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the CLI Configuration by CLI profile ID and Config Feature ID","operationId":"GetSdroutingCliConfigGroupFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}},{"name":"fullConfigId","in":"path","description":"Full Config Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingCliFullConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingCliFullConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Full Config-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing CLI Configuration Group","operationId":"EditSdroutingCliConfigGroupFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}},{"name":"fullConfigId","in":"path","description":"Full Config Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing CLI Configuration Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-54"},"examples":{"CliFullConfigFeature":{"$ref":"#/components/examples/CliFullConfigFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Full Config-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing CLI Configuration Group","operationId":"DeleteSdroutingCliConfigGroupFeature","parameters":[{"name":"cliId","in":"path","description":"Cli Profile ID","required":true,"schema":{"type":"string"}},{"name":"fullConfigId","in":"path","description":"Full Config Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Full Config-write"}},"/v1/feature-profile/sd-routing/cli/{cliId}/ios-config":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"SD-Routing Ios Classic CLI Add-On Features for CLI Feature Profile for GET requests","operationId":"GetSdroutingIosCLassicCLIAddOnFeatures","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingCliIosConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingCliIosConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Ios Config-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"SD-Routing Ios Classic CLI Add-On Feature for CLI Feature Profile for POST requests","operationId":"CreateSdroutingIosClassicCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ios Classic CLI Add-On Feature for CLI Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-55"},"examples":{"SdRoutingIosClassicCliFeature":{"$ref":"#/components/examples/SdRoutingIosClassicCliFeature"},"SdRoutingIosClassicCliFeature1":{"$ref":"#/components/examples/SdRoutingIosClassicCliFeature1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Ios Config-write"}},"/v1/feature-profile/sd-routing/cli/{cliId}/ios-config/{iosConfigId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"SD-Routing Ios Classic CLI Add-On Feature for CLI Feature Profile for GET requests","operationId":"GetSdroutingIosClassicCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"iosConfigId","in":"path","description":"Ios Config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingCliIosConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingCliIosConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Ios Config-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"SD-Routing Ios Classic CLI Add-On Feature for CLI Feature Profile for PUT requests","operationId":"EditSdroutingIosClassicCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"iosConfigId","in":"path","description":"Ios Config ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ios Classic CLI Add-On Feature for CLI Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-55"},"examples":{"SdRoutingIosClassicCliFeature":{"$ref":"#/components/examples/SdRoutingIosClassicCliFeature"},"SdRoutingIosClassicCliFeature1":{"$ref":"#/components/examples/SdRoutingIosClassicCliFeature1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Ios Config-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ios Classic CLI Add-On Feature for CLI Feature Profile","operationId":"DeleteSdroutingIosClassicCLIAddOnFeature","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"iosConfigId","in":"path","description":"Ios Config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing CLI Add On > Ios Config-write"}},"/v1/feature-profile/sd-routing/embedded-security":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get all SD-ROUTING Feature Profiles with giving Family and profile type","operationId":"GetSdRoutingEmbeddedSecurityFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"referenceCount","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingEmbeddedSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingEmbeddedSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security-read"},"post":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Create a SD-ROUTING Embedded Security Feature Profile","operationId":"CreateSdRoutingEmbeddedSecurityFeatureProfile","requestBody":{"description":"SD-ROUTING Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security-write"}},"/v1/feature-profile/sd-routing/embedded-security/{embeddedSecurityId}":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get a SD-ROUTING Embedded Security Feature Profile with embeddedSecurityId","operationId":"GetSdRoutingEmbeddedSecurityFeatureProfileByProfileId","parameters":[{"name":"embeddedSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","schema":{"type":"boolean","default":false}},{"name":"references","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingEmbeddedSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingEmbeddedSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security-read"},"put":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Edit a SD-ROUTING Embedded Security Feature Profile","operationId":"EditSdRoutingEmbeddedSecurityFeatureProfile","parameters":[{"name":"embeddedSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-ROUTING Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security-write"},"delete":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Delete Feature Profile","operationId":"DeleteSdRoutingEmbeddedSecurityFeatureProfile","parameters":[{"name":"embeddedSecurityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security-write"}},"/v1/feature-profile/sd-routing/embedded-security/{securityId}/policy":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get Security Features for a given FeatureType","operationId":"GetSecurityFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingEmbeddedSecurityPolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingEmbeddedSecurityPolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-read"},"post":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Create Feature for Security Policy","operationId":"CreateEmbeddedSecurityFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-56"},"examples":{"PolicyFeatureGlobalDefault":{"$ref":"#/components/examples/PolicyFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"}},"/v1/feature-profile/sd-routing/embedded-security/{securityId}/policy/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get Security Feature by FeatureId","operationId":"GetSecurityFeatureByFeatureId","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingEmbeddedSecurityPolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingEmbeddedSecurityPolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-read"},"put":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Update a Security Feature","operationId":"EditSecurityFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-57"},"examples":{"PolicyFeatureGlobalDefault":{"$ref":"#/components/examples/PolicyFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Delete a Security Feature ","operationId":"DeleteSecurityFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"}},"/v1/feature-profile/sd-routing/embedded-security/{securityId}/unified/ngfirewall":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get Ngfirewall Feature","operationId":"GetNgfirewallFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingEmbeddedSecurityUnifiedNgfirewallPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingEmbeddedSecurityUnifiedNgfirewallExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-read"},"post":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Create Parcel for Ngfirewall Policy","operationId":"CreateNgfirewallFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ngfirewall Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-58"},"examples":{"ngfirewallFeatureGlobalDefault":{"$ref":"#/components/examples/ngfirewallFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"}},"/v1/feature-profile/sd-routing/embedded-security/{securityId}/unified/ngfirewall/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get Ngfirewall Feature by FeatureId","operationId":"GetNgfirewallFeatureByFeatureId","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingEmbeddedSecurityUnifiedNgfirewallPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingEmbeddedSecurityUnifiedNgfirewallExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-read"},"put":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Update a Ngfirewall Feature","operationId":"EditNgfirewallFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ngfirewall Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-59"},"examples":{"ngfirewallFeatureGlobalDefault":{"$ref":"#/components/examples/ngfirewallFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"},"delete":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Delete a Ngfirewall Feature ","operationId":"DeleteNgfirewallFeature","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"}},"/v1/feature-profile/sd-routing/other/{otherId}/cybervision":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Cybervision Profile feature for Other feature profile","operationId":"GetCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingOtherCybervisionPayload"},"examples":{"SD-Routing Other Cybervision Feature Get (all) Response Example":{"description":"SD-Routing Other Cybervision Feature Get (all) Response Example","value":"{\n \"parcelId\": \"a024a740-16cd-4907-b283-762ad7b08a11\",\n \"parcelType\": \"cybervision\",\n \"createdBy\": \"admin\",\n \"lastUpdatedBy\": \"admin\",\n \"createdOn\": 1715709906807,\n \"lastUpdatedOn\": 1715719025500,\n \"payload\": {\n \"name\": \"CyberVisionGETExample\",\n \"description\": \"Cybervision feature for Other\",\n \"data\": {\n \"virtualApplication\": {\n \"captureInterfaceIP\": {\n \"optionType\": \"default\"\n },\n \"captureInterfaceSubnetMask\": {\n \"optionType\": \"default\"\n },\n \"collectionInterfaceIP\": {\n \"optionType\": \"default\",\n },\n \"collectionInterfaceSubnetMask\": {\n \"optionType\": \"default\",\n },\n \"multipleErspanSourceInterfaces\": [\n {\n \"optionType\": \"global\",\n \"value\": \"GigabitEthernet0/0/0\"\n },\n {\n \"optionType\": \"global\",\n \"value\": \"Vlan30\"\n }\n ],\n \"virtualPortGroup5Ip\": {\n \"optionType\": \"default\",\n },\n \"virtualPortGroup6Ip\": {\n \"optionType\": \"default\"\n },\n \"cvcId\": {\n \"optionType\": \"global\",\n \"value\": \"bae78380-9a39-494c-b75d-c9b3e00c124e\"\n }\n }\n }\n }\n}"},"get response example":{"$ref":"#/components/examples/getListSdRoutingOtherCybervisionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Other > Cyber Vision-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a Cybervision Profile feature for Other feature profile","operationId":"CreateCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cybervision Profile feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-60"},"examples":{"cybervisionFeatureGlobalDefault":{"$ref":"#/components/examples/cybervisionFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Other > Cyber Vision-write"}},"/v1/feature-profile/sd-routing/other/{otherId}/cybervision/{cybervisionId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Cybervision Profile feature by FeatureId for Other feature profile","operationId":"GetCybervisionProfileFeatureByFeatureIdForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cybervisionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingOtherCybervisionPayload"},"examples":{"SD-Routing Other Cybervision Feature Get (by id) Response Example":{"description":"SD-Routing Other Cybervision Feature Get (by id) Response Example","value":"{\n \"parcelId\": \"a024a740-16cd-4907-b283-762ad7b08a11\",\n \"parcelType\": \"cybervision\",\n \"createdBy\": \"admin\",\n \"lastUpdatedBy\": \"admin\",\n \"createdOn\": 1715709906807,\n \"lastUpdatedOn\": 1715719025500,\n \"payload\": {\n \"name\": \"CyberVisionGETExample\",\n \"description\": \"Cybervision feature for Other\",\n \"data\": {\n \"virtualApplication\": {\n \"captureInterfaceIP\": {\n \"optionType\": \"default\"\n },\n \"captureInterfaceSubnetMask\": {\n \"optionType\": \"default\"\n },\n \"collectionInterfaceIP\": {\n \"optionType\": \"default\",\n },\n \"collectionInterfaceSubnetMask\": {\n \"optionType\": \"default\",\n },\n \"multipleErspanSourceInterfaces\": [\n {\n \"optionType\": \"global\",\n \"value\": \"GigabitEthernet0/0/0\"\n },\n {\n \"optionType\": \"global\",\n \"value\": \"Vlan30\"\n }\n ],\n \"virtualPortGroup5Ip\": {\n \"optionType\": \"default\",\n },\n \"virtualPortGroup6Ip\": {\n \"optionType\": \"default\"\n },\n \"cvcId\": {\n \"optionType\": \"global\",\n \"value\": \"bae78380-9a39-494c-b75d-c9b3e00c124e\"\n }\n }\n }\n }\n}"},"get response example":{"$ref":"#/components/examples/getSingleSdRoutingOtherCybervisionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Other > Cyber Vision-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Update a Cybervision Profile feature for Other feature profile","operationId":"EditCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cybervisionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cybervision Profile feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-60"},"examples":{"cybervisionFeatureGlobalDefault":{"$ref":"#/components/examples/cybervisionFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Other > Cyber Vision-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a Cybervision Profile feature for Other feature profile","operationId":"DeleteCybervisionProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cybervisionId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Other > Cyber Vision-write"}},"/v1/feature-profile/sd-routing/service":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Service Feature Profiles","operationId":"GetSdroutingServiceFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServicePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Service Feature Profile","operationId":"CreateSdroutingServiceFeatureProfile","requestBody":{"description":"SD-Routing Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Service Feature Profile","operationId":"GetSdroutingServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","description":"Service Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServicePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Service Feature Profile","operationId":"EditSdroutingServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","description":"Service Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Service Feature Profile","operationId":"DeleteSdroutingServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","description":"Service Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing DHCP Server features in service feature profile","operationId":"GetSdroutingDhcpServerProfileParcels","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > DHCP Server-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing DHCP Server feature in service feature profile","operationId":"CreateSdroutingDhcpServerProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing DHCP Server feature in service feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-61"},"examples":{"DhcpServer":{"$ref":"#/components/examples/DhcpServer"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > DHCP Server-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing DHCP Server feature in service feature profile","operationId":"GetSdroutingDhcpServerProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DHCP Server Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > DHCP Server-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing DHCP Server feature in service feature profile","operationId":"EditSdroutingDhcpServerProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DHCP Server Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing DHCP Server feature in service feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-62"},"examples":{"DhcpServer":{"$ref":"#/components/examples/DhcpServer"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > DHCP Server-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing DHCP Server feature in service feature profile","operationId":"DeleteSdroutingDhcpServerProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DHCP Server Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > DHCP Server-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/ipsec-profile":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing IPSec Profile Features for Service Feature Profile","operationId":"GetSdroutingServiceIpsecProfileFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceIpsecProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceIpsecProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > IPSec Profile-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing IPSec Profile Feature for Service Feature Profile","operationId":"CreateSdroutingServiceIpsecProfileFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing IPSec Profile Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-63"},"examples":{"IpsecProfileWithGroupPskAuthType":{"$ref":"#/components/examples/IpsecProfileWithGroupPskAuthType"},"IpsecProfileWithEnterpriseCaAuthType":{"$ref":"#/components/examples/IpsecProfileWithEnterpriseCaAuthType"},"IpsecProfileWithPerPeerPskAuthType":{"$ref":"#/components/examples/IpsecProfileWithPerPeerPskAuthType"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > IPSec Profile-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/ipsec-profile/{ipsecProfileId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing IPSec Profile Feature for Service Feature Profile","operationId":"GetSdroutingServiceIpsecProfileFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipsecProfileId","in":"path","description":"IPSec Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceIpsecProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceIpsecProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > IPSec Profile-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing IPSec Profile Feature for Service Feature Profile","operationId":"EditSdroutingServiceIpsecProfileFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipsecProfileId","in":"path","description":"IPSec Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing IPSec Profile Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-63"},"examples":{"IpsecProfileWithGroupPskAuthType":{"$ref":"#/components/examples/IpsecProfileWithGroupPskAuthType"},"IpsecProfileWithEnterpriseCaAuthType":{"$ref":"#/components/examples/IpsecProfileWithEnterpriseCaAuthType"},"IpsecProfileWithPerPeerPskAuthType":{"$ref":"#/components/examples/IpsecProfileWithPerPeerPskAuthType"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > IPSec Profile-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing IPSec Profile Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceIpsecProfileFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipsecProfileId","in":"path","description":"IPSec Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > IPSec Profile-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/ipv4-acl":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Ipv4 Acl Features for Service Feature Profile","operationId":"GetSdroutingServiceIpv4AclFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceIpv4AclPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceIpv4AclExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > ACL-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ipv4 Acl Feature for Service Feature Profile","operationId":"CreateSdroutingServiceIpv4AclFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ipv4 Acl Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-64"},"examples":{"StandardIPv4ACL":{"$ref":"#/components/examples/StandardIPv4ACL"},"ExtendedIPv4ACL":{"$ref":"#/components/examples/ExtendedIPv4ACL"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > ACL-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/ipv4-acl/{ipv4AclId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ipv4 Acl Feature for Service Feature Profile","operationId":"GetSdroutingServiceIpv4AclFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv4AclId","in":"path","description":"IPv4 ACL Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceIpv4AclPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceIpv4AclExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > ACL-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ipv4 Acl Feature for Service Feature Profile","operationId":"EditSdroutingServiceIpv4AclFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv4AclId","in":"path","description":"IPv4 ACL Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ipv4 Acl Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-64"},"examples":{"StandardIPv4ACL":{"$ref":"#/components/examples/StandardIPv4ACL"},"ExtendedIPv4ACL":{"$ref":"#/components/examples/ExtendedIPv4ACL"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > ACL-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ipv4 Acl Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceIpv4AclFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv4AclId","in":"path","description":"IPv4 ACL Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > ACL-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/multicloud-connection":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Multicloud Connection Profile Parcels for Service feature profile","operationId":"GetListOfProfileParcels","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfLanMulticloudConnectionPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfLanMulticloudConnectionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > MultiCloudConnection-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a MultiCloudConnection Parcel for service feature profile","operationId":"CreateMultiCloudConnection","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"MultiConnection Extension Payload for defining the multicloud connection to the cloud gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-65"},"examples":{"sd-routing-multi-cloud-connectionParcelGlobalDefault":{"$ref":"#/components/examples/sd-routing-multi-cloud-connectionParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > MultiCloudConnection-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/multicloud-connection/{multiCloudConnectionId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a multicloud connection parcel","operationId":"GetMultiCloudConnection","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multiCloudConnectionId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfLanMulticloudConnectionPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfLanMulticloudConnectionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > MultiCloudConnection-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Update a multicloud connection parcel","operationId":"EditMultiCloudConnection","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multiCloudConnectionId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud Connection Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-66"},"examples":{"sd-routing-multi-cloud-connectionParcelGlobalDefault":{"$ref":"#/components/examples/examples-sd-routing-multi-cloud-connectionParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > MultiCloudConnection-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a MultiCloud Connection Profile Parcel for Service feature profile","operationId":"DeleteMultiCloudConnectionParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multiCloudConnectionId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > MultiCloudConnection-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/objecttracker":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Object Tracker Features for Service Feature Profile","operationId":"GetSdroutingServiceObjectTrackerFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceObjecttrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceObjecttrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Object Tracker Feature for Service Feature Profile","operationId":"CreateSdroutingServiceObjectTrackerFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-67"},"examples":{"InterfaceObjectTracker":{"$ref":"#/components/examples/InterfaceObjectTracker"},"RouteObjectTracker":{"$ref":"#/components/examples/RouteObjectTracker"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/objecttracker/{objectTrackerId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Object Tracker Feature for Service Feature Profile","operationId":"GetSdroutingServiceObjectTrackerFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerId","in":"path","description":"Object Tracker Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceObjecttrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceObjecttrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Object Tracker Feature for Service Feature Profile","operationId":"EditSdroutingServiceObjectTrackerFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerId","in":"path","description":"Object Tracker Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-67"},"examples":{"InterfaceObjectTracker":{"$ref":"#/components/examples/InterfaceObjectTracker"},"RouteObjectTracker":{"$ref":"#/components/examples/RouteObjectTracker"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Object Tracker Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceObjectTrackerFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerId","in":"path","description":"Object Tracker Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/objecttrackergroup":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Object Tracker Group Features for Service Feature Profile","operationId":"GetSdroutingServiceObjectTrackerGroupFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceObjecttrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceObjecttrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Object Tracker Group Feature for Service Feature Profile","operationId":"CreateSdroutingServiceObjectTrackerGroupFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Group Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-68"},"examples":{"ObjectTrackerGroupWithAndCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithAndCondition"},"ObjectTrackerGroupWithOrCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithOrCondition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker Group-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/objecttrackergroup/{objectTrackerGroupId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Object Tracker Group Feature for Service Feature Profile","operationId":"GetSdroutingServiceObjectTrackerGroupFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerGroupId","in":"path","description":"Object Tracker Group Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceObjecttrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceObjecttrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Object Tracker Group Feature for Service Feature Profile","operationId":"EditSdroutingServiceObjectTrackerGroupFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerGroupId","in":"path","description":"Object Tracker Group Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Group Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-68"},"examples":{"ObjectTrackerGroupWithAndCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithAndCondition"},"ObjectTrackerGroupWithOrCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithOrCondition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Object Tracker Group Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceObjectTrackerGroupFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerGroupId","in":"path","description":"Object Tracker Group Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Object Tracker Group-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/route-policy":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Route Policy Features for Service Feature Profile","operationId":"GetSdroutingServiceRoutePolicyFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceRoutePolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceRoutePolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Route Policy-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Route Policy Feature for Service Feature Profile","operationId":"CreateSdroutingServiceRoutePolicyFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Route Policy Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-69"},"examples":{"IPv4RoutePolicy":{"$ref":"#/components/examples/IPv4RoutePolicy"},"IPv6RoutePolicy":{"$ref":"#/components/examples/IPv6RoutePolicy"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Route Policy-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/route-policy/{routePolicyId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Route Policy Feature for Service Feature Profile","operationId":"GetSdroutingServiceRoutePolicyFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"routePolicyId","in":"path","description":"Route Policy Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceRoutePolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceRoutePolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Route Policy-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Route Policy Feature for Service Feature Profile","operationId":"EditSdroutingServiceRoutePolicyFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"routePolicyId","in":"path","description":"Route Policy Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Route Policy Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-69"},"examples":{"IPv4RoutePolicy":{"$ref":"#/components/examples/IPv4RoutePolicy"},"IPv6RoutePolicy":{"$ref":"#/components/examples/IPv6RoutePolicy"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Route Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Route Policy Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceRoutePolicyFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"routePolicyId","in":"path","description":"Route Policy Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > Route Policy-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing LAN OSPF Features for service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfOspfFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing LAN OSPF Feature for service VRF in Service Feature Profile","operationId":"CreateSdroutingServiceVrfOspfFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN OSPF Feature for service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-70"},"examples":{"RoutingOspfFeature":{"$ref":"#/components/examples/RoutingOspfFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing LAN OSPF Feature for service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfOspfFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing LAN OSPF Feature for service VRF in Service Feature Profile","operationId":"EditSdroutingServiceVrfOspfFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN OSPF Feature for service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-70"},"examples":{"RoutingOspfFeature":{"$ref":"#/components/examples/RoutingOspfFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing LAN OSPF Feature for service VRF in Service Feature Profile","operationId":"DeleteSdroutingServiceVrfOspfFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing LAN OSPFv3 IPv4 Features for service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfOspfv3Ipv4Features","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv4-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing LAN OSPFv3 IPv4 Feature for service VRF in Service Feature Profile","operationId":"CreateSdroutingServiceVrfOspfv3Ipv4Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN OSPFv3 IPv4 Feature for service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-71"},"examples":{"OSPFv3IPv4AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithGlobalValue"},"OSPFv3IPv4AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv4-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing LAN OSPFv3 IPv4 Feature for service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfOspfv3Ipv4Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 OSPFv3 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv4-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing LAN OSPFv3 IPv4 Feature for service VRF in Service Feature Profile","operationId":"EditSdroutingServiceVrfOspfv3Ipv4Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 OSPFv3 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN OSPFv3 IPv4 Feature for service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-71"},"examples":{"OSPFv3IPv4AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithGlobalValue"},"OSPFv3IPv4AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv4-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing LAN OSPFv3 IPv4 Feature for service VRF in Service Feature Profile","operationId":"DeleteSdroutingServiceVrfOspfv3Ipv4Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 OSPFv3 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv4-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing LAN OSPFv3 IPv6 Features for Service Feature Profile","operationId":"GetSdroutingServiceVrfOspfv3Ipv6Features","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv6-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing LAN OSPFv3 IPv6 Feature for Service Feature Profile","operationId":"CreateSdroutingServiceVrfOspfv3Ipv6Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN OSPFv3 IPv6 Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-72"},"examples":{"OSPFv3IPv6AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithGlobalValue"},"OSPFv3IPv6AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv6-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing LAN OSPFv3 IPv6 Feature for Service Feature Profile","operationId":"GetSdroutingServiceVrfOspfv3Ipv6Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv6-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing LAN OSPFv3 IPv6 Feature for Service Feature Profile","operationId":"EditSdroutingServiceVrfOspfv3Ipv6Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN OSPFv3 IPv6 Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-72"},"examples":{"OSPFv3IPv6AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithGlobalValue"},"OSPFv3IPv6AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv6-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing LAN OSPFv3 IPv6 Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceVrfOspfv3Ipv6Feature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > OSPFv3 IPv6-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing VRF Features for Service Feature Profile","operationId":"GetSdroutingServiceVRFFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing VRF Feature for Service Feature Profile","operationId":"CreateSdroutingServiceVRFFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" VRF Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-73"},"examples":{"PaymentProcessingNetworkVRF":{"$ref":"#/components/examples/PaymentProcessingNetworkVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing LAN BGP Features for service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfBgpFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > BGP-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing LAN BGP Feature for service VRF in Service Feature Profile","operationId":"CreateSdroutingServiceVrfBgpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN BGP Feature for service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-74"},"examples":{"BgpForVrf":{"$ref":"#/components/examples/BgpForVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > BGP-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing LAN BGP Feature for service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfBgpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > BGP-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing LAN BGP Feature for service VRF in Service Feature Profile","operationId":"EditSdroutingServiceVrfBgpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing LAN BGP Feature for service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-74"},"examples":{"BgpForVrf":{"$ref":"#/components/examples/BgpForVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > BGP-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing LAN BGP Feature for service VRF in Service Feature Profile","operationId":"DeleteSdroutingServiceVrfBgpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > BGP-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/routing/eigrp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing VRF EIGRP Features for Service Feature Profile","operationId":"GetSdroutingServiceVrfEigrpFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > EIGRP-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing VRF EIGRP Feature for Service Feature Profile","operationId":"CreateSdroutingServiceVrfEigrpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing VRF EIGRP Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-75"},"examples":{"eigrp1":{"$ref":"#/components/examples/eigrp1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > EIGRP-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/routing/eigrp/{eigrpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing VRF EIGRP Feature for Service Feature Profile","operationId":"GetSdroutingServiceVrfEigrpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"EIGRP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > EIGRP-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing VRF EIGRP Feature for Service Feature Profile","operationId":"EditSdroutingServiceVrfEigrpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"EIGRP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing VRF EIGRP Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-75"},"examples":{"eigrp1":{"$ref":"#/components/examples/eigrp1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > EIGRP-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing VRF EIGRP Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceVrfEigrpFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"EIGRP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > EIGRP-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing VRF Feature for Service Feature Profile","operationId":"GetSdroutingServiceVRFFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing VRF Feature for Service Feature Profile","operationId":"EditSdroutingServiceVRFFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" VRF Feature for Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-73"},"examples":{"PaymentProcessingNetworkVRF":{"$ref":"#/components/examples/PaymentProcessingNetworkVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing VRF Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceVRFFeature","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/dmvpn-tunnel":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all VRF DMVPN Tunnel Features for Service Feature Profile","operationId":"GetSdroutingServiceVRFDmvpnTunnelFeaturesForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfLanDmvpnTunnelPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfLanDmvpnTunnelExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > DMVPN Tunnel-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing VRF DMVPN Tunnel Feature for Service Feature Profile","operationId":"CreateSdroutingServiceVRFDmvpnTunnelFeatureForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing VRF DMVPN Tunnel Feature Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-76"},"examples":{"DMVPNHubAndSpoke":{"$ref":"#/components/examples/DMVPNHubAndSpoke"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > DMVPN Tunnel-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/dmvpn-tunnel/{tunnelId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing VRF DMVPN Tunnel Feature by tunnelId for Service Feature Profile","operationId":"GetSdroutingServiceVRFDmvpnTunnelFeatureByFeatureIdForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"DMVPN Tunnel Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfLanDmvpnTunnelPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfLanDmvpnTunnelExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > DMVPN Tunnel-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing VRF DMVPN Tunnel Feature for Service Feature Profile","operationId":"EditSdroutingServiceVRFDmvpnTunnelFeatureForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"DMVPN Tunnel Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing VRF DMVPN Tunnel Feature Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-76"},"examples":{"DMVPNHubAndSpoke":{"$ref":"#/components/examples/DMVPNHubAndSpoke"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > DMVPN Tunnel-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing VRF DMVPN Tunnel Feature for Service Feature Profile","operationId":"DeleteSdroutingServiceVRFDmvpnTunnelFeatureForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"DMVPN Tunnel Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > DMVPN Tunnel-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all Ethernet interface features for VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfInterfaceEthernetParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfLanInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfLanInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ethernet interface feature for VRF in Service Feature Profile","operationId":"CreateSdroutingServiceVrfInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ethernet interface feature for VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-77"},"examples":{"EthernetInterfaceForLanVrf":{"$ref":"#/components/examples/EthernetInterfaceForLanVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ethernet interface feature for VRF by ethernetId in Service Feature Profile","operationId":"GetSdroutingServiceVrfInterfaceEthernetParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfLanInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfLanInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ethernet interface feature for VRF in Service Feature Profile","operationId":"EditSdroutingServiceVrfInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ethernet interface feature for VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-77"},"examples":{"EthernetInterfaceForLanVrf":{"$ref":"#/components/examples/EthernetInterfaceForLanVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ethernet interface feature for VRF in Service Feature Profile","operationId":"DeleteSdroutingServiceVrfInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/interface/ethernet/{ethernetId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get VRF Interface Ethernet feature associated DHCP Server feature for service feature profile","operationId":"GetVrfInterfaceEthernetAssociatedDhcpServerParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfInterfaceEthernetDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfInterfaceEthernetDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a SD-Routing VRF Interface Ethernet feature with a DHCP Server feature for service feature profile","operationId":"CreateVrfInterfaceEthernetAndDhcpServerParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing DHCP Server feature for VRF Interface in service feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get VRF Interface Ethernet feature associated DHCP Server feature for service feature profile","operationId":"GetVrfInterfaceEthernetAssociatedDhcpServerParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DHCP Server feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfInterfaceEthernetDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfInterfaceEthernetDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Update a SD-Routing VRF Interface Ethernet feature and a DHCP Server feature association for service feature profile","operationId":"EditVrfInterfaceEthernetAndDhcpServerParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DHCP Server feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing DHCP Server feature for VRF Interface in service feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a VRF Interface Ethernet feature and a DHCP Server feature association for service feature profile","operationId":"DeleteVrfInterfaceEthernetAndDhcpServerAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DHCP Server feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all Ipsec Interface Features for Service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfInterfaceIpsecFeaturesForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Service VRF feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfLanInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfLanInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/IPSec-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ipsec Interface Feature for Service VRF in Service Feature Profile","operationId":"CreateSdroutingServiceVrfInterfaceIpsecFeatureForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Service VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" Ipsec Interface Feature for Service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-80"},"examples":{"IPSecInterfaceWithIPv4OverIPv4IKEv1":{"$ref":"#/components/examples/IPSecInterfaceWithIPv4OverIPv4IKEv1"},"IPSecInterfaceWithIPv6OverIPv6IKEv1":{"$ref":"#/components/examples/IPSecInterfaceWithIPv6OverIPv6IKEv1"},"IPSecInterfaceWithIPv6OverIPv4IKEv2":{"$ref":"#/components/examples/IPSecInterfaceWithIPv6OverIPv4IKEv2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/IPSec-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ipsec Interface Feature for Service VRF in Service Feature Profile","operationId":"GetSdroutingServiceVrfInterfaceIpsecFeatureByFeatureIdForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Service VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Ipsec Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfLanInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfLanInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/IPSec-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ipsec Interface Feature for Service VRF in Service Feature Profile","operationId":"EditSdroutingServiceVrfInterfaceIpsecFeatureForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Service VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Ipsec Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" Ipsec Interface Feature for Service VRF in Service Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-80"},"examples":{"IPSecInterfaceWithIPv4OverIPv4IKEv1":{"$ref":"#/components/examples/IPSecInterfaceWithIPv4OverIPv4IKEv1"},"IPSecInterfaceWithIPv6OverIPv6IKEv1":{"$ref":"#/components/examples/IPSecInterfaceWithIPv6OverIPv6IKEv1"},"IPSecInterfaceWithIPv6OverIPv4IKEv2":{"$ref":"#/components/examples/IPSecInterfaceWithIPv6OverIPv4IKEv2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/IPSec-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ipsec Interface Feature for Service VRF in Service Feature Profile","operationId":"DeleteSdroutingServiceVrfInterfaceIpsecFeatureForService","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Service VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Ipsec Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF > Interface/IPSec-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the LAN VRF associated BGP Features for service feature profile","operationId":"GetServiceVrfAssociatedRoutingBgpFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a BGP feature with the LAN VRF feature for service feature profile","operationId":"CreateServiceVrfAndRoutingBgpFeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New BGP feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get VRF parcel associated RoutingBGP Parcel by bgpId for service feature profile","operationId":"GetServiceVrfAssociatedRoutingBgpParcelByParcelId","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the BGP feature for LAN VRF feature in service feature profile","operationId":"EditServiceVrfAndRoutingBgpFeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Old BGP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New BGP feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the LAN VRF feature and BGP feature association for service feature profile","operationId":"DeleteServiceVrfAndRoutingBgpAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/eigrp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the LAN VRF associated EIGRP Features for service feature profile","operationId":"GetServiceVrfAssociatedRoutingEigrpFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfVrfRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfVrfRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a EIGRP feature with the LAN VRF feature for service feature profile","operationId":"CreateServiceVrfAndRoutingEigrpFeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New EIGRP feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/eigrp/{eigrpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the LAN VRF associated EIGRP feature by ID for service feature profile","operationId":"GetServiceVrfAssociatedRoutingEigrpFeatureByFeatureId","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"EIGRP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfVrfRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfVrfRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the EIGRP feature for LAN VRF feature in service feature profile","operationId":"EditServiceVrfAndRoutingEigrpFeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Old EIGRP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New EIGRP feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the LAN VRF feature and EIGRP feature association for service feature profile","operationId":"DeleteServiceVrfAndRoutingEigrpAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"EIGRP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the VRF associated OSPF features for service feature profile","operationId":"GetServiceVrfAssociatedRoutingOspfFeatures","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPF feature with the LAN VRF feature for service feature profile","operationId":"CreateServiceVrfAndRoutingOspfParcelAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPF Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the LAN VRF associated OSPF feature by ID for service feature profile","operationId":"GetServiceVrfAssociatedRoutingOspfFeatureById","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPF feature for LAN VRF feature in service feature profile","operationId":"EditServiceVrfAndRoutingOspfFeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Old OSPF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPF Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the LAN VRF feature and OSPF feature association in service feature profile","operationId":"DeleteServiceVrfAndRoutingOspfAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get LAN VRF associated OSPFv3 IPv4 features for service feature profile","operationId":"GetServiceVrfAssociatedRoutingOspfv3Ipv4Features","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPFv3 IPv4 feature with the LAN VRF feature for service feature profile","operationId":"CreateServiceVrfAndRoutingOspfv3Ipv4FeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OSPFv3 IPv4 feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the VRF feature associated OSPFv3 IPv4 feature by ID for service feature profile","operationId":"GetServiceVrfAssociatedRoutingOspfv3Ipv4FeatureById","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPFv3 IPv4 feature for LAN VRF feature in service feature profile","operationId":"EditServiceVrfAndRoutingOspfv3Ipv4FeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Old OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Input the new OSPFv3 IPv4 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the VRF feature and OSPFv3 IPv4 feature association for service feature profile","operationId":"DeleteServiceVrfAndRoutingOspfv3Ipv4Association","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the LAN VRF associated OSPFv3 IPv6 features for service feature profile","operationId":"GetServiceVrfAssociatedRoutingOspfv3Ipv6Parcels","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingServiceVrfRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingServiceVrfRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPFv3 IPv6 feature with the LAN VRF feature for service feature profile","operationId":"CreateServiceVrfAndRoutingOspfv3Ipv6FeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv6 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/service/{serviceId}/vrf/{vrfId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get LAN VRF associated OSPFv3 IPv6 feature by feature ID for service feature profile","operationId":"GetServiceVrfAssociatedRoutingOspfv3Ipv6FeatureById","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingServiceVrfRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingServiceVrfRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPFv3 IPv6 feature for LAN VRF feature in service feature profile","operationId":"EditServiceVrfAndRoutingOspfv3Ipv6FeatureAssociation","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Old OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv6 feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the VRF feature and OSPFv3 IPv6 feature association for service feature profile","operationId":"DeleteServiceVrfAndRoutingOspfv3Ipv6Association","parameters":[{"name":"serviceId","in":"path","description":"Service Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Service > VRF-write"}},"/v1/feature-profile/sd-routing/sse":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-ROUTING Feature Profiles with giving Family and profile type","operationId":"GetSdRoutingSseFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"referenceCount","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSsePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE-read"},"post":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Create a SD-ROUTING SSE Feature Profile","operationId":"CreateSdRoutingSseFeatureProfile","requestBody":{"description":"SD-ROUTING Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE-write"}},"/v1/feature-profile/sd-routing/sse/{sseId}":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get a SD-ROUTING SSE Feature Profile with sseId","operationId":"GetSdRoutingSseFeatureProfileByProfileId","parameters":[{"name":"sseId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"references","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSsePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE-read"},"put":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Edit a SD-ROUTING SSE Feature Profile","operationId":"EditSdRoutingSseFeatureProfile","parameters":[{"name":"sseId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-ROUTING Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete Feature Profile","operationId":"DeleteSdRoutingSseFeatureProfile","parameters":[{"name":"sseId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE-write"}},"/v1/feature-profile/sd-routing/sse/{sseId}/cisco":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get Cisco Sse feature list for Sse feature profile","operationId":"GetCiscoSseFeatureForSse","parameters":[{"name":"sseId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSseCiscoSsePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSseCiscoSseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE > Cisco SSE-read"},"post":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Create Cisco Sse feature for sse feature profile type","operationId":"CreateCiscoSseFeatureForSse","parameters":[{"name":"sseId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cisco Sse feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-81"},"examples":{"Cisco-SSE":{"$ref":"#/components/examples/Cisco-SSE"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE > Cisco SSE-write"}},"/v1/feature-profile/sd-routing/sse/{sseId}/cisco/{ciscoSseId}":{"get":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Get Cisco SSE Profile Feature by feature Id","operationId":"GetCiscoSseFeatureByFeatureIdForSSE","parameters":[{"name":"sseId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ciscoSseId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSseCiscoSsePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSseCiscoSseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE > Cisco SSE-read"},"put":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Update a Cisco Sse feature","operationId":"EditCiscoSseFeature","parameters":[{"name":"sseId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ciscoSseId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cisco Sse feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-82"},"examples":{"Cisco-SSE":{"$ref":"#/components/examples/Cisco-SSE"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE > Cisco SSE-write"},"delete":{"tags":["Configuration - Feature Profile (SD-ROUTING)"],"description":"Delete a Cisco Sse Feature ","operationId":"DeleteCiscoSseFeature","parameters":[{"name":"sseId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ciscoSseId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SSE > Cisco SSE-write"}},"/v1/feature-profile/sd-routing/system":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing System Feature Profiles","operationId":"GetSdroutingSystemFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing System Feature Profile","operationId":"CreateSdroutingSystemFeatureProfile","requestBody":{"description":"SD-Routing System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System-write"}},"/v1/feature-profile/sd-routing/system/{systemId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing System Feature Profile","operationId":"GetSdroutingSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"System Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing System Feature Profile","operationId":"EditSdroutingSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"System Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing System Feature Profile","operationId":"DeleteSdroutingSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"System Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/aaa":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing AAA Features for System Feature Profile","operationId":"GetSdroutingAaaFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemAaaSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemAaaSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > AAA-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing AAA Feature for System Feature Profile","operationId":"CreateSdroutingAaaFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing AAA Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-83"},"examples":{"SystemAAAFeatureConfig":{"$ref":"#/components/examples/SystemAAAFeatureConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > AAA-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/aaa/{aaaId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing AAA Feature for System Feature Profile","operationId":"GetSdroutingAaaFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"AAA Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemAaaSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemAaaSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > AAA-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing AAA Feature for System Feature Profile","operationId":"EditSdroutingAaaFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"AAA Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing AAA Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-83"},"examples":{"SystemAAAFeatureConfig":{"$ref":"#/components/examples/SystemAAAFeatureConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > AAA-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing AAA Feature for System Feature Profile","operationId":"DeleteSdroutingAaaFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"AAA Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > AAA-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/banner":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Banner Features for System Feature Profile","operationId":"GetSdroutingBannerFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemBannerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemBannerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Banner-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Banner Feature for System Feature Profile","operationId":"CreateSdroutingBannerFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Banner Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-84"},"examples":{"SystemBannerGlobalDefault":{"$ref":"#/components/examples/SystemBannerGlobalDefault"},"SystemBannerVariable":{"$ref":"#/components/examples/SystemBannerVariable"},"SystemBannerDefaultGlobal":{"$ref":"#/components/examples/SystemBannerDefaultGlobal"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Banner-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/banner/{bannerId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Banner Feature for System Feature Profile","operationId":"GetSdroutingBannerFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Banner Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemBannerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemBannerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Banner-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Banner Feature for System Feature Profile","operationId":"EditSdroutingBannerFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Banner Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Banner Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-85"},"examples":{"SystemBannerGlobalDefault":{"$ref":"#/components/examples/SystemBannerGlobalDefault"},"SystemBannerVariable":{"$ref":"#/components/examples/SystemBannerVariable"},"SystemBannerDefaultGlobal":{"$ref":"#/components/examples/SystemBannerDefaultGlobal"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Banner-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Banner Feature for System Feature Profile","operationId":"DeleteSdroutingBannerFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Banner Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Banner-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/certificate":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Certificate Features for System Feature Profile","operationId":"GetSdroutingCertificateFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemCertificatePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemCertificateExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Certificate-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Certificate Feature for System Feature Profile","operationId":"CreateSdroutingCertificateFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Certificate Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-86"},"examples":{"SystemCertificate":{"$ref":"#/components/examples/SystemCertificate"},"SystemScepEnrollment":{"$ref":"#/components/examples/SystemScepEnrollment"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Certificate-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/certificate/{certificateId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Certificate Feature for System Feature Profile","operationId":"GetSdroutingCertificateFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"certificateId","in":"path","description":"Certificate Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemCertificatePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemCertificateExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Certificate-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Certificate Feature for System Feature Profile","operationId":"EditSdroutingCertificateFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"certificateId","in":"path","description":"Certificate Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Certificate Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-86"},"examples":{"SystemCertificate":{"$ref":"#/components/examples/SystemCertificate"},"SystemScepEnrollment":{"$ref":"#/components/examples/SystemScepEnrollment"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Certificate-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Certificate Feature for System Feature Profile","operationId":"DeleteSdroutingCertificateFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"certificateId","in":"path","description":"Certificate Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Certificate-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/flexible-port-speed":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Flexible Port Speed Features for System Feature Profile","operationId":"GetSdroutingFlexiblePortSpeedFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemFlexiblePortSpeedPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemFlexiblePortSpeedExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Flexible Port Speed-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Flexible Port Speed Feature for System Feature Profile","operationId":"CreateSdroutingFlexiblePortSpeedFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Flexible Port Speed Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-87"},"examples":{"FlexiblePortSpeed":{"$ref":"#/components/examples/FlexiblePortSpeed"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Flexible Port Speed-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/flexible-port-speed/{flexiblePortSpeedId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Flexible Port Speed Feature for System Feature Profile","operationId":"GetSdroutingFlexiblePortSpeedFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"flexiblePortSpeedId","in":"path","description":"Flexible Port Speed Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemFlexiblePortSpeedPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemFlexiblePortSpeedExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Flexible Port Speed-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Flexible Port Speed Feature for System Feature Profile","operationId":"EditSdroutingFlexiblePortSpeedFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"flexiblePortSpeedId","in":"path","description":"Flexible Port Speed Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Flexible Port Speed Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-87"},"examples":{"FlexiblePortSpeed":{"$ref":"#/components/examples/FlexiblePortSpeed"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Flexible Port Speed-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Flexible Port Speed Feature for System Feature Profile","operationId":"DeleteSdroutingFlexiblePortSpeedFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"flexiblePortSpeedId","in":"path","description":"Flexible Port Speed Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Flexible Port Speed-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/global":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Global Setting Features for System Feature Profile","operationId":"GetSdroutingGlobalSettingFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemGlobalPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemGlobalExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Global Settings-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Global Setting Feature for System Feature Profile","operationId":"CreateSdroutingGlobalSettingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Global Setting Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-88"},"examples":{"GlobalSettings":{"$ref":"#/components/examples/GlobalSettings"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Global Settings-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/global/{globalId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Global Setting Feature for System Feature Profile","operationId":"GetSdroutingGlobalSettingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Global Setting Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemGlobalPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemGlobalExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Global Settings-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Global Setting Feature for System Feature Profile","operationId":"EditSdroutingGlobalSettingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Global Setting Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Global Setting Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-89"},"examples":{"GlobalSettings":{"$ref":"#/components/examples/GlobalSettings"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Global Settings-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Global Setting Feature for System Feature Profile","operationId":"DeleteSdroutingGlobalSettingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Global Setting Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Global Settings-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/logging":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Logging Features for System Feature Profile","operationId":"GetSdroutingLoggingFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemLoggingSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemLoggingSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Logging-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Logging Feature for System Feature Profile","operationId":"CreateSdroutingLoggingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Logging Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-90"},"examples":{"SystemLoggingExample":{"$ref":"#/components/examples/SystemLoggingExample"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Logging-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Logging Feature for System Feature Profile","operationId":"GetSdroutingLoggingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Logging Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemLoggingSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemLoggingSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Logging-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Logging Feature for System Feature Profile","operationId":"EditSdroutingLoggingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Logging Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Logging Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-90"},"examples":{"SystemLoggingExample":{"$ref":"#/components/examples/SystemLoggingExample"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Logging Feature for System Feature Profile","operationId":"DeleteSdroutingLoggingFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Logging Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > Logging-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/ntp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing NTP Features for System Feature Profile","operationId":"GetSdroutingNtpFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemNtpSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemNtpSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > NTP-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing NTP Feature for System Feature Profile","operationId":"CreateSdroutingNtpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing NTP Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-91"},"examples":{"SystemNTPConfig":{"$ref":"#/components/examples/SystemNTPConfig"},"SdroutingSystemNTPExample":{"$ref":"#/components/examples/SdroutingSystemNTPExample"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > NTP-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/ntp/{ntpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing NTP Feature for System Feature Profile","operationId":"GetSdroutingNtpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"NTP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemNtpSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemNtpSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > NTP-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing NTP Feature for System Feature Profile","operationId":"EditSdroutingNtpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"NTP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing NTP Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-91"},"examples":{"SystemNTPConfig":{"$ref":"#/components/examples/SystemNTPConfig"},"SdroutingSystemNTPExample":{"$ref":"#/components/examples/SdroutingSystemNTPExample"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > NTP-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing NTP Feature for System Feature Profile","operationId":"DeleteSdroutingNtpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"NTP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > NTP-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/snmp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing SNMP Features for System Feature Profile","operationId":"GetSdroutingSnmpFeatures","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingSystemSnmpSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingSystemSnmpSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > SNMP-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing SNMP Feature for System Feature Profile","operationId":"CreateSdroutingSnmpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing SNMP Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-92"},"examples":{"SNMPV2":{"$ref":"#/components/examples/SNMPV2"},"SNMPV3":{"$ref":"#/components/examples/SNMPV3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > SNMP-write"}},"/v1/feature-profile/sd-routing/system/{systemId}/snmp/{snmpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing SNMP Feature for System Feature Profile","operationId":"GetSdroutingSnmpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"SNMP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingSystemSnmpSdRoutingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingSystemSnmpSdRoutingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > SNMP-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing SNMP Feature for System Feature Profile","operationId":"EditSdroutingSnmpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"SNMP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing SNMP Feature for System Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-92"},"examples":{"SNMPV2":{"$ref":"#/components/examples/SNMPV2"},"SNMPV3":{"$ref":"#/components/examples/SNMPV3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > SNMP-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing SNMP Feature for System Feature Profile","operationId":"DeleteSdroutingSnmpFeature","parameters":[{"name":"systemId","in":"path","description":"System Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"SNMP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing System > SNMP-write"}},"/v1/feature-profile/sd-routing/transport":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Transport Feature Profiles","operationId":"GetSdroutingTransportFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Transport Feature Profile","operationId":"CreateSdroutingTransportFeatureProfile","requestBody":{"description":"SD-Routing Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Transport Feature Profile","operationId":"GetSdroutingTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Transport Feature Profile","operationId":"EditSdroutingTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Transport Feature Profile","operationId":"DeleteSdroutingTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Global VRF Features for Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVRFFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Global VRF Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportGlobalVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" Global VRF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-93"},"examples":{"GlobalVRF":{"$ref":"#/components/examples/GlobalVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing BGP Features for Global VRF in Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVrfBgpFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > BGP-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing BGP Feature for Global VRF in Transport Feature Profile","operationId":"CreateSdroutingTransportGlobalVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing BGP Feature for Global VRF in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-94"},"examples":{"WanBgpForGlobalVrf":{"$ref":"#/components/examples/WanBgpForGlobalVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > BGP-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing BGP Feature for Global VRF in Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > BGP-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing BGP Feature for Global VRF in Transport Feature Profile","operationId":"EditSdroutingTransportGlobalVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing BGP Feature for Global VRF in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-94"},"examples":{"WanBgpForGlobalVrf":{"$ref":"#/components/examples/WanBgpForGlobalVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > BGP-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing BGP Feature for Global VRF in Transport Feature Profile","operationId":"DeleteSdroutingTransportGlobalVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > BGP-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Global VRF Feature for Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Global VRF Feature for Transport Feature Profile","operationId":"EditSdroutingTransportGlobalVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" Global VRF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-93"},"examples":{"GlobalVRF":{"$ref":"#/components/examples/GlobalVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Global VRF Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportGlobalVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all Ethernet interface features for global VRF in Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVrfInterfaceEthernetParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfWanInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfWanInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ethernet interface feature for global VRF in Transport Feature Profile","operationId":"CreateSdroutingTransportGlobalVrfInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ethernet interface feature for global VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-95"},"examples":{"EthernetInterfaceForGlobalVrf":{"$ref":"#/components/examples/EthernetInterfaceForGlobalVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ethernet interface feature for global VRF by ethernetId in Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVrfInterfaceEthernetParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfWanInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfWanInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ethernet interface feature for global VRF in Transport Feature Profile","operationId":"EditSdroutingTransportGlobalVrfInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ethernet interface feature for global VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-95"},"examples":{"EthernetInterfaceForGlobalVrf":{"$ref":"#/components/examples/EthernetInterfaceForGlobalVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ethernet interface feature for global VRF in Transport Feature Profile","operationId":"DeleteSdroutingTransportGlobalVrfInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all Ipsec Interface Features for Global VRF in Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVrfInterfaceIpsecFeaturesForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfWanInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfWanInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/IPSec-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ipsec Interface Feature for Global VRF in Transport Feature Profile","operationId":"CreateSdroutingTransportGlobalVrfInterfaceIpsecFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" Ipsec Interface Feature for Global VRF in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-96"},"examples":{"IPSecInterfaceWithIKEv1AndIPv4OverlayOverIPv4Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv1AndIPv4OverlayOverIPv4Underlay"},"IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay"},"IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/IPSec-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ipsec Interface Feature for Global VRF in Transport Feature Profile","operationId":"GetSdroutingTransportGlobalVrfInterfaceIpsecFeatureByFeatureIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Ipsec Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfWanInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfWanInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/IPSec-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ipsec Interface Feature for Global VRF in Transport Feature Profile","operationId":"EditSdroutingTransportGlobalVrfInterfaceIpsecFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Ipsec Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" Ipsec Interface Feature for Global VRF in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-96"},"examples":{"IPSecInterfaceWithIKEv1AndIPv4OverlayOverIPv4Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv1AndIPv4OverlayOverIPv4Underlay"},"IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay"},"IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/IPSec-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ipsec Interface Feature for Global VRF in Transport Feature Profile","operationId":"DeleteSdroutingTransportGlobalVrfInterfaceIpsecFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Ipsec Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF > Interface/IPSec-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/multicloud-connection":{"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a Global VRF parcel with a Multicloud Connection Parcel for transport feature profile","operationId":"CreateTransportGlobalVrfAndMulticloudConnectionParcelAssociation","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud Connection Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-97"},"examples":{"sd-routing-multi-cloud-connectionParcelGlobalDefaultTransport":{"$ref":"#/components/examples/sd-routing-multi-cloud-connectionParcelGlobalDefaultTransport"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the global VRF associated BGP features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingBgpFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfGlobalVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfGlobalVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a BGP feature with the global VRF feature for transport feature profile","operationId":"CreateTransportGlobalVrfAndRoutingBgpFeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New BGP Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Global VRF parcel associated BGP feature by ID for transport feature profile","operationId":"GetVrfAssociatedRoutingBgpFeatureById","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfGlobalVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfGlobalVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the BGP feature for the global VRF feature in transport feature profile","operationId":"EditTransportGlobalVrfAndRoutingBgpFeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New BGP feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the global VRF and BGP feature association for transport feature profile","operationId":"DeleteTransportGlobalVrfAndRoutingBgpAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the global VRF associated OSPF features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingOspfFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPF feature with the global VRF feature for transport feature profile","operationId":"CreateTransportGlobalVrfAndRoutingOspfParcelAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPF feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the Global VRF feature associated OSPF feature by ID for transport feature profile","operationId":"GetVrfAssociatedRoutingOspfParcelByFeatureId","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPF feature for the global VRF feature in transport feature profile","operationId":"EditTransportGlobalVrfAndRoutingOspfFeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing OSPF ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPF Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the global VRF and the OSPF feature association for transport feature profile","operationId":"DeleteTransportGlobalVrfAndRoutingOspfAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the Global VRF associated OSPFv3 IPv4 features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingOspfv3Ipv4Features","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPFv3 IPv4 feature with the global VRF feature for transport feature profile","operationId":"CreateTransportGlobalVrfAndRoutingOspfv3Ipv4FeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv4 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the global VRF feature associated OSPFv3 IPv4 feature by ID for transport feature profile","operationId":"GetVrfAssociatedRoutingOspfv3Ipv4FeatureById","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPFv3 IPv4 feature for the global VRF feature in transport feature profile","operationId":"EditTransportGlobalVrfAndRoutingOspfv3Ipv4FeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Old OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv4 feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the global VRF and the OSPFv3 IPv4 feature association for transport feature profile","operationId":"DeleteTransportGlobalVrfAndRoutingOspfv3Ipv4Association","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the global VRF associated OSPFv3 IPv6 features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingOspfv3Ipv6Features","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportGlobalVrfRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportGlobalVrfRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPFv3 IPv6 feature with the global VRF feature for transport feature profile","operationId":"CreateTransportGlobalVrfAndRoutingOspfv3Ipv6ParcelAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv6 feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/global-vrf/{vrfId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the Global VRF associated OSPFv3 IPv6 feature by ID for transport feature profile","operationId":"GetVrfAssociatedRoutingOspfv3Ipv6FeatureById","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportGlobalVrfRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportGlobalVrfRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPFv3 IPv6 feature for the global VRF feature in transport feature profile","operationId":"EditTransportGlobalVrfAndRoutingOspfv3Ipv6FeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Old OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv6 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the global VRF feature and the OSPFv3 IPv6 feature association for transport feature profile","operationId":"DeleteTransportGlobalVrfAndRoutingOspfv3Ipv6Association","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Global VRF Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Global VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/ipv4-acl":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Ipv4 Acl Features for Transport Feature Profile","operationId":"GetSdroutingTransportIpv4AclFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportIpv4AclPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportIpv4AclExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > ACL-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ipv4 Acl Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportIpv4AclFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ipv4 Acl Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-64"},"examples":{"StandardIPv4ACL":{"$ref":"#/components/examples/StandardIPv4ACL"},"ExtendedIPv4ACL":{"$ref":"#/components/examples/ExtendedIPv4ACL"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > ACL-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/ipv4-acl/{ipv4AclId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ipv4 Acl Feature for Transport Feature Profile","operationId":"GetSdroutingTransportIpv4AclFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv4AclId","in":"path","description":"IPv4 ACL Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportIpv4AclPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportIpv4AclExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > ACL-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ipv4 Acl Feature for Transport Feature Profile","operationId":"EditSdroutingTransportIpv4AclFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv4AclId","in":"path","description":"Ipv4 ACL Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ipv4 Acl Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-64"},"examples":{"StandardIPv4ACL":{"$ref":"#/components/examples/StandardIPv4ACL"},"ExtendedIPv4ACL":{"$ref":"#/components/examples/ExtendedIPv4ACL"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > ACL-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ipv4 Acl Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportIpv4AclFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv4AclId","in":"path","description":"IPv4 ACL Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > ACL-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/management-vrf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Management VRF Features for Transport Feature Profile","operationId":"GetSdroutingManagementVRFFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportManagementVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportManagementVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Management VRF Feature for Transport Feature Profile","operationId":"CreateSdroutingManagementVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Management VRF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-98"},"examples":{"ManagementVRF":{"$ref":"#/components/examples/ManagementVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/management-vrf/{vrfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Management VRF Feature for Transport Feature Profile","operationId":"GetSdroutingManagementVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportManagementVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportManagementVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Management VRF Feature for Transport Feature Profile","operationId":"EditSdroutingManagementVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Management VRF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-98"},"examples":{"ManagementVRF":{"$ref":"#/components/examples/ManagementVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Management VRF Feature for Transport Feature Profile","operationId":"DeleteSdroutingManagementVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/management-vrf/{vrfId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all Management Ethernet interface features for management VRF in Transport Feature Profile","operationId":"GetSdroutingManagementVrfInterfaceEthernetParcelsForTransportProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportManagementVrfInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportManagementVrfInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF > Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Management Ethernet interface feature for management VRF in Transport Feature Profile","operationId":"CreateSdroutingManagementVrfInterfaceEthernetParcelForTransportProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Management Ethernet interface feature schema for management VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-99"},"examples":{"ManagementVrfEthernetInterface":{"$ref":"#/components/examples/ManagementVrfEthernetInterface"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/management-vrf/{vrfId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Management Ethernet interface feature for management VRF by ethernetId in Transport Feature Profile","operationId":"GetSdroutingManagementVrfInterfaceEthernetParcelByParcelIdForTransportProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Management Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportManagementVrfInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportManagementVrfInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF > Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Management Ethernet interface feature for management VRF in Transport Feature Profile","operationId":"EditSdroutingManagementVrfInterfaceEthernetParcelForTransportProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Management Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Management Ethernet interface feature schema for management VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-99"},"examples":{"ManagementVrfEthernetInterface":{"$ref":"#/components/examples/ManagementVrfEthernetInterface"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF > Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Management Ethernet interface feature for management VRF in Transport Feature Profile","operationId":"DeleteSdroutingManagementVrfInterfaceEthernetParcelForTransportProfile","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Management VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Management Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Management VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/multicloud-connection":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Lan Vpn Profile Parcels for Service feature profile","operationId":"GetLanVpnProfileParcelForService_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfWanMulticloudConnectionPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfWanMulticloudConnectionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > MultiCloudConnection-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a MultiCloudConnection Parcel for transport feature profile","operationId":"CreateMultiCloudConnection_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"MultiConnection Extension Payload for defining the multicloud connection to the cloud gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-97"},"examples":{"sd-routing-multi-cloud-connectionParcelGlobalDefaultTransport":{"$ref":"#/components/examples/sd-routing-multi-cloud-connectionParcelGlobalDefaultTransport"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > MultiCloudConnection-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/multicloud-connection/{multiCloudConnectionId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get Lan Vpn Profile Parcel by parcelId for Service feature profile","operationId":"GetLanVpnProfileParcelByParcelIdForService_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multiCloudConnectionId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfWanMulticloudConnectionPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfWanMulticloudConnectionExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > MultiCloudConnection-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Update a multicloud connection parcel","operationId":"EditMultiCloudConnection_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multiCloudConnectionId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Multicloud Connection Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-100"},"examples":{"sd-routing-multi-cloud-connectionParcelGlobalDefaultTransport":{"$ref":"#/components/examples/sd-routing-multi-cloud-connectionParcelGlobalDefaultTransport"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > MultiCloudConnection-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a MultiCloud Connection Profile Parcel for Transport feature profile","operationId":"DeleteMultiCloudConnectionParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multiCloudConnectionId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > MultiCloudConnection-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/objecttracker":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Object Tracker Features for Transport Feature Profile","operationId":"GetSdroutingTransportObjectTrackerFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportObjecttrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportObjecttrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Object Tracker Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportObjectTrackerFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-67"},"examples":{"InterfaceObjectTracker":{"$ref":"#/components/examples/InterfaceObjectTracker"},"RouteObjectTracker":{"$ref":"#/components/examples/RouteObjectTracker"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/objecttracker/{objectTrackerId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Object Tracker Feature for Transport Feature Profile","operationId":"GetSdroutingTransportObjectTrackerFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerId","in":"path","description":"Object Tracker ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportObjecttrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportObjecttrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Object Tracker Feature for Transport Feature Profile","operationId":"EditSdroutingTransportObjectTrackerFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerId","in":"path","description":"Object Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-67"},"examples":{"InterfaceObjectTracker":{"$ref":"#/components/examples/InterfaceObjectTracker"},"RouteObjectTracker":{"$ref":"#/components/examples/RouteObjectTracker"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Object Tracker Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportObjectTrackerFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerId","in":"path","description":"Object Tracker ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/objecttrackergroup":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Object Tracker Group Features for Transport Feature Profile","operationId":"GetSdroutingTransportObjectTrackerGroupFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportObjecttrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportObjecttrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Object Tracker Group Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportObjectTrackerGroupFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Group Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-68"},"examples":{"ObjectTrackerGroupWithAndCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithAndCondition"},"ObjectTrackerGroupWithOrCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithOrCondition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker Group-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/objecttrackergroup/{objectTrackerGroupId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Object Tracker Group Feature for Transport Feature Profile","operationId":"GetSdroutingTransportObjectTrackerGroupFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerGroupId","in":"path","description":"Object Tracker Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportObjecttrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportObjecttrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Object Tracker Group Feature for Transport Feature Profile","operationId":"EditSdroutingTransportObjectTrackerGroupFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerGroupId","in":"path","description":"Object Tracker Group ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Object Tracker Group Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-68"},"examples":{"ObjectTrackerGroupWithAndCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithAndCondition"},"ObjectTrackerGroupWithOrCondition":{"$ref":"#/components/examples/ObjectTrackerGroupWithOrCondition"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Object Tracker Group Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportObjectTrackerGroupFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"objectTrackerGroupId","in":"path","description":"Object Tracker Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Object Tracker Group-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/route-policy":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing Route Policy Features for Transport Feature Profile","operationId":"GetSdroutingTransportRoutePolicyFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportRoutePolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportRoutePolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Route Policy-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Route Policy Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportRoutePolicyFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Route Policy Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-69"},"examples":{"IPv4RoutePolicy":{"$ref":"#/components/examples/IPv4RoutePolicy"},"IPv6RoutePolicy":{"$ref":"#/components/examples/IPv6RoutePolicy"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Route Policy-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/route-policy/{routePolicyId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Route Policy Feature for Transport Feature Profile","operationId":"GetSdroutingTransportRoutePolicyFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"routePolicyId","in":"path","description":"Route Policy Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportRoutePolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportRoutePolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Route Policy-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Route Policy Feature for Transport Feature Profile","operationId":"EditSdroutingTransportRoutePolicyFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"routePolicyId","in":"path","description":"Route Policy Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Route Policy Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-69"},"examples":{"IPv4RoutePolicy":{"$ref":"#/components/examples/IPv4RoutePolicy"},"IPv6RoutePolicy":{"$ref":"#/components/examples/IPv6RoutePolicy"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Route Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Route Policy Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportRoutePolicyFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"routePolicyId","in":"path","description":"Route Policy Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > Route Policy-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing WAN OSPF Features for Transport Feature Profile","operationId":"GetSdroutingTransportRoutingOspfFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing WAN OSPF Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportRoutingOspfFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN OSPF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-70"},"examples":{"RoutingOspfFeature":{"$ref":"#/components/examples/RoutingOspfFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing WAN OSPF Feature for Transport Feature Profile","operationId":"GetSdroutingTransportRoutingOspfFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing WAN OSPF Feature for Transport Feature Profile","operationId":"EditSdroutingTransportRoutingOspfFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN OSPF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-70"},"examples":{"RoutingOspfFeature":{"$ref":"#/components/examples/RoutingOspfFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing WAN OSPF Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportRoutingOspfFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing WAN OSPFv3 IPv4 Features in Transport Feature Profile","operationId":"GetSdroutingTransportRoutingOspfv3Ipv4Features","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv4-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing WAN OSPFv3 IPv4 Feature in Transport Feature Profile","operationId":"CreateSdroutingTransportRoutingOspfv3Ipv4Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN OSPFv3 IPv4 Feature in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-71"},"examples":{"OSPFv3IPv4AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithGlobalValue"},"OSPFv3IPv4AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv4-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing WAN OSPFv3 IPv4 Feature in Transport Feature Profile","operationId":"GetSdroutingTransportRoutingOspfv3Ipv4Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 OSPFv3 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv4-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing WAN OSPFv3 IPv4 Feature in Transport Feature Profile","operationId":"EditSdroutingTransportRoutingOspfv3Ipv4Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 OSPFv3 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN OSPFv3 IPv4 Feature in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-71"},"examples":{"OSPFv3IPv4AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithGlobalValue"},"OSPFv3IPv4AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv4AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv4-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing WAN OSPFv3 IPv4 Feature in Transport Feature Profile","operationId":"DeleteSdroutingTransportRoutingOspfv3Ipv4Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 OSPFv3 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv4-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing WAN OSPFv3 IPv6 Features for Transport Feature Profile","operationId":"GetSdroutingTransportRoutingOspfv3Ipv6Features","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv6-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing WAN OSPFv3 IPv6 Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportRoutingOspfv3Ipv6Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN OSPFv3 IPv6 Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-72"},"examples":{"OSPFv3IPv6AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithGlobalValue"},"OSPFv3IPv6AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv6-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing WAN OSPFv3 IPv6 Feature for Transport Feature Profile","operationId":"GetSdroutingTransportRoutingOspfv3Ipv6Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv6-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing WAN OSPFv3 IPv6 Feature for Transport Feature Profile","operationId":"EditSdroutingTransportRoutingOspfv3Ipv6Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN OSPFv3 IPv6 Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-72"},"examples":{"OSPFv3IPv6AddressFamilyWithGlobalValue":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithGlobalValue"},"OSPFv3IPv6AddressFamilyWithVariables":{"$ref":"#/components/examples/OSPFv3IPv6AddressFamilyWithVariables"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv6-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing WAN OSPFv3 IPv6 Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportRoutingOspfv3Ipv6Feature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > OSPFv3 IPv6-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing VRF Features for Transport Feature Profile","operationId":"GetSdroutingTransportVRFFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing VRF Feature for Transport Feature Profile","operationId":"CreateSdroutingTransportVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" VRF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-73"},"examples":{"PaymentProcessingNetworkVRF":{"$ref":"#/components/examples/PaymentProcessingNetworkVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all SD-Routing WAN BGP features for VRF in transport feature profile","operationId":"GetSdroutingTransportVrfBgpFeatures","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > BGP-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing WAN BGP feature for VRF in transport feature profile","operationId":"CreateSdroutingTransportVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN BGP feature for VRF in transport feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-74"},"examples":{"BgpForVrf":{"$ref":"#/components/examples/BgpForVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > BGP-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing WAN BGP feature for VRF in transport feature profile","operationId":"GetSdroutingTransportVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > BGP-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing WAN BGP feature for VRF in transport feature profile","operationId":"EditSdroutingTransportVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing WAN BGP feature for VRF in transport feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-74"},"examples":{"BgpForVrf":{"$ref":"#/components/examples/BgpForVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > BGP-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing WAN BGP feature for VRF in transport feature profile","operationId":"DeleteSdroutingTransportVrfBgpFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > BGP-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing VRF Feature for Transport Feature Profile","operationId":"GetSdroutingTransportVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing VRF Feature for Transport Feature Profile","operationId":"EditSdroutingTransportVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" VRF Feature for Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-73"},"examples":{"PaymentProcessingNetworkVRF":{"$ref":"#/components/examples/PaymentProcessingNetworkVRF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing VRF Feature for Transport Feature Profile","operationId":"DeleteSdroutingTransportVRFFeature","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all Ethernet interface features for VRF in Transport Feature Profile","operationId":"GetSdroutingTransportVrfInterfaceEthernetParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfWanInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfWanInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing Ethernet interface feature for VRF in Transport Feature Profile","operationId":"CreateSdroutingTransportVrfInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ethernet interface feature for VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-101"},"examples":{"EthernetInterfaceForWanVrf":{"$ref":"#/components/examples/EthernetInterfaceForWanVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing Ethernet interface feature for VRF by ethernetId in Transport Feature Profile","operationId":"GetSdroutingTransportVrfInterfaceEthernetParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfWanInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfWanInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing Ethernet interface feature for VRF in Transport Feature Profile","operationId":"EditSdroutingTransportVrfInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SD-Routing Ethernet interface feature for VRF","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-101"},"examples":{"EthernetInterfaceForWanVrf":{"$ref":"#/components/examples/EthernetInterfaceForWanVrf"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing Ethernet interface feature for VRF in Transport Feature Profile","operationId":"DeleteSdroutingTransportVrfInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/Ethernet-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get all IPSec Interface Features for Transport VRF in Transport Feature Profile","operationId":"GetSdroutingTransportVrfInterfaceIpsecFeaturesForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfWanInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfWanInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/IPSec-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Create a SD-Routing IPSec Interface Feature for Transport VRF in Transport Feature Profile","operationId":"CreateSdroutingTransportVrfInterfaceIpsecFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" IPSec Interface Feature for Transport VRF in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-102"},"examples":{"IPSecInterfaceWithIKEv2IPv4OverlayOverIPv4Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv2IPv4OverlayOverIPv4Underlay"},"IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay":{"$ref":"#/components/examples/examples-IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay"},"IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay":{"$ref":"#/components/examples/examples-IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/IPSec-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get a SD-Routing IPSec Interface Feature for Transport VRF in Transport Feature Profile","operationId":"GetSdroutingTransportVrfInterfaceIpsecFeatureByFeatureIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"IPSec Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfWanInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfWanInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/IPSec-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Edit a SD-Routing IPSec Interface Feature for Transport VRF in Transport Feature Profile","operationId":"EditSdroutingTransportVrfInterfaceIpsecFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"IPSec Interface Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":" IPSec Interface Feature for Transport VRF in Transport Feature Profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-102"},"examples":{"IPSecInterfaceWithIKEv2IPv4OverlayOverIPv4Underlay":{"$ref":"#/components/examples/IPSecInterfaceWithIKEv2IPv4OverlayOverIPv4Underlay"},"IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay":{"$ref":"#/components/examples/examples-IPSecInterfaceWithIKEv2IPv6OverlayOverIPv6Underlay"},"IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay":{"$ref":"#/components/examples/examples-IPSecInterfaceWithIKEv1IPv6OverlayOverIPv4Underlay"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/IPSec-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete a SD-Routing IPSec Interface Feature for Transport VRF in Transport Feature Profile","operationId":"DeleteSdroutingTransportVrfInterfaceIpsecFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"Transport VRF feature ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"IPSec Interface Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF > Interface/IPSec-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the WAN VRF associated BGP features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingBgpFeatures_1","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate a BGP feature with the WAN VRF feature for transport feature profile","operationId":"CreateTransportVrfAndRoutingBgpFeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing BGP Profile feature Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the WAN VRF associated BGP feature by BGP feature ID for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingBgpById","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfVrfRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfVrfRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the BGP feature for the WAN VRF feature in transport feature profile","operationId":"EditTransportVrfAndRoutingBgpFeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Old BGP Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New BGP feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the WAN VRF and BGP association for transport feature profile","operationId":"DeleteTransportVrfAndRoutingBgpAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"BGP Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the WAN VRF associated OSPF features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingOspfFeatures_1","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPF feature with the WAN VRF feature for transport feature profile","operationId":"CreateTransportVrfAndRoutingOspfAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OSPF feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the WAN VRF associated OSPF features by feature ID for transport feature profile","operationId":"GetVrfAssociatedRoutingOspfById","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPF feature for the WAN VRF feature in transport feature profile","operationId":"EditTransportVrfAndRoutingOspfFeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Old OSPF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPF Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the VRF and OSPF feature association for transport feature profile","operationId":"DeleteTransportVrfAndRoutingOspfAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"OSPF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the VRF associated OSPFv3 IPv4 features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingOspfv3Ipv4Features_1","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPFv3 IPv4 feature with the WAN VRF feature for transport feature profile","operationId":"CreateTransportVrfAndRoutingOspfv3Ipv4Association","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OSPFv3 IPv4 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the VRF associated OSPFv3 IPv4 feature by ID for transport feature profile","operationId":"GetVrfAssociatedRoutingOspfv3Ipv4FeatureById_1","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPFv3 IPv4 feature for the WAN VRF feature in transport feature profile","operationId":"EditTransportVrfAndRoutingOspfv3Ipv4Association","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Old OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv4 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the VRF and OSPFv3 IPv4 feature association for transport feature profile","operationId":"DeleteTransportVrfAndRoutingOspfv3Ipv4Association","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv4 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the WAN VRF associated OSPFv3 IPv6 features for transport feature profile","operationId":"GetTransportVrfAssociatedRoutingOspfv3Ipv6Features_1","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdRoutingTransportVrfRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdRoutingTransportVrfRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"post":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Associate an OSPFv3 IPv6 feature with the WAN VRF feature for transport feature profile","operationId":"CreateTransportVrfAndRoutingOspfv3Ipv6FeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID ","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"OSPFv3 IPv6 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sd-routing/transport/{transportId}/vrf/{vrfId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Get the WAN VRF feature associated OSPFv3 IPv6 feature by ID for transport feature profile","operationId":"GetVrfAssociatedRoutingOspfv3Ipv6FeatureById_1","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID ","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdRoutingTransportVrfRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdRoutingTransportVrfRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-read"},"put":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Replace the OSPFv3 IPv6 feature for the WAN VRF feature in transport feature profile","operationId":"EditTransportVrfAndRoutingOspfv3Ipv6FeatureAssociation","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID ","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Old OSPFv3 IPv6 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"New OSPFv3 IPv6 Feature ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"},"delete":{"tags":["Configuration - Feature Profile (SD-Routing)"],"description":"Delete the WAN VRF feature and OSPFv3 IPv6 feature association for transport feature profile","operationId":"DeleteTransportVrfAndRoutingOspfv3Ipv6Association","parameters":[{"name":"transportId","in":"path","description":"Transport Profile ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF Feature ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"OSPFv3 IPv6 Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > SD-Routing Transport > VRF-write"}},"/v1/feature-profile/sdwan":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles","operationId":"GetSdwanFeatureProfileBySdwanFamily","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile-read"}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/cloud-probe/{cloudProbeId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cloud Probe Profile Parcel by parcelId for application-priority feature profile","operationId":"GetCloudProbeProfileParcelByParcelIdForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cloudProbeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"get response example":{"description":"get response example","value":"refer to schema for documentation and example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Application Priority > Cloud Probe-read,Feature Profile > Application Priority > Cloud Probe-write"}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/qos-policy":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create QOS Policy feature for application-priority feature profile","operationId":"createPolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"QOS Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-103"},"examples":{"Qos2":{"$ref":"#/components/examples/Qos2"}}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/qos-policy/{qosPolicyId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get QOS Policy feature for application-priority feature profile","operationId":"getPolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"qosPolicyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanApplicationPriorityQosPolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanApplicationPriorityQosPolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit QOS Policy feature for application-priority feature profile","operationId":"editPolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"qosPolicyId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"QOS Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-104"},"examples":{"Qos2":{"$ref":"#/components/examples/Qos2"}}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete QOS Policy feature for application-priority feature profile","operationId":"deletePolicyApplicationProfileParcel","parameters":[{"name":"applicationPriorityId","in":"path","required":true,"schema":{"type":"string"}},{"name":"qosPolicyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/traffic-policy":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Traffic Policy Profile Parcel for application-priority feature profile","operationId":"CreateTrafficPolicyProfileParcelForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Traffic Policy Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-105"},"examples":{"test_app_priority_policy_1_traffic":{"$ref":"#/components/examples/test_app_priority_policy_1_traffic"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/feature-profile/sdwan/application-priority/{applicationPriorityId}/traffic-policy/{trafficPolicyId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Traffic Policy Profile Parcel by parcelId for application-priority feature profile","operationId":"GetTrafficPolicyProfileParcelByParcelIdForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trafficPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanApplicationPriorityTrafficPolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanApplicationPriorityTrafficPolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Application Priority > Traffic Policy-read,Feature Profile > Application Priority > Traffic Policy-write"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Traffic Policy Profile Parcel for application-priority feature profile","operationId":"EditTrafficPolicyProfileParcelForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trafficPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Traffic Policy Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-106"},"examples":{"test_app_priority_policy_1_traffic":{"$ref":"#/components/examples/test_app_priority_policy_1_traffic"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Traffic Policy Profile Parcel for application-priority feature profile","operationId":"DeleteTrafficPolicyProfileParcelForapplication-priority","parameters":[{"name":"applicationPriorityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trafficPolicyId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Application Priority > Traffic Policy-write"}},"/v1/feature-profile/sdwan/cli":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanFeatureProfilesByFamilyAndType_1","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Feature Profile with profile type","operationId":"CreateSdwanFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-write"}},"/v1/feature-profile/sdwan/cli/config/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Sdwan Cli Config feature Schema by Schema Type","operationId":"GetSdwanCliConfigFeatureSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/cli/config/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/cli/config/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-read"}},"/v1/feature-profile/sdwan/cli/features":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanFeatureProfilesByFamilyAndType","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"featureType","in":"query","description":"feature type","schema":{"type":"string","default":"config"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-read"}},"/v1/feature-profile/sdwan/cli/{cliId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Feature Profile with Cli profile type","operationId":"GetSdwanFeatureProfileByProfileId","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanCliPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanCliExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Feature Profile","operationId":"EditSdwanFeatureProfile","parameters":[{"name":"cliId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanFeatureProfileForCli","parameters":[{"name":"cliId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On-write"}},"/v1/feature-profile/sdwan/cli/{cliId}/config":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get config Profile Parcels for cli feature profile","operationId":"GetConfigProfileParcelForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a config Profile Parcel for cli feature profile","operationId":"CreateSdwanConfigProfileParcelForCli","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-107"},"examples":{"CliConfigFeature":{"$ref":"#/components/examples/CliConfigFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-write"}},"/v1/feature-profile/sdwan/cli/{cliId}/config/{configId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get config Profile Parcel by configId for cli feature profile","operationId":"GetConfigProfileParcelByParcelIdForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanCliConfigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanCliConfigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a config Profile Parcel for cli feature profile","operationId":"EditConfigProfileParcelForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"cli config Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-108"},"examples":{"CliConfigFeature":{"$ref":"#/components/examples/CliConfigFeature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a config Profile Parcel for cli feature profile","operationId":"DeleteConfigProfileParcelForCLI","parameters":[{"name":"cliId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > CLI Add On > Config-write"}},"/v1/feature-profile/sdwan/dns-security":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanDnsSecurityFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"referenceCount","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanDnsSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanDnsSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Dns Security Feature Profile","operationId":"CreateSdwanDnsSecurityFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-write"}},"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Dns Security Feature Profile with dnsSecurityId","operationId":"GetSdwanDnsSecurityFeatureProfileByProfileId","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"references","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanDnsSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanDnsSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Dns Security Feature Profile","operationId":"EditSdwanDnsSecurityFeatureProfile","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanDnsSecurityFeatureProfile","parameters":[{"name":"dnsSecurityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security-write"}},"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}/dns":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Sig Security Profile Parcels for a given ParcelType","operationId":"GetSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanDnsSecurityDnsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanDnsSecurityDnsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Sig Security Policy","operationId":"CreateSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-109"},"examples":{"targetVpnsDnsSecurity":{"$ref":"#/components/examples/targetVpnsDnsSecurity"},"matchAllVpnsDnsSecurity":{"$ref":"#/components/examples/matchAllVpnsDnsSecurity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-write"}},"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}/dns/{dnsSecurityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get SigSecurity Profile Parcel by parcelId","operationId":"GetSigSecurityProfileParcelByParcelId","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dnsSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanDnsSecurityDnsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanDnsSecurityDnsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Sig Security Profile Parcel","operationId":"EditSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dnsSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-110"},"examples":{"targetVpnsDnsSecurity":{"$ref":"#/components/examples/targetVpnsDnsSecurity"},"matchAllVpnsDnsSecurity":{"$ref":"#/components/examples/matchAllVpnsDnsSecurity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a SigSecurity Profile Parcel ","operationId":"DeleteSigSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dnsSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Dns Security > Dns Policy-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/policy":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcels for a given ParcelType","operationId":"GetSecurityProfileParcel_1","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanEmbeddedSecurityPolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanEmbeddedSecurityPolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Security Policy","operationId":"CreateEmbeddedSecurityProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-56"},"examples":{"PolicyFeatureGlobalDefault":{"$ref":"#/components/examples/PolicyFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/policy/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcel by parcelId","operationId":"GetSecurityProfileParcelByParcelId","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanEmbeddedSecurityPolicyPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanEmbeddedSecurityPolicyExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Security Profile Parcel","operationId":"EditSecurityProfileParcel_1","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-57"},"examples":{"PolicyFeatureGlobalDefault":{"$ref":"#/components/examples/PolicyFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Security Profile Parcel ","operationId":"DeleteSecurityProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > Policy-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/unified/ngfirewall":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ngfirewall Profile Parcel","operationId":"GetNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanEmbeddedSecurityUnifiedNgfirewallPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanEmbeddedSecurityUnifiedNgfirewallExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Ngfirewall Policy","operationId":"CreateNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ngfirewall Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-58"},"examples":{"ngfirewallFeatureGlobalDefault":{"$ref":"#/components/examples/ngfirewallFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"}},"/v1/feature-profile/sdwan/embedded-security/{securityId}/unified/ngfirewall/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ngfirewall Profile Parcel by parcelId","operationId":"GetNgfirewallProfileParcelByParcelId","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanEmbeddedSecurityUnifiedNgfirewallPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanEmbeddedSecurityUnifiedNgfirewallExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Ngfirewall Profile Parcel","operationId":"EditNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ngfirewall Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-59"},"examples":{"ngfirewallFeatureGlobalDefault":{"$ref":"#/components/examples/ngfirewallFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Ngfirewall Profile Parcel ","operationId":"DeleteNgfirewallProfileParcel","parameters":[{"name":"securityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Embedded Security > NgFirewall-write"}},"/v1/feature-profile/sdwan/other":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanOtherFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanOtherPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanOtherExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Other Feature Profile","operationId":"CreateSDWANOtherFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-write"}},"/v1/feature-profile/sdwan/other/thousandeyes/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Other Thousandeyes Parcel Schema by Schema Type","operationId":"GetSdwanOtherThousandeyesParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/other/thousandeyes/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/other/thousandeyes/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-read"}},"/v1/feature-profile/sdwan/other/{otherId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Other Feature Profile with otherId","operationId":"GetSdwanOtherFeatureProfileByProfileId","parameters":[{"name":"otherId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanOtherPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanOtherExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Other Feature Profile","operationId":"EditSdwanOtherFeatureProfile","parameters":[{"name":"otherId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanOtherFeatureProfile","parameters":[{"name":"otherId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other-write"}},"/v1/feature-profile/sdwan/other/{otherId}/thousandeyes":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Thousandeyes Profile Parcels for Other feature profile","operationId":"GetThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanOtherThousandeyesPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanOtherThousandeyesExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Thousandeyes Profile Parcel for Other feature profile","operationId":"CreateThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Thousandeyes Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-111"},"examples":{"thousandeyesParcelGlobalDefault":{"$ref":"#/components/examples/thousandeyesParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-write"}},"/v1/feature-profile/sdwan/other/{otherId}/thousandeyes/{thousandeyesId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Thousandeyes Profile Parcel by parcelId for Other feature profile","operationId":"GetThousandeyesProfileParcelByParcelIdForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"thousandeyesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanOtherThousandeyesPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanOtherThousandeyesExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Thousandeyes Profile Parcel for Other feature profile","operationId":"EditThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"thousandeyesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Thousandeyes Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-112"},"examples":{"thousandeyesParcelGlobalDefault":{"$ref":"#/components/examples/thousandeyesParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Thousandeyes Profile Parcel for Other feature profile","operationId":"DeleteThousandeyesProfileParcelForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"thousandeyesId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > Thousandeyes-write"}},"/v1/feature-profile/sdwan/other/{otherId}/ucse":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ucse Profile feature for Other feature profile","operationId":"GetUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanOtherUcsePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanOtherUcseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Ucse Profile feature for Other feature profile","operationId":"CreateUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ucse Profile feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-113"},"examples":{"UcsefeatureGlobalDefault":{"$ref":"#/components/examples/UcsefeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-write"}},"/v1/feature-profile/sdwan/other/{otherId}/ucse/{ucseId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ucse Profile feature by FeatureId for Other feature profile","operationId":"GetUcseProfileFeatureByIdFFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ucseId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanOtherUcsePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanOtherUcseExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Ucse Profile feature for Other feature profile","operationId":"EditUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ucseId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ucse Profile feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-113"},"examples":{"UcsefeatureGlobalDefault":{"$ref":"#/components/examples/UcsefeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Ucse Profile feature for Other feature profile","operationId":"DeleteUcseProfileFeatureForOther","parameters":[{"name":"otherId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ucseId","in":"path","description":"Profile feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Other > UCSE-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/unified/{securityProfileParcelType}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcels for a given ParcelType","operationId":"GetSecurityProfileParcel","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"referenceCount","in":"query","description":"get reference count","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanPolicyObjectUnifiedAdvancedInspectionProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanPolicyObjectUnifiedAdvancedInspectionProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-read,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-read,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Security Policy","operationId":"CreateSecurityProfileParcel","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedSecurityprofileparceltypePost"},"examples":{"AIP1":{"$ref":"#/components/examples/AIP1"},"IntrusionPreventionParcel":{"$ref":"#/components/examples/IntrusionPreventionParcel"},"security-urlfilteringParcelGlobalDefault":{"$ref":"#/components/examples/security-urlfilteringParcelGlobalDefault"},"AMP1":{"$ref":"#/components/examples/AMP1"},"ssl-decryption-profileParcelGlobalDefault":{"$ref":"#/components/examples/ssl-decryption-profileParcelGlobalDefault"},"ssl-decryptionParcel":{"$ref":"#/components/examples/ssl-decryptionParcel"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-write,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-write,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/unified/{securityProfileParcelType}/{securityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security Profile Parcel by parcelId","operationId":"GetSecurityProfileParcelByParcelId_1","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"references","in":"query","description":"get associated profile/parcel details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanPolicyObjectUnifiedAdvancedInspectionProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanPolicyObjectUnifiedAdvancedInspectionProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-read,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-read,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-read,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Security Profile Parcel","operationId":"EditSecurityProfileParcel","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedSecurityprofileparceltypePut"},"examples":{"AIP1":{"$ref":"#/components/examples/AIP1"},"IntrusionPreventionParcel":{"$ref":"#/components/examples/IntrusionPreventionParcel"},"security-urlfilteringParcelGlobalDefault":{"$ref":"#/components/examples/security-urlfilteringParcelGlobalDefault"},"AMP1":{"$ref":"#/components/examples/AMP1"},"ssl-decryption-profileParcelGlobalDefault":{"$ref":"#/components/examples/ssl-decryption-profileParcelGlobalDefault"},"ssl-decryptionParcel":{"$ref":"#/components/examples/ssl-decryptionParcel"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-write,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-write,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Security Profile Parcel ","operationId":"DeleteSecurityProfileParcel_1","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityProfileParcelType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["advanced-inspection-profile","intrusion-prevention","url-filtering","advanced-malware-protection","ssl-decryption-profile","ssl-decryption"]}},{"name":"securityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Advanced Inspection Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > Intrusion Prevention-write,Feature Profile > Policy Object > Advanced Inspection Profile > Url Filtering-write,Feature Profile > Policy Object > Advanced Inspection Profile > Advanced Malware Protection-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption Profile-write,Feature Profile > Policy Object > Advanced Inspection Profile > SSL Decryption-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/{policyObjectListType}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Data Prefix Profile Parcels for Policy Object feature profile","operationId":"GetDataPrefixProfileParcelForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"referenceCount","in":"query","description":"get reference count","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanPolicyObjectSecurityDataIpPrefixPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanPolicyObjectSecurityDataIpPrefixExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-read,Feature Profile > Policy Object > Security FQDN Prefix-read,Feature Profile > Policy Object > Security Port-read,Feature Profile > Policy Object > Security Zone-read,Feature Profile > Policy Object > Security Local App-read,Feature Profile > Policy Object > Security Local Domain-read,Feature Profile > Policy Object > Security IPS Signature-read,Feature Profile > Policy Object > Security URL List-read,Feature Profile > Policy Object > Security Protocol Name-read,Feature Profile > Policy Object > Security Geo Location-read,Feature Profile > Policy Object > Security Identity-read,Feature Profile > Policy Object > Security Scalable Group Tag-read,Feature Profile > Policy Object > As Path-read,Feature Profile > Policy Object > Class-read,Feature Profile > Policy Object > Data Ipv6-read,Feature Profile > Policy Object > Data Prefix-read,Feature Profile > Policy Object > Community-read,Feature Profile > Policy Object > Ext Community-read,Feature Profile > Policy Object > Ipv6 Prefix-read,Feature Profile > Policy Object > Mirror-read,Feature Profile > Policy Object > Policer-read,Feature Profile > Policy Object > Prefix-read,Feature Profile > Policy Object > Standard Community-read,Feature Profile > Policy Object > VPN Group-read,Feature Profile > Policy Object > App List-read,Feature Profile > Policy Object > SLA Class-read,Feature Profile > Policy Object > Color List-read,Feature Profile > Policy Object > App Probe-read,Feature Profile > Policy Object > TLOC-read,Feature Profile > Policy Object > Preferred Color Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Data Prefix Profile Parcel for Security Policy Object feature profile","operationId":"CreateDataPrefixProfileParcelForSecurityPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}}],"requestBody":{"description":"Data Prefix Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedPolicyobjectlisttypePost"},"examples":{"SecurityDataIpPrefix":{"$ref":"#/components/examples/SecurityDataIpPrefix"},"SecurityFQDN":{"$ref":"#/components/examples/SecurityFQDN"},"SecurityPortList":{"$ref":"#/components/examples/SecurityPortList"},"SecurityLocalApp":{"$ref":"#/components/examples/SecurityLocalApp"},"SecurityLocalDomain":{"$ref":"#/components/examples/SecurityLocalDomain"},"SecurityIpsSignature":{"$ref":"#/components/examples/SecurityIpsSignature"},"SecurityUrlList":{"$ref":"#/components/examples/SecurityUrlList"},"SecurityProtocolName":{"$ref":"#/components/examples/SecurityProtocolName"},"SecurityGeolocation":{"$ref":"#/components/examples/SecurityGeolocation"},"SecurityIdentity":{"$ref":"#/components/examples/SecurityIdentity"},"SecurityScalableGroupTag":{"$ref":"#/components/examples/SecurityScalableGroupTag"},"SecurityZoneList1":{"$ref":"#/components/examples/SecurityZoneList1"},"SecurityZoneList2":{"$ref":"#/components/examples/SecurityZoneList2"},"CentralizedAppList":{"$ref":"#/components/examples/CentralizedAppList"},"SlaClass":{"$ref":"#/components/examples/SlaClass"},"AsPath":{"$ref":"#/components/examples/AsPath"},"ClassMapList":{"$ref":"#/components/examples/ClassMapList"},"Ipv6DataPrefixList":{"$ref":"#/components/examples/Ipv6DataPrefixList"},"Ipv4DataPrefixList":{"$ref":"#/components/examples/Ipv4DataPrefixList"},"ExpandedCommunityList":{"$ref":"#/components/examples/ExpandedCommunityList"},"ExtendedCommunityList":{"$ref":"#/components/examples/ExtendedCommunityList"},"IPv6PrefixList":{"$ref":"#/components/examples/IPv6PrefixList"},"MirrorList1":{"$ref":"#/components/examples/MirrorList1"},"MirrorList2":{"$ref":"#/components/examples/MirrorList2"},"PolicerList":{"$ref":"#/components/examples/PolicerList"},"IPv4PrefixList":{"$ref":"#/components/examples/IPv4PrefixList"},"StandardCommunityList":{"$ref":"#/components/examples/StandardCommunityList"},"VpnList":{"$ref":"#/components/examples/VpnList"},"AppProbe":{"$ref":"#/components/examples/AppProbe"},"TLOC":{"$ref":"#/components/examples/TLOC"},"Color":{"$ref":"#/components/examples/Color"},"PreferredColorGroup":{"$ref":"#/components/examples/PreferredColorGroup"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-write,Feature Profile > Policy Object > Security FQDN Prefix-write,Feature Profile > Policy Object > Security Port-write,Feature Profile > Policy Object > Security Zone-write,Feature Profile > Policy Object > Security Local App-write,Feature Profile > Policy Object > Security Local Domain-write,Feature Profile > Policy Object > Security IPS Signature-write,Feature Profile > Policy Object > Security URL List-write,Feature Profile > Policy Object > Security Protocol Name-write,Feature Profile > Policy Object > Security Geo Location-write,Feature Profile > Policy Object > Security Identity-write,Feature Profile > Policy Object > Security Scalable Group Tag-write,Feature Profile > Policy Object > As Path-write,Feature Profile > Policy Object > Class-write,Feature Profile > Policy Object > Data Ipv6-write,Feature Profile > Policy Object > Data Prefix-write,Feature Profile > Policy Object > Community-write,Feature Profile > Policy Object > Ext Community-write,Feature Profile > Policy Object > Ipv6 Prefix-write,Feature Profile > Policy Object > Mirror-write,Feature Profile > Policy Object > Policer-write,Feature Profile > Policy Object > Prefix-write,Feature Profile > Policy Object > Standard Community-write,Feature Profile > Policy Object > VPN Group-write,Feature Profile > Policy Object > App List-write,Feature Profile > Policy Object > SLA Class-write,Feature Profile > Policy Object > App Probe-write,Feature Profile > Policy Object > TLOC-write,Feature Profile > Policy Object > Color List-write,Feature Profile > Policy Object > Preferred Color Group-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectId}/{policyObjectListType}/{listObjectId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Data Prefix Profile Parcel by parcelId for Policy Object feature profile","operationId":"GetDataPrefixProfileParcelByParcelIdForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"listObjectId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"references","in":"query","description":"get referred profile/parcel details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanPolicyObjectSecurityDataIpPrefixPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanPolicyObjectSecurityDataIpPrefixExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-read,Feature Profile > Policy Object > Security FQDN Prefix-read,Feature Profile > Policy Object > Security Port-read,Feature Profile > Policy Object > Security Zone-read,Feature Profile > Policy Object > Security Local App-read,Feature Profile > Policy Object > Security Local Domain-read,Feature Profile > Policy Object > Security IPS Signature-read,Feature Profile > Policy Object > Security URL List-read,Feature Profile > Policy Object > Security Protocol Name-read,Feature Profile > Policy Object > Security Geo Location-read,Feature Profile > Policy Object > Security Identity-read,Feature Profile > Policy Object > Security Scalable Group Tag-read,Feature Profile > Policy Object > As Path-read,Feature Profile > Policy Object > Class-read,Feature Profile > Policy Object > Data Ipv6-read,Feature Profile > Policy Object > Data Prefix-read,Feature Profile > Policy Object > Community-read,Feature Profile > Policy Object > Ext Community-read,Feature Profile > Policy Object > Ipv6 Prefix-read,Feature Profile > Policy Object > Mirror-read,Feature Profile > Policy Object > Policer-read,Feature Profile > Policy Object > Prefix-read,Feature Profile > Policy Object > Standard Community-read,Feature Profile > Policy Object > VPN Group-read,Feature Profile > Policy Object > App List-read,Feature Profile > Policy Object > SLA Class-read,Feature Profile > Policy Object > Color List-read,Feature Profile > Policy Object > App Probe-read,Feature Profile > Policy Object > TLOC-read,Feature Profile > Policy Object > Preferred Color Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Data Prefix Profile Parcel for Policy Object feature profile","operationId":"EditDataPrefixProfileParcelForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"listObjectId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Data Prefix Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schema2HubGeneratedPolicyobjectlisttypePut"},"examples":{"SecurityDataIpPrefix":{"$ref":"#/components/examples/SecurityDataIpPrefix"},"SecurityFQDN":{"$ref":"#/components/examples/SecurityFQDN"},"SecurityPortList":{"$ref":"#/components/examples/SecurityPortList"},"SecurityLocalApp":{"$ref":"#/components/examples/SecurityLocalApp"},"SecurityLocalDomain":{"$ref":"#/components/examples/examples-SecurityLocalDomain"},"SecurityIpsSignature":{"$ref":"#/components/examples/SecurityIpsSignature"},"SecurityUrlList":{"$ref":"#/components/examples/SecurityUrlList"},"SecurityProtocolName":{"$ref":"#/components/examples/SecurityProtocolName"},"SecurityGeolocation":{"$ref":"#/components/examples/SecurityGeolocation"},"SecurityIdentity":{"$ref":"#/components/examples/SecurityIdentity"},"SecurityScalableGroupTag":{"$ref":"#/components/examples/SecurityScalableGroupTag"},"SecurityZoneList1":{"$ref":"#/components/examples/SecurityZoneList1"},"SecurityZoneList2":{"$ref":"#/components/examples/SecurityZoneList2"},"CentralizedAppList":{"$ref":"#/components/examples/examples-CentralizedAppList"},"SlaClass":{"$ref":"#/components/examples/SlaClass"},"AsPath":{"$ref":"#/components/examples/AsPath"},"ClassMapList":{"$ref":"#/components/examples/ClassMapList"},"Ipv6DataPrefixList":{"$ref":"#/components/examples/Ipv6DataPrefixList"},"Ipv4DataPrefixList":{"$ref":"#/components/examples/Ipv4DataPrefixList"},"ExpandedCommunityList":{"$ref":"#/components/examples/ExpandedCommunityList"},"ExtendedCommunityList":{"$ref":"#/components/examples/ExtendedCommunityList"},"IPv6PrefixList":{"$ref":"#/components/examples/IPv6PrefixList"},"mirrorList1":{"$ref":"#/components/examples/mirrorList1"},"mirrorList2":{"$ref":"#/components/examples/mirrorList2"},"PolicerList":{"$ref":"#/components/examples/PolicerList"},"IPv4PrefixList":{"$ref":"#/components/examples/IPv4PrefixList"},"StandardCommunityList":{"$ref":"#/components/examples/StandardCommunityList"},"VpnList":{"$ref":"#/components/examples/VpnList"},"AppProbe":{"$ref":"#/components/examples/AppProbe"},"TLOC":{"$ref":"#/components/examples/TLOC"},"Color":{"$ref":"#/components/examples/Color"},"PreferredColorGroup":{"$ref":"#/components/examples/PreferredColorGroup"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-write,Feature Profile > Policy Object > Security FQDN Prefix-write,Feature Profile > Policy Object > Security Port-write,Feature Profile > Policy Object > Security Zone-write,Feature Profile > Policy Object > Security Local App-write,Feature Profile > Policy Object > Security Local Domain-write,Feature Profile > Policy Object > Security IPS Signature-write,Feature Profile > Policy Object > Security URL List-write,Feature Profile > Policy Object > Security Protocol Name-write,Feature Profile > Policy Object > Security Geo Location-write,Feature Profile > Policy Object > Security Identity-write,Feature Profile > Policy Object > Security Scalable Group Tag-write,Feature Profile > Policy Object > As Path-write,Feature Profile > Policy Object > Class-write,Feature Profile > Policy Object > Data Ipv6-write,Feature Profile > Policy Object > Data Prefix-write,Feature Profile > Policy Object > Community-write,Feature Profile > Policy Object > Ext Community-write,Feature Profile > Policy Object > Ipv6 Prefix-write,Feature Profile > Policy Object > Mirror-write,Feature Profile > Policy Object > Policer-write,Feature Profile > Policy Object > Prefix-write,Feature Profile > Policy Object > Standard Community-write,Feature Profile > Policy Object > VPN Group-write,Feature Profile > Policy Object > App List-write,Feature Profile > Policy Object > SLA Class-write,Feature Profile > Policy Object > App Probe-write,Feature Profile > Policy Object > TLOC-write,Feature Profile > Policy Object > Color List-write,Feature Profile > Policy Object > Preferred Color Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Data Prefix Profile Parcel for Policy Object feature profile","operationId":"DeleteDataPrefixProfileParcelForPolicyObject","parameters":[{"name":"policyObjectId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}},{"name":"listObjectId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-write,Feature Profile > Policy Object > Security FQDN Prefix-write,Feature Profile > Policy Object > Security Port-write,Feature Profile > Policy Object > Security Zone-write,Feature Profile > Policy Object > Security Local App-write,Feature Profile > Policy Object > Security Local Domain-write,Feature Profile > Policy Object > Security IPS Signature-write,Feature Profile > Policy Object > Security URL List-write,Feature Profile > Policy Object > Security Protocol Name-write,Feature Profile > Policy Object > Security Geo Location-write,Feature Profile > Policy Object > Security Identity-write,Feature Profile > Policy Object > Security Scalable Group Tag-write,Feature Profile > Policy Object > As Path-write,Feature Profile > Policy Object > Class-write,Feature Profile > Policy Object > Data Ipv6-write,Feature Profile > Policy Object > Data Prefix-write,Feature Profile > Policy Object > Community-write,Feature Profile > Policy Object > Ext Community-write,Feature Profile > Policy Object > Ipv6 Prefix-write,Feature Profile > Policy Object > Mirror-write,Feature Profile > Policy Object > Policer-write,Feature Profile > Policy Object > Prefix-write,Feature Profile > Policy Object > Standard Community-write,Feature Profile > Policy Object > VPN Group-write,Feature Profile > Policy Object > App List-write,Feature Profile > Policy Object > SLA Class-write,Feature Profile > Policy Object > App Probe-write,Feature Profile > Policy Object > TLOC-write,Feature Profile > Policy Object > Color List-write,Feature Profile > Policy Object > Preferred Color Group-write"}},"/v1/feature-profile/sdwan/policy-object/{policyObjectListType}/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN PolicyObject DataPrefix Parcel Schema by Schema Type","operationId":"GetSdwanPolicyObjectDataPrefixParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}},{"name":"policyObjectListType","in":"path","description":"Policy Object ListType","required":true,"schema":{"type":"string","enum":["security-data-ip-prefix","security-fqdn","security-port","security-localapp","security-localdomain","security-ipssignature","security-urllist","security-protocolname","security-geolocation","security-identity","security-scalablegrouptag","security-zone","app-list","sla-class","as-path","class","data-ipv6-prefix","data-prefix","expanded-community","ext-community","ipv6-prefix","mirror","policer","prefix","standard-community","vpn-group","app-probe","tloc","color","preferred-color-group"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"security-data-ip-prefix_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-data-ip-prefix/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-data-ip-prefix_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-data-ip-prefix/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-fqdn_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-fqdn/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-fqdn_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-fqdn/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-port_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-port/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-port_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-port/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-localapp_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localapp/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-localapp_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localapp/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-localdomain_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localdomain/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-localdomain_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-localdomain/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-ipssignature_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-ipssignature/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-ipssignature_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-ipssignature/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-urllist_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-urllist/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-urllist_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-urllist/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-protocolname_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-protocolname/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-protocolname_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-protocolname/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-geolocation_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-geolocation/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-geolocation_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-geolocation/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-identity_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-identity/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-identity_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-identity/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-scalablegrouptag_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-scalablegrouptag/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-scalablegrouptag_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-scalablegrouptag/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-zone_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"security-zone_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/security-zone/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"app-list_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/app-list/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"app-list_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/app-list/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"sla-class_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/sla-class/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"sla-class_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/sla-class/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"as-path_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/as-path/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"as-path_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/as-path/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"class_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/class/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"class_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/class/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"data-ipv6-prefix_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/data-ipv6-prefix/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"data-ipv6-prefix_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/data-ipv6-prefix/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"data-prefix_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/data-prefix/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"data-prefix_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/data-prefix/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"expanded-community_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/expanded-community/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"expanded-community_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/expanded-community/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"ext-community_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/ext-community/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"ext-community_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/ext-community/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"ipv6-prefix_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/ipv6-prefix/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"ipv6-prefix_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/ipv6-prefix/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"mirror_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"mirror_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/mirror/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"policer_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/policer/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"policer_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/policer/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"prefix_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/prefix/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"prefix_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/prefix/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"standard-community_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/standard-community/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"standard-community_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/standard-community/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"vpn-group_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/vpn-group/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"vpn-group_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/vpn-group/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"app-probe_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/app-probe/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"app-probe_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/app-probe/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"tloc_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/tloc/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"tloc_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/tloc/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"color_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/color/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"color_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/color/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"preferred-color-group_post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/preferred-color-group/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"preferred-color-group_put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/policy-object/preferred-color-group/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Policy Object > Security Data IP Prefix-read,Feature Profile > Policy Object > Security FQDN Prefix-read,Feature Profile > Policy Object > Security Port-read,Feature Profile > Policy Object > Security Zone-read,Feature Profile > Policy Object > Security Local App-read,Feature Profile > Policy Object > Security Local Domain-read,Feature Profile > Policy Object > Security IPS Signature-read,Feature Profile > Policy Object > Security URL List-read,Feature Profile > Policy Object > Security Protocol Name-read,Feature Profile > Policy Object > Security Geo Location-read,Feature Profile > Policy Object > Security Identity-read,Feature Profile > Policy Object > Security Scalable Group Tag-read,Feature Profile > Policy Object > As Path-read,Feature Profile > Policy Object > Class-read,Feature Profile > Policy Object > Data Ipv6-read,Feature Profile > Policy Object > Data Prefix-read,Feature Profile > Policy Object > Community-read,Feature Profile > Policy Object > Ext Community-read,Feature Profile > Policy Object > Ipv6 Prefix-read,Feature Profile > Policy Object > Mirror-read,Feature Profile > Policy Object > Policer-read,Feature Profile > Policy Object > Prefix-read,Feature Profile > Policy Object > Standard Community-read,Feature Profile > Policy Object > VPN Group-read,Feature Profile > Policy Object > App List-read,Feature Profile > Policy Object > SLA Class-read,Feature Profile > Policy Object > Color List-read,Feature Profile > Policy Object > App Probe-read,Feature Profile > Policy Object > TLOC-read,Feature Profile > Policy Object > Preferred Color Group-read"}},"/v1/feature-profile/sdwan/service":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanServiceFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"details","in":"query","description":"get configuration details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServicePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Service Feature Profile","operationId":"CreateSdwanServiceFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-write"}},"/v1/feature-profile/sdwan/service/dhcp-server/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service DhcpServer Parcel Schema by Schema Type","operationId":"GetSdwanServiceDhcpServerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/dhcp-server/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/dhcp-server/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/ethernet/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service LanVpn InterfaceEthernet Schema by Schema Type","operationId":"GetSdwanServiceLanVpnInterfaceEthernetParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ethernet/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/gre/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service LanVpn InterfaceGre Schema by Schema Type","operationId":"GetCedgeServiceLanVpnInterfaceGreSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/gre/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/gre/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Template Deploy-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/ipsec/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service LanVpn InterfaceIpsec Schema by Schema Type","operationId":"getSdwanProfileParcelSchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ipsec/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/ipsec/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/interface/svi/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service LanVpn InterfaceSvi Schema by Schema Type","operationId":"GetCedgeServiceLanVpnInterfaceSviParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/svi/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/interface/svi/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"}},"/v1/feature-profile/sdwan/service/lan/vpn/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service LanVpn Parcel Schema by Schema Type","operationId":"GetSdwanServiceLanVpnParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/lan/vpn/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"}},"/v1/feature-profile/sdwan/service/routing/bgp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service RoutingBgp Parcel Schema by Schema Type","operationId":"GetSdwanServiceRoutingBgpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/routing/bgp/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/routing/bgp/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-read"}},"/v1/feature-profile/sdwan/service/routing/multicast/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service RoutingMulticast Parcel Schema by Schema Type","operationId":"GetSdwanServiceRoutingMulticastParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/routing/multicast/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/routing/multicast/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-read"}},"/v1/feature-profile/sdwan/service/switchport/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service Switchport Parcel Schema by Schema Type","operationId":"GetCedgeServiceSwitchportParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/switchport/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/switchport/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-read"}},"/v1/feature-profile/sdwan/service/tracker/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service Tracker Parcel Schema by Schema Type","operationId":"GetSdwanServiceTrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/tracker/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/tracker/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-read"}},"/v1/feature-profile/sdwan/service/trackergroup/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Service TrackerGroup Parcel Schema by Schema Type","operationId":"GetCedgeServiceTrackerGroupParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-read"}},"/v1/feature-profile/sdwan/service/wirelesslan/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a sdwan Service Wirelesslan Parcel Schema by Schema Type","operationId":"GetSdwanServiceWirelesslanParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/wirelesslan/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/service/wirelesslan/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-read"}},"/v1/feature-profile/sdwan/service/{serviceId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service Feature Profile with serviceId","operationId":"GetSdwanServiceFeatureProfileByProfileId","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"details","in":"query","description":"get feature details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServicePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Service Feature Profile","operationId":"EditSdwanServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanServiceFeatureProfile","parameters":[{"name":"serviceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/appqoe":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Appqoe Profile Parcels for Service feature profile","operationId":"GetAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceAppqoePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceAppqoeExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Appqoe Profile Parcel for Service feature profile","operationId":"CreateAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Appqoe Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-179"},"examples":{"AppqoeFeatureGlobalDefault":{"$ref":"#/components/examples/AppqoeFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/appqoe/{appqoeId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Appqoe Profile Parcel by parcelId for Service feature profile","operationId":"GetAppqoeProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"appqoeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceAppqoePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceAppqoeExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Appqoe Profile Parcel for Service feature profile","operationId":"EditAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"appqoeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Appqoe Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-179"},"examples":{"AppqoeFeatureGlobalDefault":{"$ref":"#/components/examples/AppqoeFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Appqoe Profile Parcel for Service feature profile","operationId":"DeleteAppqoeProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"appqoeId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Appqoe-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Dhcp Server Profile Parcels for Service feature profile","operationId":"GetDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Dhcp Server Profile Parcel for Service feature profile","operationId":"CreateDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dhcp Server Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-180"},"examples":{"Default_DHCP_Server_Parcel":{"$ref":"#/components/examples/Default_DHCP_Server_Parcel"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Dhcp Server Profile Parcel by parcelId for Service feature profile","operationId":"GetDhcpServerProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Dhcp Server Profile Parcel for Service feature profile","operationId":"EditDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Dhcp Server Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-181"},"examples":{"Default_DHCP_Server_Parcel":{"$ref":"#/components/examples/Default_DHCP_Server_Parcel"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Dhcp Server Profile Parcel for Service feature profile","operationId":"DeleteDhcpServerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Dhcp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Lan Vpn Profile Parcels for Service feature profile","operationId":"GetLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Lan Vpn Profile Parcel for Service feature profile","operationId":"CreateLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-182"},"examples":{"Cedge_CG1_Service_Lan_Vpn_Feature":{"$ref":"#/components/examples/Cedge_CG1_Service_Lan_Vpn_Feature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Lan Vpn Profile Parcel by parcelId for Service feature profile","operationId":"GetLanVpnProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Lan Vpn Profile Parcel for Service feature profile","operationId":"EditLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-183"},"examples":{"Cedge_CG1_Service_Lan_Vpn_Feature":{"$ref":"#/components/examples/Cedge_CG1_Service_Lan_Vpn_Feature"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Lan Vpn Profile Parcel for Service feature profile","operationId":"DeleteLanVpnProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceEthernet Parcels for service LanVpn Parcel","operationId":"GetInterfaceEthernetParcelsForServiceLanVpn","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceEthernet parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-184"},"examples":{"ServiceLanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"#/components/examples/ServiceLanVpnInterfaceEthernetParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceEthernet Parcel by ethernetId for service feature profile","operationId":"GetLanVpnInterfaceEthernetParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn InterfaceEthernet Parcel for service feature profile","operationId":"EditLanVpnInterfaceEthernetParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-185"},"examples":{"ServiceLanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"#/components/examples/ServiceLanVpnInterfaceEthernetParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceEthernet Parcel for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated DhcpServer Parcels for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceEthernetDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceEthernetDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated DhcpServer Parcel by dhcpServerId for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedDhcpServerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceEthernetDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceEthernetDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceEthernet parcel and a DhcpServer Parcel association for service feature profile","operationId":"EditLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceEthernet and a DhcpServer Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetAndDhcpServerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated Tracker Parcels for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceEthernetTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceEthernetTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated Tracker Parcel by trackerId for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceEthernetTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceEthernetTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceEthernet parcel and a Tracker Parcel association for service feature profile","operationId":"EditLanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceEthernet and a Tracker Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetAndTrackerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated TrackerGroup Parcels for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerGroupParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceEthernetTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceEthernetTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceEthernet associated TrackerGroup Parcel by trackergroupId for service feature profile","operationId":"GetLanVpnInterfaceEthernetAssociatedTrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceEthernetTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceEthernetTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceEthernet parcel and a TrackerGroup Parcel association for service feature profile","operationId":"EditLanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceEthernet and a TrackerGroup Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceEthernetAndTrackerGroupAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/gre":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceGre for service LanVpn","operationId":"GetInterfaceGresForServiceLanVpn","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceGrePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceGreExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceGre for service feature profile","operationId":"CreateLanVpnInterfaceGreForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Gre","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-188"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-4"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/gre/{greId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceGre by greId for service feature profile","operationId":"GetLanVpnInterfaceGreByIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Gre ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceGrePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceGreExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn InterfaceGre Feature for service feature profile","operationId":"EditLanVpnInterfaceGreForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Gre","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-188"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-4"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceGre for service feature profile","operationId":"DeleteLanVpnInterfaceGreForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Vpn ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Gre ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceIpsec Parcels for Service LanVpn Parcel","operationId":"getListOfProfileParcels","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceIpsec parcel for service feature profile","operationId":"createIpSecProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ipsec Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-189"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"#/components/examples/WANVPNInterfaceIpsecParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceIpsec Parcel by ethernetId for Service feature profile","operationId":"getProfileParcelByParcelId","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn Interface Ipsec Parcel for Service feature profile","operationId":"editProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Ipsec Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-189"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"#/components/examples/WANVPNInterfaceIpsecParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceIpsec Parcel for Service feature profile","operationId":"deleteProfileParcel","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec/{ipsecId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceIpsec associated DhcpServer Parcels for service feature profile","operationId":"GetLanVpnInterfaceIpsecAssociatedDhcpServerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceIpsecDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceIpsecDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/ipsec/{ipsecId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceIpsec associated DhcpServer Parcel by dhcpServerId for service feature profile","operationId":"GetLanVpnInterfaceIpsecAssociatedDhcpServerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceIpsecDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceIpsecDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceIpsec parcel and a DhcpServer Parcel association for service feature profile","operationId":"EditLanVpnInterfaceIpsecAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceIpsec and a DhcpServer Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceIpsecAndDhcpServerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceSvi Parcels for service LanVpn Parcel","operationId":"GetInterfaceSviParcelsForServiceLanVpn","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceSviPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceSviExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi,Feature Profile > Service > Lan/Vpn/Interface/Svi-write"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a LanVpn InterfaceSvi parcel for service feature profile","operationId":"CreateLanVpnInterfaceSviParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Svi Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-190"},"examples":{"ServiceLanVpnInterfaceSviParcelGlobalDefault":{"$ref":"#/components/examples/ServiceLanVpnInterfaceSviParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn InterfaceSvi Parcel by sviId for service feature profile","operationId":"GetLanVpnInterfaceSviParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceSviPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceSviExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn InterfaceSvi Parcel for service feature profile","operationId":"EditLanVpnInterfaceSviParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Lan Vpn Interface Svi Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-191"},"examples":{"ServiceLanVpnInterfaceSviParcelGlobalDefault":{"$ref":"#/components/examples/ServiceLanVpnInterfaceSviParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn InterfaceSvi Parcel for service feature profile","operationId":"DeleteLanVpnInterfaceSviForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceSvi associated DhcpServer Parcels for service feature profile","operationId":"GetLanVpnInterfaceSviAssociatedDhcpServerParcelsForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnInterfaceSviDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnInterfaceSviDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/interface/svi/{sviId}/dhcp-server/{dhcpServerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpnInterfaceSvi associated DhcpServer Parcel by dhcpServerId for service feature profile","operationId":"GetLanVpnInterfaceSviAssociatedDhcpServerParcelByParcelIdForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnInterfaceSviDhcpServerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnInterfaceSviDhcpServerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpnInterfaceSvi parcel and a DhcpServer Parcel association for service feature profile","operationId":"EditLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpnInterfaceSvi and a DhcpServer Parcel association for service feature profile","operationId":"DeleteLanVpnInterfaceSviAndDhcpServerAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"dhcpServerId","in":"path","description":"DhcpServer Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Bgp Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingBgpParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn parcel with a routingbgp Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingBgpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated RoutingBgp Parcel by bgpId for service feature profile","operationId":"GetLanVpnAssociatedRoutingBgpParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn parcel and a RoutingBgp Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingBgpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn parcel and a RoutingBgp Parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingBgpAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/eigrp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Eigrp Features for service feature profile","operationId":"GetLanVpnAssociatedRoutingEigrpParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn feature with a routingeigrp Feature for service feature profile","operationId":"CreateLanVpnAndRoutingEigrpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/eigrp/{eigrpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn feature associated RoutingEigrp Feature by eigrpId for service feature profile","operationId":"GetLanVpnAssociatedRoutingEigrpParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Routing Eigrp Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn feature and a RoutingEigrp Feature association for service feature profile","operationId":"EditLanVpnAndRoutingEigrpParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Routing Eigrp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn feature and a RoutingEigrp Feature association for service feature profile","operationId":"DeleteLanVpnAndRoutingEigrpAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Routing Eigrp Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/multicast":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Multicast Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingMulticastParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnRoutingMulticastPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnRoutingMulticastExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn parcel with a routingmulticast Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingMulticastParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/multicast/{multicastId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated RoutingMulticast Parcel by multicastId for service feature profile","operationId":"GetLanVpnAssociatedRoutingMulticastParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Routing Multicast Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnRoutingMulticastPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnRoutingMulticastExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn parcel and a RoutingMulticast Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingMulticastParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Routing Multicast ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn parcel and a RoutingMulticast Parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingMulticastAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Routing Multicast Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated Routing Ospf Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a lanvpn parcel with a routingospf Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingOspfParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated RoutingOspf Parcel by ospfId for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LanVpn parcel and a RoutingOspf Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingOspfParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LanVpn parcel and a RoutingOspf Parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingOspfAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated IPv4 address family OSPFv3 Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv4ParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LAN VPN parcel with a IPv4 address family OSPFv3 Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingOspfv3IPv4ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv4 address family OSPFv3 Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated IPv4 address family OSPFv3 IPv4 Parcel by ospfv3Id for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv4ParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 Address Family OSPFv3 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LAN VPN parcel and a routing OSPFv3 IPv4 Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingOspfv3IPv4ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 address family OSPFv3 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv4 address family OSPFv3 Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LAN VPN parcel and a IPv4 OSPFv3 parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingOspfv3AssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv4 Address Family OSPFv3 IPv4 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn associated IPv6 address family OSPFv3 Parcels for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv6ParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceLanVpnRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceLanVpnRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LAN VPN parcel with a IPv6 address family OSPFv3 Parcel for service feature profile","operationId":"CreateLanVpnAndRoutingOspfv3IPv6ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 address family OSPFv3 Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get LanVpn parcel associated IPv6 address family OSPFv3 IPv6 Parcel by ospfv3Id for service feature profile","operationId":"GetLanVpnAssociatedRoutingOspfv3IPv6ParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv6 Address Family OSPFv3 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceLanVpnRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceLanVpnRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a LAN VPN parcel and a routing OSPFv3 IPv6 Parcel association for service feature profile","operationId":"EditLanVpnAndRoutingOspfv3IPv6ParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv6 address family OSPFv3 ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 address family OSPFv3 Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a LAN VPN parcel and a IPv6 OSPFv3 parcel association for service feature profile","operationId":"DeleteLanVpnAndRoutingOspfv3AssociationForService_1","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"IPv6 Address Family OSPFv3 IPv6 Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/dhcp-server":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceEthernet parcel with a DhcpServer Parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceEthernet parcel with a Tracker Parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceEthernet parcel with a TrackerGroup Parcel for service feature profile","operationId":"CreateLanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/ipsec/{ipsecId}/dhcp-server":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceIpsec parcel with a DhcpServer Parcel for service feature profile","operationId":"CreateLanVpnInterfaceIpsecAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/lan/vpn/{vpnParcelId}/interface/svi/{sviId}/dhcp-server":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a LanVpnInterfaceSvi parcel with a DhcpServer Parcel for service feature profile","operationId":"CreateLanVpnInterfaceSviAndDhcpServerParcelAssociationForTransport","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"sviId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"DhcpServer Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Lan/Vpn/Interface/Svi-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcels for Service feature profile","operationId":"GetRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Bgp Profile Parcel for Service feature profile","operationId":"CreateRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-192"},"examples":{"ServiceBgpParcelGlobalDefault":{"$ref":"#/components/examples/ServiceBgpParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingBgpProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Bgp Profile Parcel for Service feature profile","operationId":"EditRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-192"},"examples":{"ServiceBgpParcelGlobalDefault":{"$ref":"#/components/examples/ServiceBgpParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Bgp Profile Parcel for Service feature profile","operationId":"DeleteRoutingBgpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/eigrp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Eigrp Profile Features for Service feature profile","operationId":"GetRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Eigrp Profile Feature for Service feature profile","operationId":"CreateRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-193"},"examples":{"eigrpFeatureGlobalDefault":{"$ref":"#/components/examples/eigrpFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/eigrp/{eigrpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Eigrp Profile Feature by parcelId for Service feature profile","operationId":"GetRoutingEigrpProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceRoutingEigrpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceRoutingEigrpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Eigrp Profile Feature for Service feature profile","operationId":"EditRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Eigrp Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-193"},"examples":{"eigrpFeatureGlobalDefault":{"$ref":"#/components/examples/eigrpFeatureGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Eigrp Profile Feature for Service feature profile","operationId":"DeleteRoutingEigrpProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"eigrpId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Eigrp-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/multicast":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Multicast Profile Parcels for Service feature profile","operationId":"GetRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceRoutingMulticastPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceRoutingMulticastExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Multicast Profile Parcel for Service feature profile","operationId":"CreateRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-194"},"examples":{"ServiceMulticastParcelGlobalDefault":{"$ref":"#/components/examples/ServiceMulticastParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/multicast/{multicastId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Multicast Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingMulticastProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceRoutingMulticastPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceRoutingMulticastExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Multicast Profile Parcel for Service feature profile","operationId":"EditRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Multicast Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-194"},"examples":{"ServiceMulticastParcelGlobalDefault":{"$ref":"#/components/examples/ServiceMulticastParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Multicast Profile Parcel for Service feature profile","operationId":"DeleteRoutingMulticastProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Multicast-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcels for Service feature profile","operationId":"GetRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Ospf Profile Parcel for Service feature profile","operationId":"CreateRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-195"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"#/components/examples/ServiceOspfParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingOspfProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Ospf Profile Parcel for Service feature profile","operationId":"EditRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-195"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"#/components/examples/ServiceOspfParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Ospf Profile Parcel for Service feature profile","operationId":"DeleteRoutingOspfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv4 Address Family Profile Parcels for Service feature profile","operationId":"GetRoutingOspfv3Ipv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing OSPFv3 IPv4 Address Family Profile Parcel for Service feature profile","operationId":"CreateRoutingOspfv3Ipv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-196"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/WAN_OSPFv3_IPv4_AF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv4 Address Family Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingOspfv3IPv4AfProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing OSPFv3 IPv4 Address Family Profile Parcel for Service feature profile","operationId":"EditRoutingOspfv3IPv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-196"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/WAN_OSPFv3_IPv4_AF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing OSPFv3 IPv4 Address Family Profile Parcel for Service feature profile","operationId":"DeleteRoutingOspfv3IPv4AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv6 Address Family Profile Parcels for Service feature profile","operationId":"GetRoutingOspfv3Ipv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing OSPFv3 IPv6 Address Family Profile Parcel for Service feature profile","operationId":"CreateRoutingOspfv3Ipv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-197"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"#/components/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"#/components/examples/WAN_OSPFv3_IPv6"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing OSPFv3 IPv6 Address Family Profile Parcel by parcelId for Service feature profile","operationId":"GetRoutingOspfv3IPv6AfProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing OSPFv3 IPv6 Address Family Profile Parcel for Service feature profile","operationId":"EditRoutingOspfv3IPv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing OSPFv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-197"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"#/components/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"#/components/examples/WAN_OSPFv3_IPv6"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing OSPFv3 IPv6 Address Family Profile Parcel for Service feature profile","operationId":"DeleteRoutingOspfv3IPv6AfProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/switchport":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Switchport Parcels for service feature profile","operationId":"GetSwitchportParcelsForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceSwitchportPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceSwitchportExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a switchport Parcel to a service feature profile","operationId":"CedgeServiceProfileSwitchportParcelRestfulResource","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Feature Profile Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-198"},"examples":{"SwitchPortParcelGlobalDefault":{"$ref":"#/components/examples/SwitchPortParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/switchport/{switchportId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Switchport Parcel by switchportId for service feature profile","operationId":"GetSwitchportParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchportId","in":"path","description":"Switchport Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceSwitchportPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceSwitchportExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Switchport Parcel association for service feature profile","operationId":"EditSwitchportParcelAssociationForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchportId","in":"path","description":"Switchport ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Switchport Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-199"},"examples":{"SwitchPortParcelGlobalDefault":{"$ref":"#/components/examples/SwitchPortParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Switchport Parcel for service feature profile","operationId":"DeleteSwitchportProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"switchportId","in":"path","description":"Switchport Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Switchport-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcels for Service feature profile","operationId":"GetTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Tracker Profile Parcel for Service feature profile","operationId":"CreateTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-186"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Service_Tracker_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcel by parcelId for Service feature profile","operationId":"GetTrackerProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Tracker Profile Parcel for Service feature profile","operationId":"EditTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-186"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Service_Tracker_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Tracker Profile Parcel for Service feature profile","operationId":"DeleteTrackerProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcels for Service feature profile","operationId":"GetTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a TrackerGroup Profile Parcel for Service feature profile","operationId":"CreateTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-187"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"#/components/examples/common_track_group_cedge_parcel_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcel by parcelId for Service feature profile","operationId":"GetTrackerGroupProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a TrackerGroup Profile Parcel for Service feature profile","operationId":"EditTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-187"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"#/components/examples/common_track_group_cedge_parcel_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a TrackerGroup Profile Parcel for Service feature profile","operationId":"DeleteTrackerGroupProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Tracker Group-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wirelesslan Profile Parcels for Service feature profile","operationId":"GetWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanServiceWirelesslanPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanServiceWirelesslanExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Wirelesslan Profile Parcel for Service feature profile","operationId":"CreateWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wirelesslan Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-200"},"examples":{"wirelessParcelGlobalDefault":{"$ref":"#/components/examples/wirelessParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-write"}},"/v1/feature-profile/sdwan/service/{serviceId}/wirelesslan/{wirelesslanId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wirelesslan Profile Parcel by parcelId for Service feature profile","operationId":"GetWirelesslanProfileParcelByParcelIdForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wirelesslanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanServiceWirelesslanPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanServiceWirelesslanExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Wirelesslan Profile Parcel for Service feature profile","operationId":"EditWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wirelesslanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wirelesslan Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-201"},"examples":{"wirelessParcelGlobalDefault":{"$ref":"#/components/examples/wirelessParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Wirelesslan Profile Parcel for Service feature profile","operationId":"DeleteWirelesslanProfileParcelForService","parameters":[{"name":"serviceId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"wirelesslanId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Service > Wirelesslan-write"}},"/v1/feature-profile/sdwan/sig-security":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanSigSecurityFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}},{"name":"referenceCount","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSigSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSigSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Sig Security Feature Profile","operationId":"CreateSdwanSigSecurityFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-write"}},"/v1/feature-profile/sdwan/sig-security/{sigSecurityId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Sig Security Feature Profile with sigSecurityId","operationId":"GetSdwanSigSecurityFeatureProfileByProfileId","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}},{"name":"references","in":"query","description":"get associated group details","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSigSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSigSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Sig Security Feature Profile","operationId":"EditSdwanSigSecurityFeatureProfile","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanSigSecurityFeatureProfile","parameters":[{"name":"sigSecurityId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security-write"}},"/v1/feature-profile/sdwan/sig-security/{sigSecurityId}/sig":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Sig Security Profile Parcels for a given ParcelType","operationId":"GetSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSigSecuritySigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSigSecuritySigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Sig Security Policy","operationId":"CreateSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-202"},"examples":{"SIG":{"$ref":"#/components/examples/SIG"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-write"}},"/v1/feature-profile/sdwan/sig-security/{sigSecurityId}/sig/{sigSecurityProfileParcelId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get SigSecurity Profile Parcel by parcelId","operationId":"GetSigSecurityProfileParcelByParcelId_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"sigSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSigSecuritySigPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSigSecuritySigExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Sig Security Profile Parcel","operationId":"EditSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"sigSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-203"},"examples":{"SIG":{"$ref":"#/components/examples/SIG"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a SigSecurity Profile Parcel ","operationId":"DeleteSigSecurityProfileParcel_1","parameters":[{"name":"sigSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"sigSecurityProfileParcelId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Sig Security > Sig Policy-write"}},"/v1/feature-profile/sdwan/system":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanSystemFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN System Feature Profile","operationId":"CreateSdwanSystemFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-write"}},"/v1/feature-profile/sdwan/system/aaa/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Aaa Parcel Schema by Schema Type","operationId":"GetSdwanSystemAaaParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/aaa/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/aaa/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-read"}},"/v1/feature-profile/sdwan/system/banner/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Banner Parcel Schema by Schema Type","operationId":"GetSdwanSystemBannerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/banner/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/banner/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-read"}},"/v1/feature-profile/sdwan/system/basic/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Basic Feature Schema by Schema Type","operationId":"GetSdwanSystemBasicFeatureSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/basic/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/basic/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-read"}},"/v1/feature-profile/sdwan/system/bfd/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Bfd Parcel Schema by Schema Type","operationId":"GetSdwanSystemBfdParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/bfd/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/bfd/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-read"}},"/v1/feature-profile/sdwan/system/global/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge System Global Parcel Schema by Schema Type","operationId":"GetCedgeSystemGlobalParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/global/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/global/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-read"}},"/v1/feature-profile/sdwan/system/logging/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Logging Parcel Schema by Schema Type","operationId":"GetSdwanSystemLoggingParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/logging/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/logging/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-read"}},"/v1/feature-profile/sdwan/system/mrf/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge System Mrf Parcel Schema by Schema Type","operationId":"GetCedgeSystemMrfParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/mrf/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/mrf/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-read"}},"/v1/feature-profile/sdwan/system/ntp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Ntp Parcel Schema by Schema Type","operationId":"GetSdwanSystemNtpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/ntp/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/ntp/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-read"}},"/v1/feature-profile/sdwan/system/omp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Omp Parcel Schema by Schema Type","operationId":"GetSdwanSystemOmpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/omp/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/omp/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-read"}},"/v1/feature-profile/sdwan/system/snmp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Snmp Parcel Schema by Schema Type","operationId":"GetSdwanSystemSnmpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/snmp/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/system/snmp/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-read"}},"/v1/feature-profile/sdwan/system/{systemId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN System Feature Profile with systemId","operationId":"GetSdwanSystemFeatureProfileByProfileId","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN System Feature Profile","operationId":"EditSdwanSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanSystemFeatureProfile","parameters":[{"name":"systemId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System-write"}},"/v1/feature-profile/sdwan/system/{systemId}/aaa":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Aaa Profile Parcels for System feature profile","operationId":"GetAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemAaaPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemAaaExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Aaa Profile Parcel for System feature profile","operationId":"CreateAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Aaa Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-204"},"examples":{"CedgeSystemAAAParcelConfig":{"$ref":"#/components/examples/CedgeSystemAAAParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-write"}},"/v1/feature-profile/sdwan/system/{systemId}/aaa/{aaaId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Aaa Profile Parcel by parcelId for System feature profile","operationId":"GetAaaProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemAaaPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemAaaExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Aaa Profile Parcel for System feature profile","operationId":"EditAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Aaa Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-205"},"examples":{"CedgeSystemAAAParcelConfig":{"$ref":"#/components/examples/CedgeSystemAAAParcelConfig"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Aaa Profile Parcel for System feature profile","operationId":"DeleteAaaProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"aaaId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Aaa-write"}},"/v1/feature-profile/sdwan/system/{systemId}/banner":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Banner Profile Parcels for System feature profile","operationId":"GetBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemBannerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemBannerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Banner Profile Parcel for System feature profile","operationId":"CreateBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-84"},"examples":{"SystemBannerGlobalDefault":{"$ref":"#/components/examples/SystemBannerGlobalDefault"},"SystemBannerVariable":{"$ref":"#/components/examples/SystemBannerVariable"},"SystemBannerDefaultGlobal":{"$ref":"#/components/examples/SystemBannerDefaultGlobal"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-write"}},"/v1/feature-profile/sdwan/system/{systemId}/banner/{bannerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Banner Profile Parcel by parcelId for System feature profile","operationId":"GetBannerProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemBannerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemBannerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Banner Profile Parcel for System feature profile","operationId":"EditBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Banner Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-85"},"examples":{"SystemBannerGlobalDefault":{"$ref":"#/components/examples/SystemBannerGlobalDefault"},"SystemBannerVariable":{"$ref":"#/components/examples/SystemBannerVariable"},"SystemBannerDefaultGlobal":{"$ref":"#/components/examples/SystemBannerDefaultGlobal"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Banner Profile Parcel for System feature profile","operationId":"DeleteBannerProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bannerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Banner-write"}},"/v1/feature-profile/sdwan/system/{systemId}/basic":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Basic Profile Feature for System feature profile","operationId":"GetBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemBasicPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemBasicExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Basic Profile Feature for System feature profile","operationId":"CreateBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-206"},"examples":{"Cedge_CG1_System_basic_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_basic_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-write"}},"/v1/feature-profile/sdwan/system/{systemId}/basic/{basicId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Basic Profile Feature by FeatureId for System feature profile","operationId":"GetBasicProfileFeatureByFeatureIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"basicId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemBasicPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemBasicExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Basic Profile Feature for System feature profile","operationId":"EditBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"basicId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Basic Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-207"},"examples":{"Cedge_CG1_System_basic_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_basic_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Basic Profile Feature for System feature profile","operationId":"DeleteBasicProfileFeatureForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"basicId","in":"path","description":"Profile Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Basic-write"}},"/v1/feature-profile/sdwan/system/{systemId}/bfd":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Bfd Profile Parcels for System feature profile","operationId":"GetBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemBfdPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemBfdExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Bfd Profile Parcel for System feature profile","operationId":"CreateBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Bfd Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-208"},"examples":{"SystemBfdParcelGlobalDefault":{"$ref":"#/components/examples/SystemBfdParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-write"}},"/v1/feature-profile/sdwan/system/{systemId}/bfd/{bfdId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Bfd Profile Parcel by parcelId for System feature profile","operationId":"GetBfdProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bfdId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemBfdPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemBfdExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Bfd Profile Parcel for System feature profile","operationId":"EditBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bfdId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Bfd Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-209"},"examples":{"SystemBfdParcelGlobalDefault":{"$ref":"#/components/examples/SystemBfdParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Bfd Profile Parcel for System feature profile","operationId":"DeleteBfdProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bfdId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Bfd-write"}},"/v1/feature-profile/sdwan/system/{systemId}/global":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Global Profile Parcels for System feature profile","operationId":"GetGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemGlobalPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemGlobalExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Global Profile Parcel for System feature profile","operationId":"CreateGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-210"},"examples":{"Cedge_CG1_System_Globalsettings_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_Globalsettings_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-write"}},"/v1/feature-profile/sdwan/system/{systemId}/global/{globalId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Global Profile Parcel by parcelId for System feature profile","operationId":"GetGlobalProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemGlobalPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemGlobalExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Global Profile Parcel for System feature profile","operationId":"EditGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Global Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-211"},"examples":{"Cedge_CG1_System_Globalsettings_parcel1":{"$ref":"#/components/examples/examples-Cedge_CG1_System_Globalsettings_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Global Profile Parcel for System feature profile","operationId":"DeleteGlobalProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"globalId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Global-write"}},"/v1/feature-profile/sdwan/system/{systemId}/logging":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Logging Profile Parcels for System feature profile","operationId":"GetLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemLoggingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemLoggingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Logging Profile Parcel for System feature profile","operationId":"CreateLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-212"},"examples":{"Cedge_CG1_System_Logging_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_Logging_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-write"}},"/v1/feature-profile/sdwan/system/{systemId}/logging/{loggingId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Logging Profile Parcel by parcelId for System feature profile","operationId":"GetLoggingProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemLoggingPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemLoggingExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Logging Profile Parcel for System feature profile","operationId":"EditLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Logging Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-213"},"examples":{"Cedge_CG1_System_Logging_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_Logging_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Logging Profile Parcel for System feature profile","operationId":"DeleteLoggingProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"loggingId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Logging-write"}},"/v1/feature-profile/sdwan/system/{systemId}/mrf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Mrf Profile Parcels for System feature profile","operationId":"GetMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemMrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemMrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Mrf Profile Parcel for System feature profile","operationId":"CreateMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Mrf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-214"},"examples":{"SystemMrfParcelGlobalDefault":{"$ref":"#/components/examples/SystemMrfParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-write"}},"/v1/feature-profile/sdwan/system/{systemId}/mrf/{mrfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Mrf Profile Parcel by parcelId for System feature profile","operationId":"GetMrfProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"mrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemMrfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemMrfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Mrf Profile Parcel for System feature profile","operationId":"EditMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"mrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Mrf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-214"},"examples":{"SystemMrfParcelGlobalDefault":{"$ref":"#/components/examples/SystemMrfParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Mrf Profile Parcel for System feature profile","operationId":"DeleteMrfProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"mrfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Mrf-write"}},"/v1/feature-profile/sdwan/system/{systemId}/ntp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ntp Profile Parcels for System feature profile","operationId":"GetNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemNtpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemNtpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Ntp Profile Parcel for System feature profile","operationId":"CreateNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ntp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-215"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-5"},"ntp_parcel_post1":{"$ref":"#/components/examples/ntp_parcel_post1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/ntp/{ntpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Ntp Profile Parcel by parcelId for System feature profile","operationId":"GetNtpProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemNtpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemNtpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Ntp Profile Parcel for System feature profile","operationId":"EditNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ntp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-216"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-5"},"ntp_parcel_put1":{"$ref":"#/components/examples/ntp_parcel_put1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Ntp Profile Parcel for System feature profile","operationId":"DeleteNtpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ntpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Ntp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/omp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Omp Profile Parcels for System feature profile","operationId":"GetOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemOmpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemOmpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Omp Profile Parcel for System feature profile","operationId":"CreateOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Omp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-217"},"examples":{"Cedge_CG1_System_omp_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_omp_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/omp/{ompId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Omp Profile Parcel by parcelId for System feature profile","operationId":"GetOmpProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ompId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemOmpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemOmpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Omp Profile Parcel for System feature profile","operationId":"EditOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ompId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Omp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-218"},"examples":{"Cedge_CG1_System_omp_parcel1":{"$ref":"#/components/examples/Cedge_CG1_System_omp_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Omp Profile Parcel for System feature profile","operationId":"DeleteOmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ompId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Omp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/security":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security for System feature profile","operationId":"GetSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Security for System feature profile","operationId":"CreateSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-219"},"examples":{"Security":{"$ref":"#/components/examples/Security"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-write"}},"/v1/feature-profile/sdwan/system/{systemId}/security/{securityId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Security by securityId for System feature profile","operationId":"GetSecurityBySecurityIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityId","in":"path","description":"Security ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemSecurityPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemSecurityExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update Security for System feature profile","operationId":"EditSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityId","in":"path","description":"Security ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Security Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-219"},"examples":{"Security":{"$ref":"#/components/examples/Security"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Security for System feature profile","operationId":"DeleteSecurityForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"securityId","in":"path","description":"Security ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Security-write"}},"/v1/feature-profile/sdwan/system/{systemId}/snmp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Snmp Profile Parcels for System feature profile","operationId":"GetSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanSystemSnmpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanSystemSnmpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Snmp Profile Parcel for System feature profile","operationId":"CreateSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Snmp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-220"},"examples":{"SNMPParcelGlobalDefault":{"$ref":"#/components/examples/SNMPParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-write"}},"/v1/feature-profile/sdwan/system/{systemId}/snmp/{snmpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Snmp Profile Parcel by parcelId for System feature profile","operationId":"GetSnmpProfileParcelByParcelIdForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanSystemSnmpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanSystemSnmpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Snmp Profile Parcel for System feature profile","operationId":"EditSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Snmp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-221"},"examples":{"SNMPParcelGlobalDefault":{"$ref":"#/components/examples/SNMPParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Snmp Profile Parcel for System feature profile","operationId":"DeleteSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"snmpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > System > Snmp-write"}},"/v1/feature-profile/sdwan/transport":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all SDWAN Feature Profiles with giving Family and profile type","operationId":"GetSdwanTransportFeatureProfiles","parameters":[{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Pagination limit","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a SDWAN Transport Feature Profile","operationId":"CreateSdwanTransportFeatureProfile","requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-22"},"examples":{"FeatureProfile1":{"$ref":"#/components/examples/FeatureProfile1"},"FeatureProfile2":{"$ref":"#/components/examples/FeatureProfile2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-9"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-write"}},"/v1/feature-profile/sdwan/transport/cellular-controller/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport CellularController Parcel Schema by Schema Type","operationId":"GetSdwanTransportCellularControllerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/cellular-controller/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/cellular-controller/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"}},"/v1/feature-profile/sdwan/transport/cellular-profile/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport CellularProfile Parcel Schema by Schema Type","operationId":"GetSdwanTransportCellularProfileParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/cellular-profile/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/cellular-profile/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-read"}},"/v1/feature-profile/sdwan/transport/ipv6-tracker/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport IPv6 Tracker Parcel Schema by Schema Type","operationId":"GetSdwanTransportIpv6TrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-tracker/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-tracker/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-read"}},"/v1/feature-profile/sdwan/transport/ipv6-trackergroup/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport IPv6 TrackerGroup Parcel Schema by Schema Type","operationId":"GetCedgeTransportIpv6TrackerGroupParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-trackergroup/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/ipv6-trackergroup/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-read"}},"/v1/feature-profile/sdwan/transport/management/vpn/interface/ethernet/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport ManagementVpn InterfaceEthernet Schema by Schema Type","operationId":"GetSdwanTransportManagementVpnInterfaceEthernetParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/interface/ethernet/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/management/vpn/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport ManagementVpn Parcel Schema by Schema Type","operationId":"GetSdwanTransportManagementVpnParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/management/vpn/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-read"}},"/v1/feature-profile/sdwan/transport/routing/bgp/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport RoutingBgp Parcel Schema by Schema Type","operationId":"GetSdwanTransportRoutingBgpParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/routing/bgp/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/routing/bgp/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-read"}},"/v1/feature-profile/sdwan/transport/t1-e1-controller/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport T1e1controller Parcel Schema by Schema Type","operationId":"GetCedgeTransportT1e1controllerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/t1-e1-controller/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/t1-e1-controller/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-read"}},"/v1/feature-profile/sdwan/transport/tracker/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport Tracker Parcel Schema by Schema Type","operationId":"GetSdwanTransportTrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/tracker/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/tracker/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-read"}},"/v1/feature-profile/sdwan/transport/trackergroup/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport TrackerGroup Parcel Schema by Schema Type","operationId":"GetCedgeTransportTrackerGroupParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/common/trackergroup/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/cellular/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn CellularInterface Schema by Schema Type","operationId":"GetSdwanTransportWanVpnCellularInterfaceParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/cellular/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/ethernet/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn InterfaceEthernet Schema by Schema Type","operationId":"GetSdwanTransportWanVpnInterfaceEthernetParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ethernet/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/gre/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport WanVpn InterfaceGre Schema by Schema Type","operationId":"GetCedgeTransportWanVpnInterfaceGreParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/gre/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/gre/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/ipsec/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn InterfaceIpsec Schema by Schema Type","operationId":"getSdwanProfileParcelSchema_1","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ipsec/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/ipsec/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/interface/serial/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a Cedge Transport WanVpn InterfaceSerial Schema by Schema Type","operationId":"GetCedgeTransportWanVpnInterfaceSerialParcelSchemaBySchema","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/serial/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/interface/serial/common/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-read"}},"/v1/feature-profile/sdwan/transport/wan/vpn/schema":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport WanVpn Parcel Schema by Schema Type","operationId":"GetSdwanTransportWanVpnParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/post/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}},"put":{"value":{"request":{"$ref":"schema/profileparcel/sdwan/transport/wan/vpn/put/request_schema.json#/$defs/Schema2HubGeneratedDocumentation/resolved"}}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"}},"/v1/feature-profile/sdwan/transport/{transportId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Transport Feature Profile with transportId","operationId":"GetSdwanTransportFeatureProfileByProfileId","parameters":[{"name":"transportId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Edit a SDWAN Transport Feature Profile","operationId":"EditSdwanTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","description":"Feature Profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"SDWAN Feature profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-23"},"examples":{"FeatureProfile-1":{"$ref":"#/components/examples/FeatureProfile-1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-10"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete Feature Profile","operationId":"DeleteSdwanTransportFeatureProfile","parameters":[{"name":"transportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Controller Profile Parcels for Transport feature profile","operationId":"GetCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportCellularControllerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportCellularControllerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Cellular Controller Profile Parcel for Transport feature profile","operationId":"CreateCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-222"},"examples":{"Cedge_CG1_Transport_CellularController_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_CellularController_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Controller Profile Parcel by parcelId for Transport feature profile","operationId":"GetCellularControllerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportCellularControllerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportCellularControllerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Cellular Controller Profile Parcel for Transport feature profile","operationId":"EditCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-223"},"examples":{"Cedge_CG1_Transport_CellularController_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_CellularController_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Cellular Controller Profile Parcel for Transport feature profile","operationId":"DeleteCellularControllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController associated Cellular Profile Parcels for transport feature profile","operationId":"GetCellularControllerAssociatedCellularProfileParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportCellularControllerCellularProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportCellularControllerCellularProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a cellularcontroller parcel with a cellularprofile Parcel for transport feature profile","operationId":"CreateCellularControllerAndCellularProfileParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Cellular Controller Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/cellular-profile/{cellularProfileId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController parcel associated CellularProfile Parcel by cellularProfileId for transport feature profile","operationId":"GetCellularControllerAssociatedCellularProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Cellular Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportCellularControllerCellularProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportCellularControllerCellularProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a CellularController parcel and a CellularProfile Parcel association for transport feature profile","operationId":"EditCellularControllerAndCellularProfileParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Cellular Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a CellularController parcel and a CellularProfile Parcel association for transport feature profile","operationId":"DeleteCellularControllerAndCellularProfileAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Cellular Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/gps":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController associated Gps Parcels for transport feature profile","operationId":"GetCellularControllerAssociatedGpsParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportCellularControllerGpsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportCellularControllerGpsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a cellularcontroller parcel with a gps Parcel for transport feature profile","operationId":"CreateCellularControllerAndGpsParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Cellular Controller Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-controller/{cellularControllerId}/gps/{gpsId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get CellularController parcel associated Gps Parcel by gpsId for transport feature profile","operationId":"GetCellularControllerAssociatedGpsParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Gps Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportCellularControllerGpsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportCellularControllerGpsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a CellularController parcel and a Gps Parcel association for transport feature profile","operationId":"EditCellularControllerAndGpsParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Gps ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a CellularController parcel and a Gps Parcel association for transport feature profile","operationId":"DeleteCellularControllerAndGpsAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularControllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Gps Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Profile Profile Parcels for Transport feature profile","operationId":"GetCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportCellularProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportCellularProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Cellular Profile Profile Parcel for Transport feature profile","operationId":"CreateCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-224"},"examples":{"Cedge_CG1_Transport_CellularProfile_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_CellularProfile_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/cellular-profile/{cellularProfileId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Cellular Profile Profile Parcel by parcelId for Transport feature profile","operationId":"GetCellularProfileProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportCellularProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportCellularProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Cellular Profile Profile Parcel for Transport feature profile","operationId":"EditCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Cellular Profile Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-225"},"examples":{"Cedge_CG1_Transport_CellularProfile_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_CellularProfile_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Cellular Profile Profile Parcel for Transport feature profile","operationId":"DeleteCellularProfileProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"cellularProfileId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Cellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-controller":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get eSim Cellular Controller Features for Transport feature profile","operationId":"GetEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportEsimcellularControllerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportEsimcellularControllerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a eSim Cellular Controller Feature for Transport feature profile","operationId":"CreateEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"eSim Cellular Controller Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-228"},"examples":{"Cedge_CG1_Transport_eSimCellularController_feature1Esim":{"$ref":"#/components/examples/Cedge_CG1_Transport_eSimCellularController_feature1Esim"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-controller/{esimCellularControllerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get eSim Cellular Controller Feature by Feature Id for Transport feature profile","operationId":"GetEsimCellularControllerProfileFeatureByFeatureIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularControllerId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportEsimcellularControllerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportEsimcellularControllerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a eSim Cellular Controller Feature for Transport feature profile","operationId":"EditEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularControllerId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Controller Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-229"},"examples":{"Cedge_CG1_Transport_eSimCellularController_feature1Esim":{"$ref":"#/components/examples/Cedge_CG1_Transport_eSimCellularController_feature1Esim"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a eSim Cellular Controller Feature for Transport feature profile","operationId":"DeleteEsimCellularControllerProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularControllerId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-profile":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get EsimCellular Profile Features for Transport feature profile","operationId":"GetEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportEsimcellularProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportEsimcellularProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a EsimCellular Profile Feature for Transport feature profile","operationId":"CreateEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-230"},"examples":{"Cedge_CG1_Transport_CellularProfile_feature1_eSim":{"$ref":"#/components/examples/Cedge_CG1_Transport_CellularProfile_feature1_eSim"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/esimcellular-profile/{esimCellularProfileId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get EsimCellular Profile Feature by Feature Id for Transport feature profile","operationId":"GetEsimCellularProfileByFeatureIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularProfileId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportEsimcellularProfilePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportEsimcellularProfileExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a EsimCellular Profile Feature for Transport feature profile","operationId":"EditEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularProfileId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"EsimCellular Profile Feature","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-231"},"examples":{"Cedge_CG1_Transport_CellularProfile_feature1_eSim":{"$ref":"#/components/examples/examples-Cedge_CG1_Transport_CellularProfile_feature1_eSim"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a EsimCellular Profile Feature for Transport feature profile","operationId":"DeleteEsimCellularProfileProfileFeatureForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"esimCellularProfileId","in":"path","description":"Feature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > eSimCellular Profile-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/gps":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Gps Profile Parcels for Transport feature profile","operationId":"GetGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportGpsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportGpsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Gps Profile Parcel for Transport feature profile","operationId":"CreateGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-226"},"examples":{"gpsParcelGlobalDefault":{"$ref":"#/components/examples/gpsParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/gps/{gpsId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Gps Profile Parcel by parcelId for Transport feature profile","operationId":"GetGpsProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportGpsPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportGpsExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Gps Profile Parcel for Transport feature profile","operationId":"EditGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Gps Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-227"},"examples":{"gpsParcelGlobalDefault":{"$ref":"#/components/examples/gpsParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Gps Profile Parcel for Transport feature profile","operationId":"DeleteGpsProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"gpsId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Gps-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 Tracker Profile Parcels for Transport feature profile","operationId":"GetIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportIpv6TrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportIpv6TrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a IPv6 Tracker Profile Parcel for Transport feature profile","operationId":"CreateIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-232"},"examples":{"Cedge_CG1_Transport_Tracker_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_Tracker_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-tracker/{ipv6-trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 Tracker Profile Parcel by parcelId for Transport feature profile","operationId":"GetIpv6TrackerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportIpv6TrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportIpv6TrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a IPv6 Tracker Profile Parcel for Transport feature profile","operationId":"EditIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-233"},"examples":{"Cedge_CG1_Transport_Tracker_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_Tracker_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a IPv6 Tracker Profile Parcel for Transport feature profile","operationId":"DeleteIpv6TrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 TrackerGroup Profile Parcels for Transport feature profile","operationId":"GetIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportIpv6TrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportIpv6TrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a IPv6 TrackerGroup Profile Parcel for Transport feature profile","operationId":"CreateIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-234"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"#/components/examples/common_track_group_cedge_parcel_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/ipv6-trackergroup/{ipv6-trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get IPv6 TrackerGroup Profile Parcel by parcelId for Transport feature profile","operationId":"GetIpv6TrackerGroupProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"IPv6 Tracker Group Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportIpv6TrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportIpv6TrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a IPv6 TrackerGroup Profile Parcel for Transport feature profile","operationId":"EditIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-234"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"#/components/examples/common_track_group_cedge_parcel_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a IPv6 TrackerGroup Profile Parcel for Transport feature profile","operationId":"DeleteIpv6TrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"IPv6 Tracker Group Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Ipv6 Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Management Vpn Profile Parcels for Transport feature profile","operationId":"GetManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportManagementVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportManagementVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Management Vpn Profile Parcel for Transport feature profile","operationId":"CreateManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-235"},"examples":{"Cedge_CG1_Transport_Management_Vpn_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_Management_Vpn_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Management Vpn Profile Parcel by parcelId for Transport feature profile","operationId":"GetManagementVpnProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportManagementVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportManagementVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Management Vpn Profile Parcel for Transport feature profile","operationId":"EditManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-236"},"examples":{"Cedge_CG1_Transport_Management_Vpn_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_Management_Vpn_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Management Vpn Profile Parcel for Transport feature profile","operationId":"DeleteManagementVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceEthernet Parcels for transport ManagementVpn Parcel","operationId":"GetInterfaceEthernetParcelsForTransportManagementVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportManagementVpnInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportManagementVpnInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a ManagementVpn InterfaceEthernet parcel for transport feature profile","operationId":"CreateManagementVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-237"},"examples":{"TransportManagementVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"#/components/examples/TransportManagementVpnInterfaceEthernetParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/management/vpn/{vpnId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get ManagementVpn InterfaceEthernet Parcel by ethernetId for transport feature profile","operationId":"GetManagementVpnInterfaceEthernetParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportManagementVpnInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportManagementVpnInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a ManagementVpn InterfaceEthernet Parcel for transport feature profile","operationId":"EditManagementVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Management Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-238"},"examples":{"TransportManagementVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"#/components/examples/TransportManagementVpnInterfaceEthernetParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a ManagementVpn InterfaceEthernet Parcel for transport feature profile","operationId":"DeleteManagementVpnInterfaceEthernetForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Management/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcels for Transport feature profile","operationId":"GetRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Bgp Profile Parcel for Transport feature profile","operationId":"CreateRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-239"},"examples":{"wan-bgp":{"$ref":"#/components/examples/wan-bgp"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Bgp Profile Parcel by parcelId for Transport feature profile","operationId":"GetRoutingBgpProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Bgp Profile Parcel for Transport feature profile","operationId":"EditRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-239"},"examples":{"wan-bgp":{"$ref":"#/components/examples/wan-bgp"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Bgp Profile Parcel for Transport feature profile","operationId":"DeleteRoutingBgpProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Bgp-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcels for Transport feature profile","operationId":"GetRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Routing Ospf Profile Parcel for Transport feature profile","operationId":"CreateRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-195"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"#/components/examples/ServiceOspfParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Routing Ospf Profile Parcel by parcelId for Transport feature profile","operationId":"GetRoutingOspfProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Routing Ospf Profile Parcel for Transport feature profile","operationId":"EditRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-195"},"examples":{"ServiceOspfParcelGlobalDefault":{"$ref":"#/components/examples/ServiceOspfParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Routing Ospf Profile Parcel for Transport feature profile","operationId":"DeleteRoutingOspfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospf-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all routing OSPFv3 IPv4 address family profile parcels for transport feature profile","operationId":"GetRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a routing OSPFv3 IPv4 address family profile parcel for transport feature profile","operationId":"CreateRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-196"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/WAN_OSPFv3_IPv4_AF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get the routing OSPFv3 IPv4 address family profile parcel by ID for transport feature profile","operationId":"GetRoutingOspfv3Ipv4AfProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a routing OSPFv3 IPv4 address family profile parcel for transport feature profile","operationId":"EditRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-196"},"examples":{"LAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/LAN_OSPFv3_IPv4_AF"},"WAN_OSPFv3_IPv4_AF":{"$ref":"#/components/examples/WAN_OSPFv3_IPv4_AF"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete the routing OSPFv3 IPv4 address family profile parcel by ID for transport feature profile","operationId":"DeleteRoutingOspfv3Ipv4AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv4-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get all routing OSPFv3 IPv6 address family profile parcels for transport feature profile","operationId":"GetRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a routing OSPFv3 IPv6 address family profile parcel for transport feature profile","operationId":"CreateRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-197"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"#/components/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"#/components/examples/WAN_OSPFv3_IPv6"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get the routing OSPFv3 IPv6 address family profile parcel by ID for transport feature profile","operationId":"GetRoutingOspfv3Ipv6AfProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a routing OSPFv3 IPv6 address family profile parcel for transport feature profile","operationId":"EditRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-197"},"examples":{"LAN_OSPFv3_IPv6":{"$ref":"#/components/examples/LAN_OSPFv3_IPv6"},"WAN_OSPFv3_IPv6":{"$ref":"#/components/examples/WAN_OSPFv3_IPv6"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete the routing OSPFv3 IPv6 address family profile parcel by ID for transport feature profile","operationId":"DeleteRoutingOspfv3Ipv6AfProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Routing/Ospfv3 IPv6-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/t1-e1-controller":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get T1e1controller Profile Parcels for Transport feature profile","operationId":"GetT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportT1E1ControllerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportT1E1ControllerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a T1e1controller Profile Parcel for Transport feature profile","operationId":"CreateT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"T1e1controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-240"},"examples":{"t_controllerParcel1":{"$ref":"#/components/examples/t_controllerParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/t1-e1-controller/{t1e1controllerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get T1e1controller Profile Parcel by parcelId for Transport feature profile","operationId":"GetT1e1controllerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"t1e1controllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportT1E1ControllerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportT1E1ControllerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a T1e1controller Profile Parcel for Transport feature profile","operationId":"EditT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"t1e1controllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"T1e1controller Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-240"},"examples":{"t_controllerParcel1":{"$ref":"#/components/examples/t_controllerParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a T1e1controller Profile Parcel for Transport feature profile","operationId":"DeleteT1e1controllerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"t1e1controllerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > T1E1 Controller-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcels for Transport feature profile","operationId":"GetTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Tracker Profile Parcel for Transport feature profile","operationId":"CreateTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-241"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"#/components/examples/examples-Cedge_CG1_Service_Tracker_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Tracker Profile Parcel by parcelId for Transport feature profile","operationId":"GetTrackerProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Tracker Profile Parcel for Transport feature profile","operationId":"EditTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-241"},"examples":{"Cedge_CG1_Service_Tracker_parcel1":{"$ref":"#/components/examples/examples-Cedge_CG1_Service_Tracker_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Tracker Profile Parcel for Transport feature profile","operationId":"DeleteTrackerProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcels for Transport feature profile","operationId":"GetTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a TrackerGroup Profile Parcel for Transport feature profile","operationId":"CreateTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-187"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"#/components/examples/common_track_group_cedge_parcel_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get TrackerGroup Profile Parcel by parcelId for Transport feature profile","operationId":"GetTrackerGroupProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a TrackerGroup Profile Parcel for Transport feature profile","operationId":"EditTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-187"},"examples":{"common_track_group_cedge_parcel_1":{"$ref":"#/components/examples/common_track_group_cedge_parcel_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a TrackerGroup Profile Parcel for Transport feature profile","operationId":"DeleteTrackerGroupProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Tracker Group-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wan Vpn Profile Parcels for Transport feature profile","operationId":"GetWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Wan Vpn Profile Parcel for Transport feature profile","operationId":"CreateWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-242"},"examples":{"Cedge_CG1_Transport_Wan_Vpn_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_Wan_Vpn_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Wan Vpn Profile Parcel by parcelId for Transport feature profile","operationId":"GetWanVpnProfileParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a Wan Vpn Profile Parcel for Transport feature profile","operationId":"EditWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-243"},"examples":{"Cedge_CG1_Transport_Wan_Vpn_parcel1":{"$ref":"#/components/examples/Cedge_CG1_Transport_Wan_Vpn_parcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a Wan Vpn Profile Parcel for Transport feature profile","operationId":"DeleteWanVpnProfileParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get Interface Cellular Parcels for transport Wan Vpn Parcel","operationId":"GetInterfaceCellularParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceCellularPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceCellularExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a wanvpn Cellular interface Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WanVpn Interface Cellular Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-244"},"examples":{"TransportWanVpnInterfaceCellularParcelGlobalDefault":{"$ref":"#/components/examples/TransportWanVpnInterfaceCellularParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceCellularIpv6TrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceCellularIpv6TrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-tracker/{ipv6-trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 Tracker Parcel by ipv6-trackerId for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceCellularIpv6TrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceCellularIpv6TrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceCellular parcel and a IPv6 Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceCellularAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceCellular and a IPv6 Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularAndIpv6TrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 TrackerGroup Parcels for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerGroupParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceCellularIpv6TrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceCellularIpv6TrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/ipv6-trackergroup/{ipv6-trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated IPv6 TrackerGroup Parcel by ipv6-trackergroupId for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedIpv6TrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceCellularIpv6TrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceCellularIpv6TrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceCellular parcel and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceCellularAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"IPv6 TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceCellular and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularAndIpv6TrackerGroupAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceCellularTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceCellularTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{cellularId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceCellular associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceCellularAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceCellularTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceCellularTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceCellular parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceCellular and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/cellular/{intfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get wanvpn Cellular interface Parcel by intfId for transport feature profile","operationId":"GetWanVpnInterfaceCellularParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"intfId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceCellularPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceCellularExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a wanvpn Cellular Interface Parcel for transport feature profile","operationId":"EditWanVpnInterfaceCellularParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"intfId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"WanVpn Cellular Interface Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-245"},"examples":{"TransportWanVpnInterfaceCellularParcelGlobalDefault":{"$ref":"#/components/examples/TransportWanVpnInterfaceCellularParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a wanvpn Cellular interface Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceCellularForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"intfId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceEthernet Parcels for transport WanVpn Parcel","operationId":"GetInterfaceEthernetParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceEthernet parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-246"},"examples":{"TransportWanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"#/components/examples/TransportWanVpnInterfaceEthernetParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceEthernet Parcel by ethernetId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceEthernetPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceEthernetExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceEthernet Parcel for transport feature profile","operationId":"EditWanVpnInterfaceEthernetParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-247"},"examples":{"TransportWanVpnInterfaceEthernetParcelGlobalDefault":{"$ref":"#/components/examples/TransportWanVpnInterfaceEthernetParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceEthernet Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceEthernetIpv6TrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceEthernetIpv6TrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-tracker/{ipv6-trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 Tracker Parcel by ipv6-trackerId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceEthernetIpv6TrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceEthernetIpv6TrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a IPv6 Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a IPv6 Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndIpv6TrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 TrackerGroup Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerGroupParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceEthernetIpv6TrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceEthernetIpv6TrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/ipv6-trackergroup/{ipv6-trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated IPv6 TrackerGroup Parcel by ipv6-trackergroupId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedIpv6TrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceEthernetIpv6TrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceEthernetIpv6TrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a IPv6 TrackerGroup Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndIpv6TrackerGroupAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipv6-trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceEthernetTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceEthernetTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceEthernetTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceEthernetTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated TrackerGroup Parcels for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerGroupParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceEthernetTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceEthernetTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ethernet/{ethernetId}/trackergroup/{trackergroupId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceEthernet associated TrackerGroup Parcel by trackergroupId for transport feature profile","operationId":"GetWanVpnInterfaceEthernetAssociatedTrackerGroupParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceEthernetTrackergroupPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceEthernetTrackergroupExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceEthernet parcel and a TrackerGroup Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceEthernet and a TrackerGroup Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceEthernetAndTrackerGroupAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackergroupId","in":"path","description":"TrackerGroup Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceGre Parcels for transport WanVpn Parcel","operationId":"GetInterfaceGreParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceGrePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceGreExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceGre parcel for transport feature profile","operationId":"CreateWanVpnInterfaceGreParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Gre Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-248"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-6"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre/{greId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceGre Parcel by greId for transport feature profile","operationId":"GetWanVpnInterfaceGreParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceGrePayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceGreExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceGre Parcel for transport feature profile","operationId":"EditWanVpnInterfaceGreParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Gre Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-248"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-6"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceGre Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceGreForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre/{greId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceGre associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceGreAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceGreTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceGreTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceGre parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceGreAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/gre/{greId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceGre associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceGreAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceGreTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceGreTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceGre parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceGreAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceGre and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceGreAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"greId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Gre-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceIpsec Parcels for transport WanVpn Parcel","operationId":"getListOfProfileParcels_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceIpsec parcel for transport feature profile","operationId":"createIpSecProfileParcel_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ethernet Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-249"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"#/components/examples/examples-WANVPNInterfaceIpsecParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec/{ipsecId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceIpsec Parcel by ethernetId for transport feature profile","operationId":"getProfileParcelByParcelId_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceIpsecPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceIpsecExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceIpsec Parcel for transport feature profile","operationId":"editProfileParcel_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Ipsec Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-249"},"examples":{"WANVPNInterfaceIpsecParcelGlobalDefault":{"$ref":"#/components/examples/examples-WANVPNInterfaceIpsecParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceIpsec Parcel for transport feature profile","operationId":"deleteProfileParcel_1","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec/{ipsecId}/tracker":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceIpsec associated Tracker Parcels for transport feature profile","operationId":"GetWanVpnInterfaceIpsecAssociatedTrackerParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceIpsecTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceIpsecTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/ipsec/{ipsecId}/tracker/{trackerId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpnInterfaceIpsec associated Tracker Parcel by trackerId for transport feature profile","operationId":"GetWanVpnInterfaceIpsecAssociatedTrackerParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceIpsecTrackerPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceIpsecTrackerExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpnInterfaceIpsec parcel and a Tracker Parcel association for transport feature profile","operationId":"EditWanVpnInterfaceIpsecAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpnInterfaceIpsec and a Tracker Parcel association for transport feature profile","operationId":"DeleteWanVpnInterfaceIpsecAndTrackerAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"trackerId","in":"path","description":"Tracker Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/serial":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get InterfaceSerial Parcels for transport WanVpn Parcel","operationId":"GetInterfaceSerialParcelsForTransportWanVpn","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnInterfaceSerialPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnInterfaceSerialExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a WanVpn InterfaceSerial parcel for transport feature profile","operationId":"CreateWanVpnInterfaceSerialParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Serial Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-250"},"examples":{"SerialParcel1":{"$ref":"#/components/examples/SerialParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/interface/serial/{serialId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn InterfaceSerial Parcel by serialId for transport feature profile","operationId":"GetWanVpnInterfaceSerialParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"serialId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnInterfaceSerialPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnInterfaceSerialExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn InterfaceSerial Parcel for transport feature profile","operationId":"EditWanVpnInterfaceSerialParcelForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"serialId","in":"path","description":"Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Wan Vpn Interface Serial Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-250"},"examples":{"SerialParcel1":{"$ref":"#/components/examples/SerialParcel1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn InterfaceSerial Parcel for transport feature profile","operationId":"DeleteWanVpnInterfaceSerialForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"serialId","in":"path","description":"Interface Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Serial-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn associated Routing Bgp Parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingBgpParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a wanvpn parcel with a routingbgp Parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingBgpParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Wan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/bgp/{bgpId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn parcel associated RoutingBgp Parcel by bgpId for transport feature profile","operationId":"GetWanVpnAssociatedRoutingBgpParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnRoutingBgpPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnRoutingBgpExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingBgpParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Bgp Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn parcel and a RoutingBgp Parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingBgpAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"bgpId","in":"path","description":"Routing Bgp Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospf":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn associated Routing Ospf Parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a wan/vpn parcel with a routing/ospf Parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingOspfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Lan Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospf/{ospfId}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WanVpn parcel associated RoutingOspf Parcel by ospfId for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnRoutingOspfPayload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnRoutingOspfExample"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WanVpn parcel and a RoutingOspf Parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingOspfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospf Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WanVpn parcel and a RoutingOspf Parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingOspfAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfId","in":"path","description":"Routing Ospf Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv4":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN associated routing OSPFv3 IPv4 address family parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv4AfParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WAN VPN parcel with a routing OSPFv3 parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingOspfv3Ipv4AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"WAN Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4Address Family Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv4/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN parcel associated OSPFv3 IPv4 parcel by ID for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv4AfParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv4 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnRoutingOspfv3Ipv4Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnRoutingOspfv3Ipv4Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingOspfv3IPv4AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv4 Address Family parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv4 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingOspfv3IPv4AssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv4 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv6":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN associated routing OSPFv3 IPv6 address family parcels for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv6AfParcelsForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Feature Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getListSdwanTransportWanVpnRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getListSdwanTransportWanVpnRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WAN VPN parcel with a routing OSPFv3 parcel for transport feature profile","operationId":"CreateWanVpnAndRoutingOspfv3Ipv6AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"WAN Vpn Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6Address Family Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnId}/routing/ospfv3/ipv6/{ospfv3Id}":{"get":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get WAN VPN parcel associated OSPFv3 IPv6 parcel by ID for transport feature profile","operationId":"GetWanVpnAssociatedRoutingOspfv3IPv6AfParcelByParcelIdForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv6 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSingleSdwanTransportWanVpnRoutingOspfv3Ipv6Payload"},"examples":{"get response example":{"$ref":"#/components/examples/getSingleSdwanTransportWanVpnRoutingOspfv3Ipv6Example"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-read"},"put":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Update a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"EditWanVpnAndRoutingOspfv3IPv6AfParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv6 Address Family parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Routing Ospfv3 IPv6 Address Family Profile Parcel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-79"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-8"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"},"delete":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Delete a WAN VPN parcel and a routing OSPFv3 parcel association for transport feature profile","operationId":"DeleteWanVpnAndRoutingOspfv3IPv6AssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ospfv3Id","in":"path","description":"Routing Ospfv3 IPv6 Address Family Parcel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/ipv6-tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceCellular parcel with a IPv6 Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/ipv6-trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceCellular parcel with a IPv6 TrackerGroup Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/cellular/{cellularId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceCellular parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceCellularAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"cellularId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Cellular-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/ipv6-tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a IPv6 Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndIpv6TrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/ipv6-trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a IPv6 TrackerGroup Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndIpv6TrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"IPv6 TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ethernet/{ethernetId}/trackergroup":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceEthernet parcel with a TrackerGroup Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceEthernetAndTrackerGroupParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ethernetId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"TrackerGroup Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ethernet-write"}},"/v1/feature-profile/sdwan/transport/{transportId}/wan/vpn/{vpnParcelId}/interface/ipsec/{ipsecId}/tracker":{"post":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Associate a WanVpnInterfaceIpsec parcel with a Tracker Parcel for transport feature profile","operationId":"CreateWanVpnInterfaceIpsecAndTrackerParcelAssociationForTransport","parameters":[{"name":"transportId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}},{"name":"vpnParcelId","in":"path","description":"VPN Profile Parcel ID","required":true,"schema":{"type":"string"}},{"name":"ipsecId","in":"path","description":"Interface Profile Parcel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Tracker Profile Parcel Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-78"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-3"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-7"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile > Transport > Wan/Vpn/Interface/Ipsec-write"}},"/v1/licensing/assign-licenses":{"post":{"tags":["Licensing - Next Generation"],"description":"Assign licenses to devices","operationId":"assignMSLALicenses","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignLicensesRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/licensing/devices":{"get":{"tags":["Licensing - Next Generation"],"description":"Retrieve list of all devices along with license details if assigned","operationId":"getMSLADevices","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevicesDetails"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/licensing/edit-licenses/{uuid}":{"get":{"tags":["Licensing - Next Generation"],"description":"Edit licenses associated to a device","operationId":"getLicenseByUuid","parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditLicenseResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/licensing/licenses":{"post":{"tags":["Licensing - Next Generation"],"description":"Get applicable licenses based on platform class","operationId":"getMSLALicenses","requestBody":{"description":"List of device UUIDs and filters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicensesRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicensesResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/licensing/release-licenses":{"put":{"tags":["Licensing - Next Generation"],"description":"Release licenses assigned to the devices","operationId":"releaseLicenses","requestBody":{"description":"List of devices for releasing licenses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseLicenses"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/licensing/sa-va-distribution":{"post":{"tags":["Licensing - Next Generation"],"description":"Get Smart account and virtual account distribution of selected licenses","operationId":"getSAVADistribution","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaVaDistributionRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaVaDistributionResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/multicloud/interconnect/gateways/{interconnect-gateway-name}":{"put":{"tags":["Multicloud Interconnect - Gateways"],"summary":"Edit Interconnect Gateway Information.","description":"Asynchronous API to update the Interconnect Gateway Information in vManage.","operationId":"updateInterconnectGateway_1","parameters":[{"name":"interconnect-gateway-name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Payload for Multicloud Interconnect Gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterconnectGatewayExtended"},"examples":{"Interconnect Megaport Gateways":{"description":"Interconnect Megaport Gateways","value":{"edgeType":"MEGAPORT","edgeAccountId":"ABCD-1234-CDEF","edgeGatewayName":"mp-gateway-name","description":"This is my Megaport gateway","region":"Cologix TOR1, Toronto, ON, Canada : Toronto","regionId":"10","siteName":"My_Megaport_Site","deviceUuid":"C8K-f7f6c42c-409d-11eb-9562-005056841be8","settings":{"instanceSize":"Small","softwareImageId":"C8000v 17.09.01a"},"mrfSettings":{"mrfRouterRole":"border","mrfTransportGateway":false}}},"Interconnect Equinix Gateways - MRF Enabled":{"description":"Interconnect Equinix Gateways - MRF Enabled","value":"{\n\t\"edgeType\": \"EQUINIX\",\n\t\"edgeAccountId\": \"ABCD-1234-CDEF\",\n\t\"edgeGatewayName\": \"eq-gateway-name\",\n\t\"description\": \"This is my Equinix Gateway\",\n\t\"region\": \"NY Metro\",\n\t\"regionId\": \"10\",\n\t\"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n\t\"siteName\": \"My_Equinix_Site\",\n\t\"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n\t\"mrfSettings\": {\n\t\t\"mrfRouterRole\": \"edge\",\n\t\t\"mrfTransportGateway\": false\n\t}\n\t\"settings\": {\n\t\t\"instanceSize\": \"Small\",\n\t\t\"softwareImageId\": \"CSR1000v 17.03.03\"\n\t}\n}"},"Interconnect ATT Gateways - Config Group based":{"description":"Interconnect ATT Gateways - Config Group based","value":"{\n\t\"edgeType\": \"ATT\",\n\t\"edgeAccountId\": \"ABCD-1234-CDEF\",\n\t\"edgeGatewayName\": \"att-gateway-name\",\n\t\"description\": \"This is my ATT Gateway\",\n\t\"region\": \"NY Metro\",\n\t\"regionId\": \"10\",\n\t\"siteName\": \"My_ATT_Site\",\n\t\"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n\t\"settings\": {\n\t\t\"instanceSize\": \"Small\",\n\t\t\"softwareImageId\": \"CSR1000v 17.03.03\"\n\t}\n\t\"configGroupSettings\": {\n\t\t\"configGroupName\": \"ATT-ICGW-CG1\",\n\t\t\"configGroupId\": \"a15fa637-7985-4833-a24c-c8db32d378e1\"\n\t}\n}"}}}},"required":true},"responses":{"200":{"description":"Interconnect Gateway Information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/policy-group":{"get":{"tags":["Policy - Policy Group"],"description":"Get a Policy Group by Solution","operationId":"GetPolicyGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyGroup"}},"examples":{"West coast retail stores":{"value":[{"description":" group for west coast retail stores","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"West coast retail stores","profiles":[{"description":"Profile file description","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"system feature profile","solution":"sdwan","type":"system"}],"solution":"sdwan","source":"retail_workflow","state":" Group Deployment state.Initial state Deployed "}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"},"post":{"tags":["Policy - Policy Group"],"description":"Create a new Policy Group","operationId":"CreatePolicyGroup","requestBody":{"description":"Policy Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-251"},"examples":{"CEDGE-PolicyGroup1-NY":{"$ref":"#/components/examples/CEDGE-PolicyGroup1-NY"},"CEDGE-PolicyGroup1-COPY":{"$ref":"#/components/examples/CEDGE-PolicyGroup1-COPY"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-11"},"examples":{"example_1":{"$ref":"#/components/examples/example_1"},"example_2":{"$ref":"#/components/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"}},"/v1/policy-group/{policyGroupId}":{"get":{"tags":["Policy - Policy Group"],"description":"Get a Policy Group by ID","operationId":"GetPolicyGroup","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyGroup"},"examples":{"West coast retail stores":{"value":{"description":" group for west coast retail stores","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"West coast retail stores","profiles":[{"description":"Profile file description","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"system feature profile","solution":"sdwan","type":"system"}],"solution":"sdwan","source":"retail_workflow","state":" Group Deployment state.Initial state Deployed "}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"},"put":{"tags":["Policy - Policy Group"],"description":"Edit a Policy Group","operationId":"EditPolicyGroup","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Policy Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-252"},"examples":{"CEDGE-PolicyGroup1-NY":{"$ref":"#/components/examples/CEDGE-PolicyGroup1-NY"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-12"},"examples":{"example_1":{"$ref":"#/components/examples/example_1"},"example_2":{"$ref":"#/components/examples/example_2"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"},"delete":{"tags":["Policy - Policy Group"],"description":"Delete Policy Group","operationId":"DeletePolicyGroup","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"deleteProfiles","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"}},"/v1/policy-group/{policyGroupId}/device/associate":{"get":{"tags":["Policy - Policy Group"],"description":"Get devices association with a policy group","operationId":"GetPolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-read"},"put":{"tags":["Policy - Policy Group"],"description":"Move the devices from one policy group to another","operationId":"UpdatePolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-253"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-7"},"example_2":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-example_2"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-write"},"post":{"tags":["Policy - Policy Group"],"description":"Create associations with device and a policy group","operationId":"CreatePolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-254"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-7"},"example_2":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-example_2"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-write"},"delete":{"tags":["Policy - Policy Group"],"description":"Delete Policy Group Association from devices","operationId":"DeletePolicyGroupAssociation","parameters":[{"name":"policyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-255"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-7"},"example_2":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-example_2"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device-write"}},"/v1/policy-group/{policyGroupId}/device/deploy":{"post":{"tags":["Policy - Policy Group"],"description":"deploy policy group to devices","operationId":"deployPolicyGroup","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-256"},"examples":{"example_1":{"$ref":"#/components/examples/Schema2HubGeneratedDocumentation-examples-example_1"},"example_2":{"$ref":"#/components/examples/Schema2HubGeneratedDocumentation-examples-example_2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-13"},"examples":{"example_1":{"$ref":"#/components/examples/$defs-Schema2HubGeneratedDocumentation-examples-example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device > Deploy-write"}},"/v1/policy-group/{policyGroupId}/device/variables":{"get":{"tags":["Policy - Policy Group"],"description":"Get device variables","operationId":"getPolicyGroupDeviceVariables","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}},{"name":"device-id","in":"query","description":"Comma separated device id's like d1,d2","schema":{"type":"string"}},{"name":"suggestions","in":"query","description":"Suggestions for possible values","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device variables":{"description":"Device variables","value":{"family":"sdwan","devices":[{"device-id":"C8K-fa8ecea0-541e-4544-a077-e18fcb963b49","variables":[]}],"groups":[{"name":"test_pg","group-variables":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"},"put":{"tags":["Policy - Policy Group"],"description":"assign values to device variables","operationId":"createPolicyGroupDeviceVariables","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-257"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-8"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Response":{"description":"Response","value":"[\n {\n \"device-id\": \"C8K-fa8ecea0-541e-4544-a077-e18fcb963b49\",\n }\n]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-write"},"post":{"tags":["Policy - Policy Group"],"description":"Fetch device variables","operationId":"fetchPolicyGroupDeviceVariables","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-258"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-2"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Device variables":{"description":"Device variables","value":{"family":"sdwan","devices":[{"device-id":"C8K-fa8ecea0-541e-4544-a077-e18fcb963b49","variables":[]}],"groups":[{"name":"test_pg","group-variables":[]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"}},"/v1/policy-group/{policyGroupId}/device/variables/schema":{"get":{"tags":["Policy - Policy Group"],"description":"get device variables schema","operationId":"getPolicyGroupDeviceVariablesSchema","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group-read"}},"/v1/policy-group/{policyGroupId}/device/{deviceId}/preview":{"post":{"tags":["Policy - Policy Group"],"description":"Get a preview of the configuration for a device","operationId":"getPolicyGroupDeviceConfigurationPreview","parameters":[{"name":"policyGroupId","in":"path","description":"Policy Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]},"empty":{"type":"boolean"}},"additionalProperties":{"type":"object","properties":{"valueType":{"type":"string","enum":["ARRAY","OBJECT","STRING","NUMBER","TRUE","FALSE","NULL"]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-14"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-4"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Policy Group > Device > Deploy-read"}},"/v1/reports":{"get":{"tags":["Scheduled Report Management"],"summary":"Get all report templates information","description":"Get all reports information","operationId":"getAllReportTemplates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSummaryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Scheduled Report Management"],"summary":"Create a new report template","description":"create a new report template","operationId":"createReportTemplate","requestBody":{"description":"Report Template Config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutiveSummaryReport"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/preview/download":{"get":{"tags":["Scheduled Report Management"],"summary":"Download a report preview file","description":"Download a report preview file","operationId":"downloadReportPreviewFile","parameters":[{"name":"templateType","in":"query","schema":{"type":"string","enum":["executive_summary","site_availability","link_availability","link_utilization","link_sla","app_usage","ips_events_collected","firewall_enforcement","malware_files_collected","internet_browsing"]}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}":{"get":{"tags":["Scheduled Report Management"],"summary":"Get the report template information by report ID","description":"Get the report template information by report ID","operationId":"getReportTemplateById","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSummaryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Scheduled Report Management"],"summary":"Modify the report template configuration","description":"Update the report template by report ID","operationId":"updateReportTemplate","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"updated report config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutiveSummaryReport"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Scheduled Report Management"],"summary":"Delete the report template by report ID","description":"Delete the report template and all report files associated with it","operationId":"deleteReportTemplate","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/action/{action}":{"put":{"tags":["Scheduled Report Management"],"summary":"User operations for report template","description":"User operations for specific report template, which includes activate,deactivate and run immediately","operationId":"ReportAction","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"action","in":"path","required":true,"schema":{"type":"string","enum":["start","stop","runnow"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportTemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/tasks":{"get":{"tags":["Scheduled Report Management"],"summary":"Get all report tasks detail information by report ID","description":"Get all report task detail information by report ID","operationId":"getAllReportTasksByReportId","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTaskQueryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/tasks/{taskId}":{"delete":{"tags":["Scheduled Report Management"],"summary":"Delete generated report task file by task ID","description":"Delete the report task file by task ID","operationId":"deleteReportTaskByTaskId","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskIdResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model400Error"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/reports/{reportId}/tasks/{taskId}/download":{"get":{"tags":["Scheduled Report Management"],"summary":"Download a report file","description":"Download a report file","operationId":"downloadReportDataFile","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/securedeviceonboarding/fetchSdoToken":{"post":{"tags":["Secure Device OnBoarding - SDO Token"],"description":"POST for fetching Secure Device Onboarding Token needed for Secure Device Onboarding APIs for eSim","operationId":"fetchSdoToken","requestBody":{"description":"Fetch SDO Token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailsForIdentityVerificationForSdoToken"},"examples":{"Request Payload Example for Fetching Secure Device Onboarding Token":{"description":"Request Payload Example for Fetching Secure Device Onboarding Token","value":{"sdoSessionId":"e01c5b71-b056-4602-b140-42221ccc3fec"}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/getUrlForSdoIdentityService":{"get":{"tags":["Secure Device OnBoarding - SDO Token"],"description":"Get URL for Secure Device Onboarding Identity Service that generates Session ID required for authentication to get Secure Device Onboarding token","operationId":"getUrlForSdoIdentityService","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"Get Secure Device Onboarding Identity Service Url Response Example":{"description":"Get Secure Device Onboarding Identity Service Url Response Example","value":{"sdoIdentityServiceUrl":"http://sdo.jasper.com"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/providercredentials":{"post":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Create service provider credentials","operationId":"createProviderCredentials","requestBody":{"description":"Create Provider Credentials","content":{"application/json":{"examples":{"Service Provider Credentials":{"description":"Service Provider Credentials","value":{"carrierName":"Singtel","accountId":"100023372","accountUserName":"testaa","apiKey":"d6fa2f9-5a7d-4af8-8ab5-4056f631","isDefault":false,"acceptTermsAndConditions":true}}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/providerscredentials":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get all providers credentials","operationId":"getAllAccounts","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountDetails"},"examples":{"Service Providers Credentials Response Example":{"description":"Service Providers Credentials Response Example","value":[{"carrierName":"Singtel","accountId":"100023372","accountUserName":"testaa","apiKey":"d6fa2f9-5a7d-4af8-8ab5-4056f631","isDefault":false,"acceptTermsAndConditions":true}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/rateplans":{"get":{"tags":["Secure Device Onboarding - Rate Plans"],"description":"Get rate plans by account Id","operationId":"getRatePlansByAcctId","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatePlansResponse"},"examples":{"Rate plans response example":{"description":"Rate plans response example","value":["QaAwtRP-180421030819","Monthly-Flexible-Pool","hphlr rp1"]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/registeredproviders":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get Registered Providers Info","operationId":"getProvidersInfo","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderInfo"},"examples":{"Registered Providers Response Example":{"description":"Registered Providers Response Example","value":"[{\"operatorName\":\"SingTel Test\",\"countryCode\":\"+1\",\"cmpUrl\":\"https://rws-jpotest.i.jasperwireless.com\",\"cmpType\":\"CC\",\" + \"\"contactInfoLine1\":\"3003 Bunker Hill lane \",\"contactInfoLine2\":\"$$$$$$$$$\",\"contactInfoLine3\":\"asdfv!!!!6578\",\"operatorLogoUrl\":\"https://jpotest.jasper.com/provision/logout\",\"termsAndConditions\":\"Do you accept our terms 1, If yes press Ok or Sorry you cannot use our service ,See you next time!!\"}]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/{accountId}/commplans":{"get":{"tags":["Secure Device Onboarding - Communication Plans"],"description":"Get communication plans by account Id","operationId":"getCommPlansByAcctId","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationPlansResponse"},"examples":{"Communication plans response example":{"description":"Communication plans response example","value":"[ \n\t {\n\t \"commPlanName\": \"vm cp sms data shared\",\n\t \"apns\":[{\"name\":\"M2MTEST\"}]\n\t \"lteApns\":[]\n\t \"lteEnabled\":false\n\t }\n\t ]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/securedeviceonboarding/{accountId}/providerCredentials":{"delete":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Delete provider credentials","operationId":"deleteProviderCredentials","parameters":[{"name":"accountId","in":"path","description":"Service User Account Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/{accountId}/providercredentials":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get provider credentials by account id","operationId":"getProviderCredentialsByAccountId","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountDetailsList"},"examples":{"Service Provider Credentials Response Example":{"description":"Service Provider Credentials Response Example","value":"{\n\t \"carrierName\": \"Singtel\",\n\t \"accountId\": \"100023372\",\n\t \"accountUserName\":\"testaa\" ,\n\t \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n\t \"isDefault\":true,\n\t \"acceptTermsAndConditions\":true,\n\t \"accountData\":{\n\t \"ratePlan\": \"vm fixed pool rp\",\n\t \"commPlan\": \"vm cp sms data shared\",\n\t \"apn\": \"123456789\",\n\t \"pdnType\": \"IPv4\",\n\t \"authType\": \"pap\",\n\t \"user\": \"admin\",\n\t \"password\": \"admin123\"\n\t }"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"},"put":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Edit service provider credentials","operationId":"editProviderCredentials","parameters":[{"name":"accountId","in":"path","description":"Service User Account ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Provider Credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderAccountDetails"},"examples":{"Update Provider Credentials":{"description":"Update Provider Credentials","value":"{\n\t \"carrierName\": \"Singtel\",\n\t \"accountId\": \"100023372\",\n\t \"accountUserName\":\"testaa\" ,\n\t \"apiKey\": \"d6fa2f9-5a7d-4af8-8ab5-4056f631\",\n\t \"isDefault\":true,\n\t \"acceptTermsAndConditions\":true,\n\t \"accountData\":{\n\t \"ratePlan\": \"vm fixed pool rp\",\n\t \"commPlan\": \"vm cp sms data shared\",\n\t \"apn\": \"123456789\",\n\t \"pdnType\": \"IPv4\",\n\t \"authType\": \"pap\",\n\t \"user\": \"admin\",\n\t \"password\": \"admin123\"\n\t }"}}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-write"}},"/v1/securedeviceonboarding/{deviceUUID}/deviceusage":{"get":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get device data usage using device uuid","operationId":"getDeviceDataUsage","parameters":[{"name":"deviceUUID","in":"path","description":"DeviceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceUsageDetails"},"examples":{"Device Usage Response Example":{"description":"Device Usage Response Example","value":"[{\n\t \"iccid\": \"8988216716970004975\",\n\t \"carrierName\": \"Singtel\",\n\t \"ratePlan\":\"hphlr rp1\" ,\n\t \"communicationPlan\": \"vm cp sms data shared\",\n\t \"ratePlanType\":\"Monthly - Pooled Subscriber\",\n\t \"currentDataUsage\":\"10MB\",\n\t \"ratePlanUsageLimit\": \"50MB\",\n\t \"otherEsimsDataUsage\": \"20MB\",\n\t }]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read"}},"/v1/service-insertion/service-chain-mapping":{"get":{"tags":["Service Chain Mapping"],"description":"Gets all the Service Chain Mapping with service chain definition name and service chain number.","operationId":"serviceChainMapping","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"serviceChainMapping":{"description":"serviceChainMapping","value":[{"serviceChainName":"SC-Firewall","serviceChainNumber":"SC1"}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"405":{"description":"Method not Supported"},"500":{"description":"Internal Server Error"}}}},"/v1/smart-licensing/association":{"get":{"tags":["SmartLicensing - Templates"],"description":"Get the devices associated with a template","operationId":"getDevicesForTemplate","parameters":[{"name":"templateId","in":"query","description":"template Id","schema":{"type":"string"},"example":"ae7e7b38-d8aa-4c56-a25e-80c73e68ec36"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example":{"description":"Example","$ref":"#/components/examples/AssociationResp"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/smart-licensing/license":{"get":{"tags":["SmartLicensing - Sync Licenses"],"description":"Get licenses from vManage db","operationId":"license","parameters":[{"name":"virtual_account_id","in":"query","description":"virtual_account_id","required":true,"schema":{"type":"string"},"example":702544},{"name":"licenseType","in":"query","description":"License type 'prepaid' or 'postpaid'","required":true,"schema":{"type":"string"},"example":"prepaid"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLicenseResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/smart-licensing/sync":{"post":{"tags":["SmartLicensing - Sync Licenses"],"description":"Sync licenses from CSSM to vManage db","operationId":"syncLicenses_2","requestBody":{"description":"Partner","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/smart-licensing/template":{"post":{"tags":["SmartLicensing - Templates"],"description":"Create and assign license template.","operationId":"saveTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveTemplateRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/smart-licensing/template/{templateId}":{"delete":{"tags":["SmartLicensing - Templates"],"description":"Delete a license template","operationId":"deleteTemplate","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/smart-licensing/user-settings":{"get":{"tags":["SmartLicensing - Sync Licenses"],"description":"Get smart licensing user settings","operationId":"getUserSettings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSettingsResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/v1/topology-group":{"get":{"tags":["Topology - Topology Group"],"description":"Get a Topology Group by Solution","operationId":"GetTopologyGroupBySolution","parameters":[{"name":"solution","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopologyGroup"}},"examples":{"West coast retail stores":{"value":[{"description":" group for west coast retail stores","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"West coast retail stores","profiles":[{"description":"Profile file description","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"system feature profile","solution":"sdwan","type":"system"}],"solution":"sdwan","source":"retail_workflow","state":" Group Deployment state.Initial state Deployed "}]}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-read"},"post":{"tags":["Topology - Topology Group"],"description":"Create a new Topology Group","operationId":"CreateTopologyGroup","requestBody":{"description":"Topology Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-259"},"examples":{"CEDGE-TopologyGroup1-NY":{"$ref":"#/components/examples/CEDGE-TopologyGroup1-NY"},"CEDGE-TopologyGroup1-COPY":{"$ref":"#/components/examples/CEDGE-TopologyGroup1-COPY"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"example":"TODO"}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-write"}},"/v1/topology-group/{topologyGroupId}":{"get":{"tags":["Topology - Topology Group"],"description":"Get a Topology Group by ID","operationId":"GetTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopologyGroup"},"examples":{"West coast retail stores":{"value":{"description":" group for west coast retail stores","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"West coast retail stores","profiles":[{"description":"Profile file description","id":"6fa14197-c25f-4a14-b81b-299de32ed2ca","name":"system feature profile","solution":"sdwan","type":"system"}],"solution":"sdwan","source":"retail_workflow","state":" Group Deployment state.Initial state Deployed "}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-read"},"put":{"tags":["Topology - Topology Group"],"description":"Edit a Topology Group","operationId":"EditTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Topology Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-260"},"examples":{"CEDGE-TopologyGroup1-NY":{"$ref":"#/components/examples/CEDGE-TopologyGroup1-NY"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"example":{"Solution":"Mobility","name":"Awesome Topology group"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-write"},"delete":{"tags":["Topology - Topology Group"],"description":"Delete Topology Group","operationId":"DeleteTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group-write"}},"/v1/topology-group/{topologyGroupId}/device/deploy":{"post":{"tags":["Topology - Topology Group"],"description":"deploy Topology group to devices","operationId":"deployTopologyGroup","parameters":[{"name":"topologyGroupId","in":"path","description":"Topology Group Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-261"},"examples":{}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-15"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-5"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group > Device > Activate-write"}},"/v1/topology-group/{topologyGroupId}/device/{deviceId}/preview":{"post":{"tags":["Topology - Topology Group"],"description":"Get a preview of the configuration for a device","operationId":"getTopologyGroupDeviceConfigurationPreview","parameters":[{"name":"topologyGroupId","in":"path","description":"Topology Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/request_schema-262"},"examples":{"example_1":{"$ref":"#/components/examples/request_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-9"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_schema-16"},"examples":{"example_1":{"$ref":"#/components/examples/response_schema_$defs-Schema2HubGeneratedDocumentation-examples-example_1-4"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group > Device > Activate-read"}},"/v2/data/device/statistics/interfacestatistics":{"get":{"tags":["Monitoring - Device Statistics Details V2"],"description":"Get device statistics data","operationId":"generateDeviceInterfaceStatisticsData","parameters":[{"name":"startDate","in":"query","description":"Start date (example:2023-1-1T00:00:00)","schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date (example:2023-1-1T00:00:00)","schema":{"type":"string"}},{"name":"scrollId","in":"query","description":"Scroll Id","schema":{"type":"string"}},{"name":"count","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"timeZone","in":"query","description":"Time zone","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceStatisticsRes"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/v2/data/device/statistics/interfacestatistics/doccount":{"get":{"tags":["Monitoring - Device Statistics Details V2"],"description":"Get response count of a query","operationId":"getCountWithInterfaceStatistics","parameters":[{"name":"startDate","in":"query","description":"Start date (example:2023-1-1T00:00:00)","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"End date (example:2023-1-1T00:00:00)","required":true,"schema":{"type":"string"}},{"name":"timeZone","in":"query","description":"Time zone (example:UTC)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocCountRes"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/v2/data/device/statistics/interfacestatistics/fields":{"get":{"tags":["Monitoring - Device Statistics Details V2"],"description":"Get statistics fields and types","operationId":"getStatDataFieldsByInterfaceStatistics","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Field"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write,dca"}},"/wani/recommendations":{"get":{"tags":["Wani Recommendations"],"summary":"Get recommendations from WANI","description":"API to get the recommendations obtained from WANI for a given tenant. This returns only valid recommendations based on expiry. It filters out recommendations that are inactive.","operationId":"getWaniRecommendations","parameters":[{"name":"siteId","in":"query","description":"The specific site id to get recommendations for, if empty get recommendations for all sites","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationsResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/wani/recommendations/applied":{"get":{"tags":["Wani Recommendations"],"summary":"Get recommendations that have been applied on vManage","description":"Per tenant api to check which Wani recommendations have been applied for a given tenant ","operationId":"getAppliedWaniRecommendations","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppliedRecommendationsRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/wani/{listType}/{listId}/listActivationStatus":{"get":{"tags":["Wani Recommendations"],"summary":"get if list is in activated wani policy","description":"Get if specified list is apart of a activated centralized policy, if it is the response also gives the centralized policy id, the users original defined centralized policy id, and if current list is apart of a active wani policy. ","operationId":"getListActivationStatus","parameters":[{"name":"listType","in":"path","required":true,"schema":{"type":"string"}},{"name":"listId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationStatusRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/wani/{policyType}/{policyId}/policyActivationStatus":{"get":{"tags":["Wani Recommendations"],"summary":"get if policy is in activated wani policy","description":"Get if specified policy is apart of a activated centralized policy, if it is the response also gives the centralized policy id, the users original defined centralized policy id, and if current policy is apart of a active wani policy. ","operationId":"getPolicyActivationStatus","parameters":[{"name":"policyType","in":"path","required":true,"schema":{"type":"string"}},{"name":"policyId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivationStatusRes"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/accesscode":{"get":{"tags":["System - Cloud Service Webex"],"description":"Webex Access Code Details","operationId":"webexAccessCode","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessCodeResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/datacenter":{"post":{"tags":["System - Cloud Service Webex"],"description":"TEMP-Insert webex data center details manually for test setup","operationId":"getWebexDataCenters","requestBody":{"description":"Webex Data Center","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebexDataCenter"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["System - Cloud Service Webex"],"description":"Delete webex data center data in DB","operationId":"deleteWebexDataCenters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/datacenter/sync":{"post":{"tags":["System - Cloud Service Webex"],"description":"TEMP-Update webex data center data in DB with data from Webex API","operationId":"updateWebexDataCenters","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/datacenter/syncstatus":{"get":{"tags":["System - Cloud Service Webex"],"description":"Get webex data center sync status from DB","operationId":"getWebexDataCentersSyncStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncStatusResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["System - Cloud Service Webex"],"description":"Set webex data center sync needed to false","operationId":"setWebexDataCentersSyncStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/webex/redirect":{"get":{"tags":["System - Cloud Service Webex"],"description":"Redirect Info","operationId":"redirectWebexDataCenters","parameters":[{"name":"code","in":"query","description":"code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectCodeResponse"}}}},"400":{"description":"bad input parameter"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"APIKey":{"type":"object","properties":{"vipObjectType":{"type":"string","example":"object"},"vipType":{"type":"string","example":"constant"},"vipValue":{"type":"string","example":"sdfsd"},"vipVariableName":{"type":"string","example":"system_api_key"}},"description":"API secret information"},"APISecret":{"type":"object","properties":{"vipNeedsEncryption":{"type":"boolean","example":true},"vipObjectType":{"type":"string","example":"object"},"vipType":{"type":"string","example":"constant"},"vipValue":{"type":"string","example":"$CRYPT_CLUSTER$0y3Eq1EFF5Hurtda/Z9eHQ==$gtnBC/bVtpuhWX5r905iYw=="},"vipVariableName":{"type":"string","example":"system_api_secret"}},"description":"API key information"},"Aaa":{"type":"object","properties":{"accounting":{"type":"boolean"},"adminAuthOrder":{"type":"boolean"},"auditDisable":{"type":"boolean"},"authFallback":{"type":"boolean"},"authOrder":{"maxItems":3,"minItems":1,"type":"array","items":{"type":"string","enum":["local","radius","tacacs"]}}}},"AaaServerInfo":{"required":["aaaServersParcelId","radiusServerName"],"type":"object","properties":{"aaaServersParcelId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string"},"radiusServerName":{"type":"string"}}},"AccessCodeResponse":{"type":"object","properties":{"code":{"type":"string","example":"ZDI3MGEyYzQtNmFlNS00NDNhLWFlNzAtZGVjNjE0MGU1OGZmZWNmZDEwN2ItYTU"}}},"AccountData":{"required":["apn","authMethod","commPlan","pdnType","ratePlan"],"type":"object","properties":{"apn":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Access Point Name","example":"103334b644"},"authMethod":{"maxLength":2147483647,"minLength":1,"pattern":"(^none$|^pap$|^chap$|^pap_or_chap$)","type":"string","description":"Authentication method.","example":"pap"},"commPlan":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the communication plan associated with default provider.","example":"vm cp sms data shared"},"password":{"type":"string","description":"Password of the user.","example":"admin123"},"pdnType":{"maxLength":2147483647,"minLength":1,"pattern":"(^IPv4$|^IPv6$|^IPv4v6$)","type":"string","description":"Data packet protocol version","example":"IPv4"},"ratePlan":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the rate plan associated with default provider.","example":"vm fixed pool rp"},"user":{"type":"string","description":"User name.","example":"admin"}}},"ActivateBody":{"type":"object","properties":{"description":{"type":"string","example":"This is a description"},"pxGridPassword":{"type":"string","example":"vjvR4vnzoLSAFPn9"},"pxGridUserName":{"type":"string","example":"vIPtela_Inc_Regression_testUser123"}},"description":"Body for PxGrid node activate on ISE"},"ActivateResponse":{"type":"object","properties":{"accountState":{"type":"string","example":"PENDING"},"version":{"type":"string","example":"2.0.3.24"}},"description":"Response from PxGrid node activation on ISE, account PENDING on activated ENABLED after approve"},"ActivationStatusRes":{"required":["centralizedPolicyActive","isActivatedByVSmarts"],"type":"object","properties":{"activatedCentralizedPolicyId":{"type":"string","format":"uuid","example":"efec8edf-04ce-4a99-86d5-441099f52b79"},"centralizedPolicyActive":{"type":"boolean","example":true},"isActivatedByVSmarts":{"type":"boolean","example":true},"referredInActiveWaniPolicy":{"type":"boolean","example":true},"userDefinedPolicyId":{"type":"string","format":"uuid","example":"5b55dbd3-35db-4358-a1a6-ee59da9b9d2d"}}},"ActiveFlowResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseData"}}},"description":"Active flows data response payload"},"AdminTechCreateReq":{"type":"object","properties":{"custom-commands":{"type":"array","example":"custom-commands: [\"show version\", \"show platform\"]","items":{"type":"string","example":"custom-commands: [\"show version\", \"show platform\"]"}},"device-type":{"type":"string","example":"vmanage"},"deviceIP":{"type":"string","example":"10.3.0.1"},"exclude-cores":{"type":"boolean","example":true},"exclude-logs":{"type":"boolean","example":true},"exclude-tech":{"type":"boolean","example":false},"tech-filter":{"type":"array","items":{"type":"string"}}}},"AdminTechListReq":{"type":"object","properties":{"deviceIP":{"type":"string","example":"10.3.0.1"}}},"AdminTechListRes":{"type":"object","properties":{"creationTime":{"type":"integer","format":"int64","example":1590186370340},"fileName":{"type":"string","example":"10.3.0.1-20200522-102611-admin-tech.tar.gz"},"requestTokenId":{"type":"string","example":"10540562-6759-40ad-917f-71d4b81ff37d"},"size":{"type":"integer","format":"int32","example":1081406},"state":{"type":"string","example":"done"}}},"AdminTechReq":{"type":"object","properties":{"deviceIP":{"type":"string","example":"10.3.0.1"},"fileName":{"type":"string","example":"10.3.0.1-20200522-102611-admin-tech.tar.gz"}}},"AdminTechsRes":{"type":"object","properties":{"creationTime":{"type":"integer","format":"int64","example":1590186370340},"deviceIP":{"type":"string","example":"10.3.0.1"},"fileName":{"type":"string","example":"10.3.0.1-20200522-102611-admin-tech.tar.gz"},"local-system-ip":{"type":"string","example":"10.3.0.1"},"requestTokenId":{"type":"string","example":"10540562-6759-40ad-917f-71d4b81ff37d"},"size":{"type":"integer","format":"int32","example":1081406},"state":{"type":"string","example":"done"},"tac_state":{"type":"string","example":"notStarted"}}},"AdminTechsUploadReq":{"type":"object","properties":{"requestTokenId":{"type":"string","example":"ea8cb172-61c4-47e0-8957-ac83b384f53e"},"sr_number":{"type":"string","example":"69131837254"},"token":{"type":"string","example":"9b42986QTUc"},"vpn":{"type":"string","example":"VPN 0"}}},"AdvancedRadioSetting":{"type":"object","properties":{"channelPowerSettings":{"$ref":"#/components/schemas/ChannelPowerSettings"},"countryRegionSettings":{"$ref":"#/components/schemas/CountryRegionSettings"}}},"AggFlowResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Aggregated flow data schema for GET response","items":{"$ref":"#/components/schemas/AggFlowResponsePayloadInner"}},"AggFlowResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Aggregated flow data schema for GET response"},"Alarm":{"type":"object","properties":{"acknowledged":{"type":"boolean"},"active":{"type":"boolean"},"cleared_by":{"type":"string","format":"uuid","example":"0a0dca23-11d5-4014-bfbb-976d3c6de492"},"cleared_events":{"type":"array","items":{"type":"string","format":"uuid"}},"cleared_time":{"type":"integer","format":"int64","example":1652894923722},"component":{"type":"string","example":"Schedule Telemetry collection"},"consumed_events":{"type":"array","items":{"$ref":"#/components/schemas/OneOfAlarmConsumedEventsItems"}},"devices":{"type":"array","items":{"$ref":"#/components/schemas/AlarmDevices"}},"entry_time":{"type":"integer","format":"int64","example":1652906591837},"eventname":{"type":"string","example":"telemetry-data-collection-failure"},"id":{"type":"string","example":"HHbp2IABUbH5BDy9BhJe"},"message":{"type":"string","example":"Scheduled telemetry data collection failed on 19.19.19.1"},"possible_causes":{"type":"array","items":{"type":"string"}},"receive_time":{"type":"integer","format":"int64"},"rule_name_display":{"type":"string","example":"Telemetry data save failed"},"rulename":{"type":"string","example":"cpu-usage"},"severity":{"type":"string","enum":["Minor","Major","Critical","Medium"]},"severity_number":{"type":"integer","format":"int64","example":4},"site_id":{"type":"integer","format":"int64","example":100},"statcycletime":{"type":"integer","format":"int64"},"suppressed":{"type":"boolean","example":false},"suppressed_by":{"type":"object","example":{"system-ip":{"type":"string","example":"172.16.255.11"},"component":{"type":"string","example":"BFD"}}},"system_ip":{"type":"string","example":"172.16.255.26"},"tenant":{"type":"string","example":"default"},"type":{"type":"string","example":"Telemetry data save failed"},"uuid":{"type":"string","format":"uuid","example":"f6f83721-3a69-42d1-841f-94e015957fb7"},"values":{"type":"array","items":{"$ref":"#/components/schemas/GeneralSchema"}},"values_short_display":{"type":"array","items":{"$ref":"#/components/schemas/GeneralSchema"}}},"description":"Represents any kind of alarm"},"AlarmAggregation":{"type":"object","properties":{"count":{"type":"integer","format":"int64","example":6},"entry_time":{"type":"integer","format":"int64","example":1653575400000},"severity":{"type":"string","enum":["MINOR","MAJOR","MEDIUM","CRITICAL"]}}},"AlarmAggregationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AlarmAggregation"},"entryTimeList":{"type":"array","items":{"type":"integer","format":"int64"}}}},"AlarmCount":{"type":"object","properties":{"cleared_count":{"type":"number","example":718},"count":{"type":"number","example":13}}},"AlarmCountPost":{"type":"object","properties":{"count":{"type":"number","example":12}}},"AlarmCountPostResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AlarmCountPost"}},"AlarmCountResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AlarmCount"}},"AlarmDevices":{"type":"object","properties":{"system-ip":{"type":"string","example":"19.19.19.1"}}},"AlarmQueryInputResponse":{"type":"object","properties":{"component":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"severityOptions":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"timeOptions":{"type":"array","items":{"$ref":"#/components/schemas/TimeOptions"}}}},"AlarmResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Alarm"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"AlarmResponse is used for GET/POST /alarms call."},"AlarmSeverityMapping":{"type":"object","properties":{"associatedAlarms":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"key":{"type":"string","example":"Critical"},"value":{"type":"string","example":"Critical"}}},"AlarmSeverityMappingResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AlarmSeverityMapping"}},"AlarmStatsResponse":{"type":"object","properties":{"Correlation DB Manipulator":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EventStats"}},"Correlation Engine":{"$ref":"#/components/schemas/AlarmStatsResponseCorrelationEngine"},"Link Update Correlator":{"type":"object","additionalProperties":{"type":"string"}}}},"AlarmStatsResponseCorrelationEngine":{"type":"object","properties":{"Added Events":{"type":"integer","format":"int32","example":89}}},"AlarmTopic":{"type":"object","properties":{"device-ip":{"type":"string","example":"172.16.255.11"},"server-ip":{"type":"string","example":"10.0.105.39"},"topic":{"type":"string","example":"AlarmEvent3"}}},"AlarmsClearBody":{"required":["alarm_uuid"],"type":"object","properties":{"alarm_uuid":{"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"}}},"AlarmsMarkviewedBody":{"type":"object","properties":{"uuid":{"type":"array","items":{"type":"string"}}}},"AllOfcloudGatewayPostSettings":{"type":"object","properties":{"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]*$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]*$","type":"string"},"instanceSize":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string"},"ipSubnetPool":{"pattern":"^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$","type":"string"},"name":{"pattern":"^[a-zA-Z_]*$","type":"string"},"networkTier":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"pattern":"^[0-9]*$","type":"string","description":"Used for Azure/Azure GovCloud Custom settings"},"softwareImageId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"tunnelCount":{"pattern":"^[0-9]*$","type":"string","description":"Tunnel Count for AWS Connect based and branch connect"}}},"AllOfcloudWidgetCgwDeviceStatus":{"type":"object","properties":{"count":{"type":"number"},"name":{"type":"string"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/WidgetStatusStatusList"}},"unreachableCount":{"type":"number"}}},"AllOfhostVpcTagPostHostVpcsItems":{"required":["accountId","cloudType","hostVpcId","region","vnetId"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"hostVpcId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"label":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroups":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for AWS, AWS GovCloud and GCP cloud types"},"AllOfhostVpcTagPostVnetsItems":{"required":["accountId","cloudType","hostVpcId","region","vnetId"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cgwAttachment":{"pattern":"^[\\w.-]{1,128}$","type":"string"},"cgwAutoAttachmentFlag":{"type":"boolean"},"cloudType":{"type":"string"},"hostVpcId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"label":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroups":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for Azure and Azure GovCloud cloud types"},"AllOfhostVpcTagPutHostVpcsItems":{"required":["accountId","cloudType","hostVpcId","region","vnetId"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cgwAttachment":{"pattern":"^[\\w.-]{1,128}$","type":"string"},"cgwAutoAttachmentFlag":{"type":"boolean"},"cloudType":{"type":"string"},"hostVpcId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"interconnectTag":{"pattern":"^(Yes|No)$","type":"string"},"label":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroups":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"tag":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"vnetId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for AWS, AWS GovCloud and GCP cloud types"},"AllOfhostVpcTagPutVnetsItems":{"required":["accountId","cloudType","hostVpcId","region","vnetId"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cgwAttachment":{"pattern":"^[\\w.-]{1,128}$","type":"string"},"cgwAutoAttachmentFlag":{"type":"boolean"},"cloudType":{"type":"string"},"hostVpcId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"id":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"interconnectTag":{"pattern":"^(Yes|No)$","type":"string"},"label":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroups":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"tag":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"vnetId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"}},"description":"Used for Azure and Azure GovCloud cloud types"},"AllOfupdateCgwSettings":{"type":"object","properties":{"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]*$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]*$","type":"string"},"instanceSize":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string"},"ipSubnetPool":{"pattern":"^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$","type":"string"},"name":{"pattern":"^[a-zA-Z_]*$","type":"string"},"networkTier":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"pattern":"^[0-9]*$","type":"string","description":"Used for Azure/Azure GovCloud Custom settings"},"softwareImageId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"tunnelCount":{"pattern":"^[0-9]*$","type":"string","description":"Tunnel Count for AWS Connect based and branch connect"}}},"AnalyzeCliConfig":{"required":["deviceUuid"],"type":"object","properties":{"cli":{"type":"string","description":"modeled cli config","example":"interface GigabitEthernet3\\n no shutdown\\n negotiation auto\\nexit\\n"},"deviceUuid":{"type":"string","description":"device UUID","example":"d8ac4576-7085-4d51-a6a1-f09600755677"},"ioscli":{"type":"string","description":"unmodeled cli config","example":"vrf definition Mgmt-intf\\n address-family ipv4\\n exit-address-family\\n !\\n!"}},"description":"Payload/body schema for analyze cli config "},"ApiReKeyDevice":{"type":"object","properties":{"deviceId":{"type":"string"}}},"ApiReKeyDeviceList":{"type":"object","properties":{"deviceList":{"type":"array","items":{"$ref":"#/components/schemas/ApiReKeyDevice"}}}},"Apn":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"description":"List of APNs associated with the Comm Plan","example":"[{name:M2MTEST}]"},"AppQosDataResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"QoS Application data schema for GET response","items":{"$ref":"#/components/schemas/AppQosDataResponsePayloadInner"}},"AppQosDataResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"QoS Application data schema for GET response"},"AppQosStateResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"QoS Application state schema for GET response","items":{"$ref":"#/components/schemas/AppQosStateResponsePayloadInner"}},"AppQosStateResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"QoS Application state schema for GET response"},"AppRouteAggResp":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":5},"entry_time":{"type":"string","example":"1674813600000"},"local_color":{"type":"string","example":"3g"},"loss_percentage":{"type":"integer","format":"int32","example":0}}},"AppRouteAggRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteAggResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"interface aggregation response with page info"},"AppRouteAppAggResp":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppRouteAppAggRespInner"}},"AppRouteAppAggRespInner":{"type":"object","properties":{"latency":{"type":"string"}}},"AppRouteDocCountResponse":{"type":"object","properties":{"dataType":{"type":"string"},"property":{"type":"string"}}},"AppRouteFECAggResp":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppRouteFECAggRespInner"}},"AppRouteFECAggRespInner":{"type":"object","properties":{"count":{"type":"number"},"entry_time":{"type":"string"},"fecLossRecovery":{"type":"string"},"loss_percentage":{"type":"number"},"name":{"type":"string"},"proto":{"type":"string"},"state":{"type":"string"}}},"AppRouteResp":{"type":"object","properties":{"device_model":{"type":"string"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"fec_re":{"type":"integer","format":"int32"},"fec_rx":{"type":"integer","format":"int64"},"fec_tx":{"type":"integer","format":"int64"},"host_name":{"type":"string"},"id":{"type":"string"},"jitter":{"type":"integer","format":"int32"},"latency":{"type":"number"},"local_color":{"type":"string"},"local_system_ip":{"type":"string"},"loss":{"type":"integer","format":"int32"},"loss_percentage":{"type":"integer","format":"int32"},"name":{"type":"string"},"proto":{"type":"string"},"remote_color":{"type":"string"},"remote_system_ip":{"type":"string"},"rx_octets":{"type":"integer","format":"int64"},"rx_pkts":{"type":"integer","format":"int64"},"sla_class_list":{"type":"string"},"sla_class_names":{"type":"string"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"statcycletime":{"type":"string"},"state":{"type":"string"},"tenant":{"type":"string"},"total":{"type":"integer","format":"int32"},"tunnel_color":{"type":"string"},"tx_octets":{"type":"number"},"tx_pkts":{"type":"integer","format":"int64"},"vdevice_name":{"type":"string"},"vip_idx":{"type":"integer","format":"int32"},"vmanage_system_ip":{"type":"string"},"vqoe_score":{"type":"integer","format":"int32"}},"description":"app route specific response"},"AppRouteRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"app route response with page info"},"AppRouteTlocResp":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppRouteTlocRespInner"}},"AppRouteTlocRespInner":{"type":"object","properties":{"count":{"type":"number"},"local_tloc":{"type":"string"},"rx_octets":{"type":"number"},"siteid":{"type":"string"},"tx_octets":{"type":"number"}}},"AppRouteTransportResp":{"type":"object","properties":{"app_probe_class":{"type":"string"},"color":{"type":"string","example":"3g"},"entry_time":{"type":"string","example":"1674813600000"},"jitter":{"type":"string","example":"0"},"latency":{"type":"integer","format":"int32","example":5},"loss_percentage":{"type":"integer","format":"int32","example":0}}},"AppRouteTunnelSummary":{"type":"object","properties":{"app_probe_class":{"type":"string"},"entry_time":{"type":"string"},"jitter":{"type":"integer","format":"int32","example":0},"latency":{"type":"number"},"loss_percentage":{"type":"number"},"name":{"type":"string","example":"172.16.255.11:lte-172.16.255.16:3g"},"rx_octets":{"type":"integer","format":"int32"},"tx_octets":{"type":"integer","format":"int32"}}},"AppRouteTunnenSummarResp":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppRouteTunnelSummary"}}}},"ApplicationHeatMapDetail":{"required":["fair_site","good_site","poor_site"],"type":"object","properties":{"fair_site":{"type":"integer","format":"int32","example":1},"good_site":{"type":"integer","format":"int32","example":10},"poor_site":{"type":"integer","format":"int32","example":1}}},"ApplicationSiteChartItem":{"required":["entry_time","qoe"],"type":"object","properties":{"entry_time":{"type":"integer","format":"int64","example":1639897200000},"qoe":{"type":"number","format":"double","example":9}}},"ApplicationSiteItem":{"required":["health","jitter","latency","loss","path"],"type":"object","properties":{"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"jitter":{"type":"number","format":"double","example":1},"latency":{"type":"number","format":"double","example":10},"loss":{"type":"number","format":"double","example":1},"path":{"type":"string","example":"Tunnel3->SIG"},"qoe":{"type":"number","format":"double","example":9}}},"ApplicationSitesItem":{"required":["fair_path","good_path","health","poor_path","siteid"],"type":"object","properties":{"fair_path":{"type":"integer","format":"int32","example":1},"good_path":{"type":"integer","format":"int32","example":10},"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"poor_path":{"type":"integer","format":"int32","example":1},"siteid":{"type":"string","example":"100"}}},"ApplicationsResponseNoUUID":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"object"}},"ApplicationsSiteItem":{"required":["application","family","health","jitter","latency","loss"],"type":"object","properties":{"application":{"type":"string","example":"http"},"family":{"type":"string","example":"audio"},"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"jitter":{"type":"number","format":"double","example":1},"latency":{"type":"number","format":"double","example":10},"loss":{"type":"number","format":"double","example":1}}},"ApplicationsSitesItem":{"required":["application","fair_site","family","good_site","health","poor_site"],"type":"object","properties":{"application":{"type":"string","example":"http"},"fair_site":{"type":"integer","format":"int32","example":1},"family":{"type":"string","example":"audio"},"good_site":{"type":"integer","format":"int32","example":10},"health":{"pattern":"(good|fair|poor)","type":"string","example":"good"},"poor_site":{"type":"integer","format":"int32","example":1}}},"AppliedFilters":{"type":"object","properties":{"billingType":{"type":"string","example":"Prepaid"},"licenseClassification":{"type":"string","example":"Advantage"}}},"AppliedRecommendationsRes":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AppliedRecommendationsResEntry"}},"AppliedRecommendationsResEntry":{"required":["actionId","appClassName","last updated","recommendationDef","siteId","state"],"type":"object","properties":{"actionId":{"type":"string","example":"MYhj3JBjAr"},"appClassName":{"type":"string","example":"office365"},"last updated":{"type":"string","example":"09 Apr 2023 21:31:51 UTC"},"recommendationDef":{"type":"string","example":"{\"tenantId\":\"jSZn6hVkvr\",\"actionId\":\"MYhj3JBjAr\",\"actionType\":\"SR\",\"appClass\":\"office365\",\"windowStart\":\"2023-03-22T02:00:00+00:00\",\"windowEnd\":\"2023-04-09T23:00:00+00:00\",\"isActive\":true,\"srcEndpointId\":\"SgaEHHOs38\",\"dstEndpointId\":null,\"metadata\":{\"defaultPathType\":\"Tunnel\",\"defaultInterfaceIds\":[\"public-internet\",\"mpls\"],\"recommendedPathType\":\"Tunnel\",\"recommendedInterfaceIds\":[\"public-internet\"]},\"predDefaultProbSlaViolation\":0.24967608,\"predRecommendedProbSlaViolation\":5.022502E-4,\"predNumSessions\":null,\"modelName\":null,\"version\":0,\"siteId\":\"12127\",\"state\":\"READY\",\"curState\":\"APPLIED\",\"applicationWindow\":{\"end\":null,\"start\":null},\"states\":[\"APPLIED\",\"NON_APPLIED\",\"APPLIED\"],\"timestamps\":[\"2023-04-03T21:28:49.146624+00:00\",\"2023-04-03T23:24:10.403133+00:00\",\"2023-04-03T23:45:21.623478+00:00\"],\"appClassId\":\"office365\",\"appClassName\":\"Office 365\",\"isAppClassSelected\":true}"},"siteId":{"type":"string","example":"12127"},"state":{"type":"string","example":"APPLIED"}}},"ApplyRecommendationRes":{"required":["notValidRecommendationIds","notValidSites","processId","waniPolicyId"],"type":"object","properties":{"notValidRecommendationIds":{"type":"string","example":"abc, xyz"},"notValidSites":{"type":"string","example":"200"},"processId":{"type":"string","example":"vsmart_policy_config-8978b772-183d-424e-b9ac-e633b8ffe516"},"waniPolicyId":{"type":"string","format":"uuid","example":"083b83e4-165d-45a8-947e-ba141d9129a2"}}},"AssignLicensesRequest":{"type":"object","properties":{"baseLicenses":{"type":"array","items":{"$ref":"#/components/schemas/AssignLicensesRequestBaseLicenses"}},"tenantLicenses":{"type":"array","items":{"$ref":"#/components/schemas/AssignLicensesRequestAssignLicenses"}}}},"AssignLicensesRequestAssignLicenses":{"type":"object","properties":{"allocated":{"type":"integer","format":"int32","example":2},"billingType":{"type":"string","example":"Prepaid"},"displayName":{"type":"string","example":"Advantage Large"},"saName":{"type":"string","example":"testaccount1.viptela.com"},"subscriptionId":{"type":"string","example":"sub00235"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"},"vaName":{"type":"string","example":"vManage_SDWAN_01"}}},"AssignLicensesRequestBaseLicenses":{"type":"object","properties":{"assignLicenses":{"type":"array","items":{"$ref":"#/components/schemas/AssignLicensesRequestAssignLicenses"}},"uuids":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"AssignMslaLicenses":{"type":"object","properties":{"baseLicense":{"$ref":"#/components/schemas/AssignMslaLicensesBaseLicense"},"tenantLicense":{"type":"array","items":{"$ref":"#/components/schemas/AssignMslaLicensesTenantLicense"}},"uuid":{"type":"array","items":{"type":"string"}}}},"AssignMslaLicensesBaseLicense":{"type":"object","properties":{"billing_type":{"type":"string","example":"PREPAID"},"license_type":{"type":"string","example":"DEMO"},"saId":{"type":"string","example":"316449"},"subscription_id":{"type":"string","example":"2425252522"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P,1.0_5446d77e-a22d-4343-a9f9-cefb53116b22"},"vaId":{"type":"string","example":"703805"}}},"AssignMslaLicensesTenantLicense":{"type":"object","properties":{"billing_type":{"type":"string","example":"PREPAID"},"count":{"type":"integer","format":"int32","example":4},"license_type":{"type":"string","example":"TERM"},"saId":{"type":"string","example":"316448"},"subscription_id":{"type":"string","example":"6376389267"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P,1.0_5446d77e-a22d-4343-a9f9-cefb53116b22"},"vaId":{"type":"string","example":"702544"}}},"AttCredentials":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"}}},"AttLocationInfo":{"type":"object","properties":{"attNEInfo":{"$ref":"#/components/schemas/AttNEInfo"},"metroCode":{"type":"string"},"metroName":{"type":"string"},"networkRegion":{"type":"string"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"AttNEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","items":{"type":"string"}},"productSizeList":{"type":"array","items":{"type":"string"}}}},"AttPartnerPort":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string"},"connectType":{"type":"string"},"productUid":{"type":"string"},"speed":{"type":"string"},"vxcId":{"type":"string"},"vxcPermitted":{"type":"boolean"}}},"AttachSitesRequestPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/AttachSitesRequestPayloadInner"}},"AttachSitesRequestPayloadInner":{"required":["color","siteId","solution","systemIp","tunnelCount"],"type":"object","properties":{"acceleratedVpn":{"pattern":"^(true|false)$","type":"string"},"color":{"pattern":"^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$","type":"string"},"interface":{"type":"string","example":"GigabitEthernet1"},"preferredInterface":{"pattern":"^[a-zA-Z0-9]*$","type":"string","example":"true"},"publicIp":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string","example":"18.219.1.221"},"siteId":{"pattern":"^\\d+$","type":"string"},"solution":{"pattern":"^(sdwan|sd-routing)$","type":"string","description":"Multicloud Branch Connect Solution type","example":"sd-routing"},"systemIp":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string"},"tunnelCount":{"pattern":"^[1-8]$","type":"string","example":"4"}}},"AuditFix":{"required":["cloudType"],"type":"object","properties":{"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string"},"issuesToSync":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/AuditFixIssuesToSync"}},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"}}},"AuditFixIssuesToSync":{"required":["name","region","reportType"],"type":"object","properties":{"name":{"type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"reportType":{"type":"string"}}},"AuditLogEntry":{"required":["auditdetails","entry_time","logdeviceid","logfeature","logid","logmessage","logmodule","loguser","logusersrcip","statcycletime","tenant"],"type":"object","properties":{"auditdetails":{"type":"array","items":{"type":"string"}},"entry_time":{"type":"integer","format":"int32","example":1659003590292},"id":{"type":"string","example":"iWJRRIIBMbLIyWbe1qH"},"logdeviceid":{"type":"string","example":"172.16.255.22"},"logfeature":{"type":"string","example":"user"},"logid":{"type":"string","format":"uuid","example":"918c6d64-729c-4304-b2c7-955a7c0e6a61"},"logmessage":{"type":"string","example":"Invalidated session due to server session idle time out for User: viptela-device-901d032c-0721-438e-82ba-1d429598d879"},"logmodule":{"type":"string","example":"user"},"loguser":{"type":"string","format":"uuid"},"logusersrcip":{"type":"string","example":"172.16.255.19"},"statcycletime":{"type":"integer","format":"int32","example":1659003590292},"tenant":{"type":"string","example":"default"}}},"AuditLogHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/ChartObject"},"columns":{"$ref":"#/components/schemas/AuditLogHeaderColumns"},"fields":{"$ref":"#/components/schemas/GetStatDataFields"},"generatedOn":{"type":"integer","format":"int32","example":1655622555494},"viewKeys":{"$ref":"#/components/schemas/AuditLogHeaderViewKeys"}}},"AuditLogHeaderColumns":{"required":["dataType","property","title"],"type":"object","properties":{"dataType":{"type":"string","example":"date"},"displayFormat":{"type":"string","example":"DD MMM YYYY h:mm:ss A z"},"hideable":{"type":"boolean","example":true},"inputFormat":{"type":"string","example":"unix-time"},"isDisplay":{"type":"boolean","example":true},"minWidth":{"type":"integer","format":"int32","example":300},"property":{"type":"string","example":"entry_time"},"title":{"type":"string","example":"Timestamp"},"width":{"type":"integer","format":"int32","example":220}}},"AuditLogHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-AuditLogView"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"AuditReport":{"type":"object","properties":{"auditReport":{"type":"array","items":{"$ref":"#/components/schemas/AuditReportAuditReport"}},"auditStatus":{"type":"string","example":"IN_SYNC"}}},"AuditReportAuditReport":{"type":"object","properties":{"errString":{"type":"string"},"region":{"type":"string","example":"My-Region-1"},"reportType":{"type":"string","example":"Edge Gateway"},"resourceName":{"type":"string","example":"My-Interconnect-Gateway-1"},"status":{"type":"string","example":"IN_SYNC"}}},"AwsDirectConnectGateway":{"required":["amazonSideAsn"],"type":"object","properties":{"amazonSideAsn":{"pattern":"^[1-9]\\d*$","type":"string"},"gatewayAssociationList":{"type":"array","description":"List of associated Gateways","items":{"$ref":"#/components/schemas/GatewayAssociation"}},"ownerAccount":{"type":"string"},"virtualInterfaceAttachmentList":{"type":"array","description":"List of virtual interfaces attached to DxGW","items":{"$ref":"#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceAttachmentList"}},"vpcTagNamesForGatewayAssociations":{"type":"array","description":"VPC Tags associated to the Direct Connect Gateway","items":{"type":"string","description":"VPC Tags associated to the Direct Connect Gateway"}}},"description":"AWS Direct Connect Gateway specific Object."},"AwsDirectConnectGatewayVirtualInterfaceAttachmentList":{"type":"object","properties":{"attachmentState":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]},"connectionId":{"type":"string","description":"Id of the private cross connect","example":"12345-1234-1234"},"connectionType":{"type":"string","description":"Type of AWS connection","example":"HCONN","enum":["HVIF","HCONN"]},"ownerAccount":{"type":"string"},"region":{"type":"string"},"stateChangeError":{"type":"string"},"virtualInterfaceData":{"$ref":"#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceData"},"virtualInterfaceId":{"type":"string"},"virtualInterfaceName":{"type":"string"},"virtualInterfaceType":{"type":"string","example":"TRANSIT","enum":["TRANSIT","PRIVATE","PUBLIC","ATTACHMENT"]}},"description":"Virtual Interface Object"},"AwsDirectConnectGatewayVirtualInterfaceData":{"type":"object","properties":{"advertisedPrefixList":{"type":"array","items":{"type":"string"}},"asn":{"type":"integer","format":"int64","example":65500},"bgpKey":{"type":"string","example":"EC-12345678"},"customerIpAddress":{"type":"string"},"ipAddress":{"type":"string"},"vlan":{"type":"integer","format":"int64","example":45678}},"description":"VIrtual Interface Object"},"AwsIamCredentials":{"required":["externalId","roleArn"],"type":"object","properties":{"externalId":{"type":"string"},"roleArn":{"type":"string"}}},"AwsKeyCredentials":{"required":["apiKey","secretKey"],"type":"object","properties":{"apiKey":{"type":"string"},"secretKey":{"type":"string"}}},"AwsTransitGateway":{"required":["amazonSideAsn"],"type":"object","properties":{"amazonSideAsn":{"pattern":"^[1-9]\\d*$","type":"string"},"associationDefaultRouteTableId":{"type":"string","example":"tgw-rtb-07ace6b22f9de8502"},"autoAcceptSharedAttachments":{"type":"boolean"},"creationTime":{"type":"string","example":"11-Jun-2022 (00:10:30:00000)"},"defaultRouteTableAssociation":{"type":"boolean"},"defaultRouteTablePropogation":{"type":"boolean"},"dnsSupport":{"type":"boolean"},"multicastSupport":{"type":"boolean"},"ownerAccount":{"type":"string"},"propogationDefaultRouteTableId":{"type":"string"},"vpcAttachmentList":{"type":"array","description":"List of VPC attachments","items":{"$ref":"#/components/schemas/AwsVpcAttachments"}},"vpnEcmpSupport":{"type":"boolean"}},"description":"AWS Transit Gateway specific Object."},"AwsVirtualPrivateGateway":{"type":"object","properties":{"amazonSideAsn":{"type":"integer","format":"int64"},"availabilityZone":{"type":"string"},"vpcAttachmentList":{"type":"array","description":"List of VPC attachments","items":{"$ref":"#/components/schemas/AwsVpcAttachments"}},"vpgType":{"type":"string","example":"ipsec.1"}},"description":"AWS Virtual Private Gateway specific Object."},"AwsVpcAttachments":{"type":"object","properties":{"region":{"type":"string"},"vpcId":{"type":"string","description":"VPC Id","example":"vpc-012345-2000"},"vpcRoutePrefixList":{"type":"array","description":"List of ip prefixes to be advertized towards DxGw on the VPC routing table.","example":["198.18.0.4/30","198.18.0.7/30"],"items":{"type":"string","description":"List of ip prefixes to be advertized towards DxGw on the VPC routing table.","example":"[\"198.18.0.4/30\",\"198.18.0.7/30\"]"}},"vpcState":{"type":"string"},"vpcSubnetPrefixList":{"type":"array","description":"List of VPC subnets to be added to DxGw association.","example":["10.10.0.0/24","10.10.1.0/24"],"items":{"type":"string","description":"List of VPC subnets to be added to DxGw association.","example":"[\"10.10.0.0/24\",\"10.10.1.0/24\"]"}}},"description":"AWS VPC attachment Object"},"AzureCredentials":{"required":["clientId","cloudTenantId","secretKey","subscriptionId"],"type":"object","properties":{"clientId":{"type":"string"},"cloudTenantId":{"type":"string"},"secretKey":{"type":"string"},"subscriptionId":{"type":"string"}}},"AzureERCPeering":{"type":"object","properties":{"advertisedPublicPrefixList":{"type":"array","items":{"type":"string"}},"azureAsn":{"type":"string"},"expressRouteConnectionId":{"type":"string","example":"12345"},"id":{"type":"string"},"name":{"type":"string"},"peerAsn":{"type":"string"},"peeringState":{"type":"string","example":"ENABLED","enum":["DISABLED","ENABLED"]},"peeringType":{"type":"string","example":"PUBLIC","enum":["PRIVATE","PUBLIC"]},"primaryAzurePort":{"type":"string"},"primaryPeerAddressPrefix":{"type":"string"},"secondaryAzurePort":{"type":"string"},"secondaryPeerAddressPrefix":{"type":"string"},"sharedKey":{"type":"string","description":"BGP Peering Key","example":"EC-12345"},"vlanId":{"type":"integer","format":"int64","example":1618}},"description":"Azure Express Route Circuit Peering"},"AzureERCServiceProviderProperties":{"type":"object","properties":{"bandwidthInMbps":{"type":"integer","format":"int64","example":1000},"peeringLocation":{"type":"string","example":"New York"},"serviceProviderName":{"type":"string"}},"description":"Azure Express Route Circuit Service Provider Properties"},"AzureExpressRouteCircuit":{"required":["resourceGroupName"],"type":"object","properties":{"allowClassicOperations":{"type":"boolean","example":true},"bandwidthInGbps":{"type":"integer","format":"int32","example":200},"gatewayAssociationList":{"type":"array","items":{"$ref":"#/components/schemas/GatewayAssociation"}},"globalReachEnabled":{"type":"boolean","example":true},"peeringList":{"type":"array","items":{"$ref":"#/components/schemas/AzureERCPeering"}},"provisioningState":{"type":"string","example":"PROVISIONED"},"resourceGroupName":{"type":"string"},"serviceKey":{"type":"string"},"serviceProviderProperties":{"$ref":"#/components/schemas/AzureERCServiceProviderProperties"},"serviceProviderProvisioningState":{"type":"string","enum":["DEPROVISIONING","NOT_PROVISIONED","PROVISIONED","PROVISIONING"]},"sku":{"$ref":"#/components/schemas/AzureExpressRouteCircuitSku"},"vWanAttachmentList":{"type":"array","items":{"$ref":"#/components/schemas/AzureExpressRouteCircuitVWanAttachmentList"}},"vnetTagNamesForConnections":{"type":"array","items":{"$ref":"#/components/schemas/AzureExpressRouteCircuitVnetTagNamesForConnections"}}},"description":"Azure Express Route Circuit Object"},"AzureExpressRouteCircuitSku":{"required":["family","tier"],"type":"object","properties":{"family":{"type":"string"},"name":{"type":"string"},"tier":{"type":"string","example":"STANDARD"}},"description":"Express Route Circuit SKU"},"AzureExpressRouteCircuitVHubList":{"type":"object","properties":{"isDelete":{"type":"boolean","example":true},"vHub":{"$ref":"#/components/schemas/AzureVirtualHub"}}},"AzureExpressRouteCircuitVWanAttachmentList":{"type":"object","properties":{"vHubList":{"type":"array","items":{"$ref":"#/components/schemas/AzureExpressRouteCircuitVHubList"}},"vWan":{"$ref":"#/components/schemas/AzureVirtualWan"}},"description":"vWan Attachment Name"},"AzureExpressRouteCircuitVnetTagNamesForConnections":{"type":"object","properties":{"isDelete":{"type":"boolean","example":true},"vnetTagName":{"type":"string"}},"description":"Vnet Tag Object Names"},"AzureExpressRouteGateway":{"type":"object","properties":{"autoScaleConfiguration":{"type":"string"},"resourceGroupName":{"type":"string"},"vHubId":{"type":"string","description":"Id of the Azure vHUB.","example":"vhub-1234"}},"description":"Azure Express Route Gateway Object"},"AzureVirtualHub":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"addressPrefix":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]},"id":{"type":"string"},"name":{"type":"string"},"provisioningState":{"type":"string","example":"PROVISIONED"},"region":{"type":"string"},"resourceGroupName":{"type":"string"},"routingState":{"type":"string"},"sku":{"type":"string","example":"STANDARD"},"tagList":{"type":"array","items":{"$ref":"#/components/schemas/AzureVirtualWanTagList"}},"virtualRouterAsn":{"type":"string"},"virtualRouterIp":{"type":"array","items":{"$ref":"#/components/schemas/AzureVirtualHubVirtualRouterIp"}},"vwanName":{"type":"string"}},"description":"Azure Virtual Hub"},"AzureVirtualHubVirtualRouterIp":{"type":"object","properties":{"privateIp":{"type":"string"}},"description":"Virtual Router IP"},"AzureVirtualNetworkGateway":{"type":"object","properties":{"enableBgp":{"type":"boolean","example":true},"publicIPAddress":{"type":"string"},"sku":{"$ref":"#/components/schemas/AzureVirtualNetworkGatewaySku"},"subnet":{"type":"string"},"virtualNetworkGatewayType":{"type":"string","example":"EXPRESS_ROUTE","enum":["VPN","EXPRESS_ROUTE"]}},"description":"Azure Virtual Network Gateway Object"},"AzureVirtualNetworkGatewaySku":{"type":"object","properties":{"capacity":{"type":"integer","format":"int32","example":100},"name":{"type":"string"},"tier":{"type":"string","example":"STANDARD"}},"description":"VNET Gateway SKU parameters"},"AzureVirtualWan":{"required":["name","region","resourceGroupName"],"type":"object","properties":{"accountId":{"maxLength":255,"minLength":1,"type":"string"},"accountName":{"type":"string","description":"Cloud account name","example":"my-cloud-account"},"allowBranchToBranchTraffic":{"type":"boolean","example":false},"cloudType":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"maxLength":80,"minLength":1,"type":"string"},"provisioningState":{"type":"string","example":"PROVISIONED"},"region":{"maxLength":255,"minLength":1,"type":"string"},"resourceGroupName":{"maxLength":80,"minLength":1,"type":"string"},"tagList":{"type":"array","items":{"$ref":"#/components/schemas/AzureVirtualWanTagList"}},"virtualWanType":{"type":"string"},"vnetTovnetTrafficEnabled":{"type":"boolean","example":false}},"description":"Azure Virtual Wan"},"AzureVirtualWanTagList":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string","example":"mytag"}},"description":"Azure Virtual WAN Tag Object"},"Banner":{"type":"object","properties":{"loginMessage":{"type":"string"},"motd":{"type":"string"}}},"BatchFlow":{"required":["data"],"type":"object","properties":{"data":{"type":"array","description":"payload for a REST API","items":{"$ref":"#/components/schemas/BatchFlowData"}}},"description":"Input to multiple REST API calls"},"BatchFlowData":{"type":"object","properties":{"method":{"type":"string","description":"HTTP Method","enum":["POST","PUT","GET","DELETE"]},"payload":{"type":"object","description":"JSON Payload for a REST API call"},"uri":{"type":"string","example":"/dataservice/settings/configuration/proxyHttpServer"}},"description":"payload for a REST API"},"Bfd":{"type":"object","properties":{"bfdTimerOnTransportTunnels":{"$ref":"#/components/schemas/BfdTimerOnTransportTunnels"},"dscpForBfdPackets":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pollInterval":{"type":"integer","format":"int32"}}},"BfdTimerOnTransportTunnels":{"type":"object","properties":{"bizInternetTimer":{"$ref":"#/components/schemas/BizInternetTimer"},"lteTimer":{"$ref":"#/components/schemas/LteTimer"},"mplsTimer":{"$ref":"#/components/schemas/MplsTimer"},"publicInternetTimer":{"$ref":"#/components/schemas/PublicInternetTimer"}}},"BizInternetTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"BringupInfo":{"type":"object","properties":{"message":{"type":"array","items":{"type":"string"}},"name":{"type":"string","example":"Data plane connectivity established"},"operation":{"type":"string","example":"DataPlane","enum":["DataPlane","ControlPlane","RouterConfiguration","SoftwareImageUpdate","vBondAuth"]},"status":{"type":"string","enum":["Success","NA","Error","Unknown"]},"timestamp":{"type":"integer","format":"int64","example":1695272160000}}},"CapDistribution":{"type":"object","properties":{"100":{"type":"integer","format":"int64"},"0-25":{"type":"integer","format":"int64"},"25-50":{"type":"integer","format":"int64"},"50-75":{"type":"integer","format":"int64"},"75-100":{"type":"integer","format":"int64"},"uncategorized":{"type":"integer","format":"int64"}}},"CapacityResp":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CapacityRespData"}},"distribution":{"$ref":"#/components/schemas/CapDistribution"}}},"CapacityRespData":{"type":"object","properties":{"avg_down_capacity_percentage":{"type":"number"},"avg_up_capacity_percentage":{"type":"number"},"bw_down":{"type":"integer","format":"int64"},"bw_up":{"type":"number"},"count":{"type":"integer","format":"int64"},"interface":{"type":"string"},"max_down_capacity_percentage":{"type":"number"},"max_up_capacity_percentage":{"type":"number"},"min_down_capacity_percentage":{"type":"number"},"min_up_capacity_percentage":{"type":"integer","format":"int32"},"range":{"type":"string"},"vdevice_name":{"type":"string"}}},"Cellular":{"required":["name","primarySlot","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"simSlot0":{"$ref":"#/components/schemas/SimSlotConfig"},"simSlot1":{"$ref":"#/components/schemas/SimSlotConfig"},"primarySlot":{"maximum":1,"minimum":0,"type":"integer","format":"int32"},"wanConfig":{"pattern":"(^Active$|^Standby$)","type":"string"}}}]},"CellularProfile":{"type":"object","properties":{"apn":{"type":"string"},"authMethod":{"pattern":"(^none$|^pap$|^chap$|^pap_or_chap$)","type":"string"},"id":{"maximum":16,"minimum":1,"type":"integer","format":"int32"},"password":{"type":"string"},"pdnType":{"pattern":"(^IPv4$|^IPv6$|^IPv4v6$)","type":"string"},"userName":{"type":"string"}}},"CertificateChain":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"CertificateData":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"CertificateStates":{"type":"object","properties":{"certificateTypes":{"type":"string"}},"description":"This is valid Certificate States "},"CertificateValidity":{"type":"object","properties":{"certificateValidity":{"type":"string"}},"description":"This is Certificate Validity "},"CgwResourceResponse":{"type":"object","properties":{"creationDate":{"type":"string"},"details":{"$ref":"#/components/schemas/CgwResourceResponseDetails"},"esourceId":{"type":"string"},"resourceType":{"type":"string"}}},"CgwResourceResponseDetails":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/CgwResourceResponseDetailsDevices"}},"vhubName":{"type":"string"},"virtualRouterAsn":{"type":"string"},"vwanName":{"type":"string"}}},"CgwResourceResponseDetailsDevices":{"type":"object","properties":{"publicIp":{"type":"string"},"uuid":{"type":"string"}}},"CgwVpnsResponse":{"type":"object","properties":{"accountName":{"type":"string","example":"awsTest"},"hostVpcId":{"type":"string","example":"vpc-0638351a9efaf77e9"},"hostVpcName":{"type":"string","description":"Returned for AWS/AWS_GOVCLOUD/GCP","example":"vpc-0638351a9efaf77e9"},"tag":{"type":"string","example":"test-tag-aws"},"tunnelCount":{"type":"integer","description":"Returned for AWS/AWS_GOVCLOUD/GCP","format":"int32","example":6},"vpnId":{"type":"string","example":"10"}}},"ChannelPowerSettings":{"type":"object","properties":{"radioBand2Dot4Ghz":{"$ref":"#/components/schemas/RadioBandSetting_2_4G"},"radioBand5Ghz":{"$ref":"#/components/schemas/RadioBandSetting_5G"}}},"ChartObject":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.chart.viewAuditlogHistogram.auditLog"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.chart.viewAuditlogHistogram.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.chart.viewAuditlogHistogram.count"}}},"CheckSelfSignedCert":{"type":"object","properties":{"isSelfSignedCertCreated":{"type":"boolean","example":true}}},"ClaimDevicesRequest":{"type":"object","properties":{"chassis_list":{"type":"array","items":{"$ref":"#/components/schemas/Device"}},"organization":{"type":"string"},"validityString":{"type":"string"}}},"ClaimDevicesResponse":{"type":"object","properties":{"activityList":{"type":"string","example":"[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassis Id, serial number): , - ISR4351/K9-FDO23070Y63, 383CB73]"},"id":{"type":"string","example":"7d77139d-5bed-4e82-8ea5-411a588a522e"},"vedgeListUploadMsg":{"type":"string","example":" of vEdges uploaded successfully: 1"},"vedgeListUploadStatus":{"type":"string","example":"vEdge list uploaded successfully"}}},"ClientServerInfoResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ClientServerResponseData"},"header":{"$ref":"#/components/schemas/ClientServerResponseHeader"}}},"ClientServerResponseData":{"type":"object","properties":{"CSRFToken":{"type":"string","example":"1BCE77AF0B88D97E3B922CE81315D61982FA5D5EC37874116320B4FDE43D9E8BA561E2907718618A1E75BF0E29B247101E11"},"VsessionId":{"type":"string","example":"ZGVmYXVsdA=="},"capabilities":{"type":"array","items":{"type":"string"}},"cloudx":{"type":"string","example":"off"},"description":{"type":"string"},"disableFullConfigPush":{"type":"boolean","example":false},"enableServerEvents":{"type":"boolean","example":true},"externalUser":{"type":"boolean","example":false},"generalTemplate":{"type":"boolean","example":true},"isRbacVpnUser":{"type":"boolean","example":false},"isSamlUser":{"type":"boolean","example":false},"isUiAllowed":{"type":"boolean","example":false},"locale":{"type":"string","example":"en_US"},"platformVersion":{"type":"string","example":"20.13.999-2952"},"reverseproxy":{"type":"string","example":"off"},"roles":{"type":"array","items":{"type":"string"}},"server":{"type":"string","example":"vm12"},"tenancyMode":{"type":"string","example":"SingleTenant"},"tenantId":{"type":"string","example":"default"},"user":{"type":"string","example":"admin"},"userMode":{"type":"string","example":"tenant"},"viewMode":{"type":"string","example":"tenant"},"vmanageMode":{"type":"string","example":"default"},"vpns":{"type":"array","items":{"type":"string"}}}},"ClientServerResponseHeader":{"type":"object","properties":{"generatedOn":{"type":"integer","format":"int32","example":1689221609561}}},"ClientTokenResponse":{"type":"object","properties":{"token":{"type":"string","example":"1BCE77AF0B88D97E3B922CE81315D61982FA5D5EC37874116320B4FDE43D9E8BA561E2907718618A1E75BF0E29B247101E11"}}},"CloudConnectivityGateway":{"required":["awsConnectivityGateway","azureConnectivityGateway","cloudAccountId","cloudType","gatewayName","gcpConnectivityGateway","region"],"type":"object","properties":{"awsConnectivityGateway":{"$ref":"#/components/schemas/CloudConnectivityGatewayAws"},"azureConnectivityGateway":{"$ref":"#/components/schemas/CloudConnectivityGatewayAzure"},"cloudAccountId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string"},"connectivityGatewayState":{"type":"string"},"description":{"type":"string"},"gatewayId":{"type":"string"},"gatewayName":{"type":"string"},"gcpConnectivityGateway":{"$ref":"#/components/schemas/CloudConnectivityGatewayGcp"},"isVmanageCreated":{"type":"boolean","description":"Resource created by vManage","example":true},"newFormat":{"type":"boolean","description":"Option indicates object type","example":true},"region":{"type":"string"}},"description":"Cloud Connectivity Gateway Object"},"CloudConnectivityGatewayAws":{"required":["awsConnectivityType"],"type":"object","properties":{"awsConnectivityType":{"type":"string","example":"DIRECT_CONNECT_GATEWAY"},"directConnectGateway":{"$ref":"#/components/schemas/AwsDirectConnectGateway"},"transitGateway":{"$ref":"#/components/schemas/AwsTransitGateway"},"virtualPrivateGateway":{"$ref":"#/components/schemas/AwsVirtualPrivateGateway"}},"description":"AWS cloud Connectivity Gateway Object"},"CloudConnectivityGatewayAzure":{"required":["azureConnectivityType"],"type":"object","properties":{"azureConnectivityType":{"type":"string"},"expressRouteCircuit":{"$ref":"#/components/schemas/AzureExpressRouteCircuit"},"expressRouteGateway":{"$ref":"#/components/schemas/AzureExpressRouteGateway"},"virtualNetworkGateway":{"$ref":"#/components/schemas/AzureVirtualNetworkGateway"}},"description":"Cloud Connectivity Gateway Object"},"CloudConnectivityGatewayGcp":{"required":["gcConnectivityType","routerInfo"],"type":"object","properties":{"gcConnectivityType":{"type":"string","example":"GCR_ATTACHMENT"},"interconnectAsn":{"pattern":"\\d+","type":"string","description":"BGP ASN assigned to Interconnect Gateway.","example":"64500"},"pairingKey":{"type":"string","example":"96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1"},"routerInfo":{"$ref":"#/components/schemas/GcpCloudRouter"}},"description":"Google cloud Connectivity Gateway Object."},"CloudGatewayAdjusted":{"type":"object","properties":{"accountId":{"type":"string"},"cloudGatewayId":{"type":"string"},"cloudGatewayMode":{"type":"string","description":"Only applicable to AWS/AWS_GOVCLOUD CloudTypes"},"cloudGatewayName":{"type":"string"},"cloudGatewaySolution":{"type":"string"},"cloudProviderASN":{"type":"integer","description":"CGW details relevant to AWS/AWS_GOVCLOUD","format":"int32"},"cloudProviderMgmtReference":{"type":"string","description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"cloudType":{"type":"string"},"connectedSites":{"type":"integer","format":"int32"},"connectivityState":{"type":"string"},"connectivityStateUpdateTs":{"type":"number"},"customSettings":{"type":"boolean"},"description":{"type":"string"},"devices":{"type":"array","items":{"type":"string"}},"mrfRouterRole":{"type":"string"},"region":{"type":"string"},"resourceGroupName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"routeTableCount":{"type":"string","description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"s2sPermitted":{"type":"boolean","description":"Only applicable to GCP CloudGateways"},"settings":{"$ref":"#/components/schemas/CustomSettings"},"siteName":{"type":"string"},"status":{"type":"string"},"tunnelCidrBlocks":{"type":"array","description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"type":"object","description":"CGW details relevant to AWS/AWS_GOVCLOUD"}},"tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"$ref":"#/components/schemas/TunnelsInner"}},"vhubName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"virtualRouterAsn":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"},"vpns":{"type":"array","items":{"type":"string"}},"vwanName":{"type":"string","description":"CGW details relevant to AZURE/AZURE_GOVCLOUD CloudTypes"}}},"CloudGatewayListResponse":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudGatewayId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string"},"customSettings":{"type":"boolean"},"description":{"type":"string"},"region":{"type":"string"},"status":{"type":"string"}}},"CloudGatewayPost":{"required":["accountId","azureProperties","cloudGatewayName","cloudType"],"type":"object","properties":{"accountId":{"type":"string"},"azureProperties":{"$ref":"#/components/schemas/CloudGatewayPostAzureProperties"},"cloudGatewayMode":{"pattern":"^(sdwan|sd-routing)$","type":"string"},"cloudGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]+$","type":"string"},"cloudGatewayTag":{"pattern":"^[a-zA-Z0-9_./\\\\\\-]+$","type":"string"},"cloudType":{"type":"string"},"configGroupSettings":{"$ref":"#/components/schemas/CloudGatewayPostConfigGroupSettings"},"description":{"maxLength":1024,"minLength":0,"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"devices":{"type":"array","items":{"type":"string"}},"mrfRouterRole":{"pattern":"^(edge|border)$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"s2sPermitted":{"pattern":"^(true|false)$","type":"string"},"settings":{"$ref":"#/components/schemas/AllOfcloudGatewayPostSettings"},"siteName":{"pattern":"^[a-zA-Z0-9_./\\\\\\-]+$","type":"string"},"sshKeyName":{"pattern":"^[a-zA-Z0-9_./\\\\\\-]+$","type":"string"}}},"CloudGatewayPostAzureProperties":{"required":["resourceGroupName","resourceGroupSource","vhubName","vhubSource","vwanName","vwanSource"],"type":"object","properties":{"nvaSource":{"type":"string"},"resourceGroupName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"resourceGroupSource":{"type":"string"},"vhubName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"vhubSource":{"type":"string"},"vpnGatewaySource":{"type":"string"},"vwanName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"vwanSource":{"type":"string"}},"description":"Used in Azure/Azure GovCloud CGW creation"},"CloudGatewayPostConfigGroupSettings":{"type":"object","properties":{"configGroupId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string"},"configGroupName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"}},"description":"Used in Azure/Azure GovCloud CGW creation"},"CloudWidget":{"type":"object","properties":{"cgwDeviceSiteIds":{"type":"array","items":{"type":"string"}},"cgwDeviceStatus":{"$ref":"#/components/schemas/AllOfcloudWidgetCgwDeviceStatus"},"cgwSitesStatus":{"$ref":"#/components/schemas/WidgetStatus"},"cgwStatus":{"$ref":"#/components/schemas/WidgetStatus"},"cloudGatewaySolution":{"type":"string"},"cloudType":{"type":"string"},"numAccounts":{"type":"number"},"numTags":{"type":"number"},"numTunnels":{"type":"number"},"numVpcs":{"type":"number"},"numVpns":{"type":"number"}}},"ClusterProperties":{"type":"object","properties":{"accountId":{"type":"string","example":"awsAccountId"},"accountName":{"type":"string","example":"aws_account1"},"accountType":{"type":"string","example":"AWS"},"discoveryStatus":{"type":"boolean","example":true},"expiration":{"type":"string","example":"Dec 21, 2035"},"name":{"type":"string","example":"clusterName"}}},"Codes":{"type":"object","properties":{"device_code":{"type":"string"},"expires_in":{"type":"integer","format":"int32"},"interval":{"type":"integer","format":"int32"},"user_code":{"type":"string"},"verification_uri":{"type":"string"},"verification_uri_complete":{"type":"string"}},"description":"Response from Cisco SecureX device_authorization API"},"CommunicationPlan":{"required":["apns","lteApns","lteEnabled","name"],"type":"object","properties":{"apns":{"type":"array","description":"List of APNs associated with the Comm Plan","example":"[{name:M2MTEST}]","items":{"$ref":"#/components/schemas/Apn"}},"commPlanDescription":{"type":"string","description":"Description of the communication plan.","example":"sms data shared"},"commPlanName":{"type":"string","writeOnly":true},"lteApns":{"type":"array","description":"List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ","example":[],"items":{"$ref":"#/components/schemas/LteApn"}},"lteEnabled":{"type":"boolean","description":"Specifies whether the Comm Plan has LTE enabled","example":false},"name":{"type":"string","description":"Name of the communication plan.","example":"vm cp sms data share"}}},"CommunicationPlansResponse":{"required":["communicationPlans","pageNumber"],"type":"object","properties":{"commPlans":{"type":"array","writeOnly":true,"items":{"$ref":"#/components/schemas/CommunicationPlan"}},"communicationPlans":{"type":"array","description":"List of communication plans.","example":"Refer to CommunicationPlan","items":{"$ref":"#/components/schemas/CommunicationPlan"}},"pageNumber":{"type":"integer","description":"Page Number.","format":"int32","example":1}}},"CompliantDeviceRequest":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"string"}},"protocolPackName":{"type":"string"}}},"ComponentEventMapping":{"type":"object","properties":{"component":{"type":"string","example":"Software"},"event":{"type":"string","example":"system-software-install-change"}}},"ConcurrentDomainDataResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Concurrent Domain Data schema for GET response","items":{"$ref":"#/components/schemas/ConcurrentDomainDataResponsePayloadInner"}},"ConcurrentDomainDataResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"flow_key":{"type":"string"},"received_timestamp":{"type":"integer","format":"int64"},"trace-id":{"type":"integer","format":"int32"}},"description":"Concurrent Domain Data schema for GET response"},"ConfigGroup":{"required":["name","solution","state","version"],"type":"object","properties":{"copyInfo":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"fullConfigCli":{"type":"boolean"},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"iosConfigCli":{"type":"boolean"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"origin":{"type":"string"},"originInfo":{"type":"object","additionalProperties":{"type":"string"}},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"sdwan","enum":["mobility","sdwan","sd-routing","common","nfvirtual","service-insertion","cellulargateway"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"topology":{"$ref":"#/components/schemas/Topology"},"version":{"type":"integer","description":" Group Version Flag","format":"int64"},"versionIncrementReason":{"type":"string"}}},"ConfigGroupDevice":{"type":"object","properties":{"criteria":{"$ref":"#/components/schemas/Criteria"},"unsupportedFeatures":{"type":"array","items":{"$ref":"#/components/schemas/UnsupportedFeature"}}}},"Configinfo":{"type":"object","properties":{"items":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/RegionPrefixinfo"}},"revision":{"type":"string","example":"20201120.ace4cb0"},"version":{"type":"string","example":"1.0.0"}}},"ConnectResponse":{"type":"object","properties":{"VersionInfo":{"$ref":"#/components/schemas/VersionInformation"}},"description":"Response from ISE ERS version info api"},"ConnectToNtpServer":{"type":"object","properties":{"ipAddress":{"type":"string"},"vpn":{"type":"string"}}},"ConnectedSitesResponse":{"type":"object","properties":{"bfdSessions":{"type":"integer","format":"int32"},"bfdSessionsUp":{"type":"integer","format":"int32"},"device-model":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"statusBfd":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"ControlConnectionInfo":{"type":"object","properties":{"actual-connections":{"type":"integer","format":"int32","example":2},"color":{"type":"string","example":"LTE"},"control":{"type":"array","items":{"$ref":"#/components/schemas/TlocControl"}},"expected-connections":{"type":"integer","format":"int32","example":2},"interface":{"type":"string","example":"GigabitEthernet1"},"nat-type":{"type":"string","example":"Not learned"},"private-ip":{"type":"string","example":"10.1.15.15"},"private-port":{"type":"string","example":"12366"},"public-ip":{"type":"string","example":"10.1.15.15"},"public-port":{"type":"string","example":"12366"},"tloc-status":{"type":"string","enum":["green","red"]},"tloc-type":{"type":"string"}}},"ControlStatus":{"type":"object","properties":{"controlDown":{"type":"integer","format":"int32"},"controlUp":{"type":"integer","format":"int32"},"partial":{"type":"integer","format":"int32"}}},"CoreNetworkPolicyResponse":{"type":"object","properties":{"changeSetState":{"type":"string","example":"EXECUTION_SUCCEEDED"},"coreNetworkId":{"type":"string","example":"core-network-0008d82310d17b86b"},"createdAt":{"type":"string","example":"Dec.16, 2022 04:16 UTC"},"description":{"type":"string","example":"Core Network Policy"},"policyAlias":{"type":"string","example":"LIVE, LATEST"},"policyData":{"type":"string","example":"StringifiedJsonPolicyData"},"policyVersionId":{"type":"number","example":19}}},"CorporateWifi":{"required":["securityAuthType"],"type":"object","properties":{"aaaServerInfo":{"$ref":"#/components/schemas/AaaServerInfo"},"corporateWlan":{"type":"boolean"},"radiusServer":{"$ref":"#/components/schemas/RadiusServer"},"securityAuthType":{"pattern":"(WPA2-PSK_AES|WPA2-Enterprise)","type":"string"},"ssid":{"maxLength":32,"minLength":1,"type":"string"},"visibility":{"type":"boolean"},"wpaPskKey":{"type":"string"}}},"CountResponse":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":17193}}},"CountryRegionSettings":{"type":"object","properties":{"countryRegion":{"type":"string"},"regulatoryDomain":{"pattern":"(REG_DOMAIN_INVALID|REG_DOMAIN_A|REG_DOMAIN_B|REG_DOMAIN_C|REG_DOMAIN_D|REG_DOMAIN_E|REG_DOMAIN_F|REG_DOMAIN_G|REG_DOMAIN_H|REG_DOMAIN_I|REG_DOMAIN_J|REG_DOMAIN_K|REG_DOMAIN_L|REG_DOMAIN_M|REG_DOMAIN_N|REG_DOMAIN_P|REG_DOMAIN_Q|REG_DOMAIN_R|REG_DOMAIN_S|REG_DOMAIN_T|REG_DOMAIN_U|REG_DOMAIN_Z|REG_DOMAIN_NONE|REG_DOMAIN_ZZ)","type":"string"}}},"CreateBody":{"type":"object","properties":{"nodeName":{"type":"string","example":"testUser123"}},"description":"Body for PxGrid node create on ISE"},"CreateDeviceParams":{"type":"object","properties":{"deviceIP":{"type":"string"},"generateCSR":{"type":"boolean"},"password":{"type":"string"},"personality":{"type":"string"},"port":{"type":"string"},"protocol":{"type":"string"},"username":{"type":"string"}}},"CreateFilterVPNList":{"type":"object","properties":{"vedge":{"type":"array","items":{"type":"string"}},"vsmart":{"type":"array","items":{"type":"string"}}}},"CreatePacketCaptureReq":{"type":"object","properties":{"bidirectional":{"type":"boolean","example":true},"destination_ip":{"type":"string","example":"2.2.2.2"},"destination_port":{"type":"string","example":"222"},"deviceUUID":{"type":"string","example":"C8K-4d204234-4aa1-4311-8913-67beeb8651c0"},"interface":{"type":"string","example":"GigabitEthernet5"},"interfaceIP":{"type":"string","example":"10.1.14.14"},"protocol":{"type":"string","example":"6"},"source_ip":{"type":"string","example":"1.1.1.1"},"source_port":{"type":"string","example":"111"},"type":{"type":"string","example":"control","enum":["control","data"]},"vpn":{"type":"string","example":"0"}}},"CreateResponse":{"type":"object","properties":{"nodeName":{"type":"string","example":"vIPtela_Inc_Regression_testUser123"},"password":{"type":"string","example":"vjvR4vnzoLSAFPn9"},"userName":{"type":"string","example":"vIPtela_Inc_Regression_testUser123"}},"description":"Response from PxGrid node creation on ISE"},"CreateTenantModel":{"type":"object","properties":{"desc":{"type":"string"},"edgeConnectorEnable":{"type":"boolean"},"edgeConnectorSystemIp":{"type":"string"},"edgeConnectorTunnelInterfaceName":{"type":"string"},"getvBondAddress":{"type":"string"},"getvSmarts":{"type":"array","items":{"type":"string"}},"idpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"name":{"type":"string"},"oldIdpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"orgName":{"type":"string"},"spMetadata":{"type":"string"},"subDomain":{"type":"string"},"wanEdgeForecast":{"type":"string"}}},"CreateVPNList":{"type":"object","properties":{"vedge":{"type":"array","items":{"type":"string"}},"vsmart":{"type":"array","items":{"type":"string"}}}},"Criteria":{"type":"object","properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}}},"CurrentTimestampResponsePayload":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64"}},"description":"Current Timestamp schema for GET response"},"CustomSettings":{"type":"object","properties":{"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]*$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]*$","type":"string"},"instanceSize":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string"},"ipSubnetPool":{"pattern":"^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$","type":"string"},"name":{"pattern":"^[a-zA-Z_]*$","type":"string"},"networkTier":{"pattern":"^[a-zA-Z0-9_./\\-]*$","type":"string","description":"Used for GCP Custom settings"},"skuScaleUnit":{"pattern":"^[0-9]*$","type":"string","description":"Used for Azure/Azure GovCloud Custom settings"},"softwareImageId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"tunnelCount":{"pattern":"^[0-9]*$","type":"string","description":"Tunnel Count for AWS Connect based and branch connect"}}},"DBQueryAggregationFieldObject":{"required":["property","size"],"type":"object","properties":{"order":{"type":"string","enum":["asc","desc"]},"orderType":{"type":"string","writeOnly":true,"enum":["key","count"]},"property":{"type":"object"},"sequence":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"type":{"type":"string"}}},"DBQueryAggregationHistogramObject":{"required":["order","property","type"],"type":"object","properties":{"interval":{"type":"integer","format":"int32"},"mindoccount":{"type":"integer","format":"int64"},"order":{"type":"string","enum":["asc","desc"]},"property":{"type":"object"},"type":{"type":"string","enum":["year","quater","month","week","day","hour","minute","second"]}}},"DBQueryAggregationMetricObject":{"required":["property","type"],"type":"object","properties":{"order":{"type":"string"},"property":{"type":"object"},"sequence":{"type":"string"},"size":{"type":"string"},"type":{"type":"string","enum":["avg","count","sum","max","min","cardinality","top_hits","argMax"]}}},"DBQueryAggregationObject":{"type":"object","properties":{"field":{"type":"array","items":{"$ref":"#/components/schemas/DBQueryAggregationFieldObject"}},"histogram":{"$ref":"#/components/schemas/DBQueryAggregationHistogramObject"},"metrics":{"type":"array","items":{"$ref":"#/components/schemas/DBQueryAggregationMetricObject"}}}},"DBQueryRuleObject":{"type":"object","properties":{"condition":{"type":"string","enum":["AND","OR"]},"field":{"type":"object"},"operator":{"type":"string","enum":["between","in","not_in","equal","not_equal","less_or_equal","greater","greater_or_equal","less","last_n_hours","last_n_days","last_n_weeks","hasAny","starts_with"]},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DBQueryRuleObject"}},"type":{"type":"string","enum":["int","string","long","double","date","specialString","number","array","boolean"]},"value":{"type":"array","items":{"type":"string"}}}},"DBQuerySortObject":{"required":["field","order"],"type":"object","properties":{"field":{"type":"object"},"order":{"type":"string","enum":["asc","desc"]},"type":{"type":"string","enum":["int","string","long","double","date","specialString","number","array","boolean"]}}},"DBQuerySpecObject":{"required":["rules"],"type":"object","properties":{"condition":{"type":"string","enum":["AND","OR"]},"field":{"type":"object"},"operator":{"type":"string","enum":["between","in","not_in","equal","not_equal","less_or_equal","greater","greater_or_equal","less","last_n_hours","last_n_days","last_n_weeks","hasAny","starts_with"]},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DBQueryRuleObject"}},"type":{"type":"string","enum":["int","string","long","double","date","specialString","number","array","boolean"]},"value":{"type":"array","items":{"type":"string"}}}},"DHCPPool":{"required":["leaseTimeDay","leaseTimeHour","leaseTimeMin","poolNetwork"],"type":"object","properties":{"leaseTimeDay":{"maximum":365,"minimum":0,"type":"integer","format":"int32"},"leaseTimeHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32"},"leaseTimeMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32"},"poolNetwork":{"type":"string"}}},"DPIAggregationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIAggregationResponseData"}},"header":{"$ref":"#/components/schemas/DPIAggregationResponseHeader"}}},"DPIAggregationResponseData":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":398},"family":{"type":"string","example":"network-service"},"octets":{"type":"integer","format":"int32","example":18768}}},"DPIAggregationResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/DPIAggregationResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DPIAggregationResponseHeaderFields"}},"generatedOn":{"type":"integer","format":"int64","example":1664160118911}}},"DPIAggregationResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"number"},"isDisplay":{"type":"boolean"},"property":{"type":"string","example":"octets"},"title":{"type":"string","example":"Octets"}}},"DPIAggregationResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"number"},"property":{"type":"string","example":"octets"}}},"DPIAppResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIAppResponseData"}},"header":{"$ref":"#/components/schemas/DPIAppResponseHeader"}}},"DPIAppResponseData":{"type":"object","properties":{"application":{"type":"string","example":"ipfix"},"octets":{"type":"number","example":72535008}}},"DPIAppResponseHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/DPIAppResponseHeaderChart"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DPIAppResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DPIAppResponseHeaderFields"}},"generatedOn":{"type":"number","example":1664506834428},"viewKeys":{"$ref":"#/components/schemas/DPIAppResponseHeaderViewKeys"}}},"DPIAppResponseHeaderChart":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.statistics.clientViewDpiApplication.dpiApplication"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiApplication.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiApplication.count"}}},"DPIAppResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"hideable":{"type":"boolean"},"property":{"type":"string","example":"application"},"title":{"type":"string","example":"Application"}}},"DPIAppResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"property":{"type":"string","example":"application"}}},"DPIAppResponseHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-dpi_applications"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"DPIDataObject":{"type":"object","properties":{"application":{"type":"string","example":"icmp"},"create_time":{"type":"integer","format":"int64","example":1664150420729},"dest_ip":{"type":"string","example":"10.74.49.77"},"dest_port":{"type":"integer","format":"int32","example":771},"device_model":{"type":"string","example":"vedge-C8000V"},"entry_time":{"type":"integer","format":"int64","example":1664150431860},"expire_time":{"type":"integer","format":"int64","example":1664150421784},"family":{"type":"string","example":"network-service"},"host_name":{"type":"string","example":"C8Kv-77"},"ip_proto":{"type":"integer","format":"int32","example":1},"octets":{"type":"integer","format":"int32","example":4032},"packets":{"type":"integer","format":"int32","example":7},"source_ip":{"type":"string","example":"10.124.10.249"},"source_port":{"type":"integer","format":"int32","example":0},"vdevice_name":{"type":"string","example":"1.1.70.7"},"vip_idx":{"type":"integer","format":"int32","example":172060},"vpn_id":{"type":"integer","format":"int32","example":512}}},"DPIPaginationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIDataObject"}},"pageInfo":{"$ref":"#/components/schemas/DPIPaginationResponsePageInfo"}}},"DPIPaginationResponsePageInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":100},"endTime":{"type":"string","example":"1664148997536"},"hasMoreData":{"type":"string","example":"true"},"scrollId":{"type":"string","example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ"},"startTime":{"type":"string","example":"1664159158463"},"totalCount":{"type":"integer","format":"int32","example":39802}}},"DPIResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DPIDataObject"}},"pageInfo":{"$ref":"#/components/schemas/DPIResponsePageInfo"}}},"DPIResponsePageInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":398},"endTime":{"type":"string","example":"1664148997536"},"startTime":{"type":"string","example":"1664159158463"}}},"DataCenter":{"required":["dcPersonality","mgmtIPAddress","password","username"],"type":"object","properties":{"dcPersonality":{"pattern":"^(primary|secondary|arbitrator)$","type":"string","example":"primary"},"members":{"type":"array","items":{"$ref":"#/components/schemas/Node"}},"mgmtIPAddress":{"pattern":"^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"10.0.105.32"},"name":{"pattern":"^[a-zA-Z0-9][a-zA-Z0-9-_]*$","type":"string","example":"DC1"},"nmsPersonality":{"pattern":"^[a-zA-Z0-9_]*$","type":"string","example":"nms_user"},"password":{"type":"string","example":"p@ssw0rd"},"username":{"type":"string","example":"admin"}}},"DataCenterRegistration":{"type":"object","properties":{"clusterEncKey":{"type":"string"},"dataCenters":{"maxItems":3,"minItems":2,"type":"array","items":{"$ref":"#/components/schemas/DataCenter"}},"disasterRecoverySettings":{"$ref":"#/components/schemas/DisasterRecoverySettings"},"host":{"$ref":"#/components/schemas/Host"},"vbonds":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Node"}},"vmanageRootCA":{"type":"string"}}},"DataCenterRegistrationUpdateRequest":{"type":"object","properties":{"clusterEncKey":{"type":"string"},"dataCenters":{"type":"array","items":{"$ref":"#/components/schemas/DataCenter"}},"disasterRecoverySettings":{"$ref":"#/components/schemas/DisasterRecoverySettings"},"host":{"$ref":"#/components/schemas/Host"},"vbonds":{"type":"array","items":{"$ref":"#/components/schemas/Node"}},"vmanageRootCA":{"type":"string"}}},"DataUsage":{"type":"object","properties":{"usageLimit":{"type":"integer","format":"int64"},"usageLimitUnit":{"type":"string"},"useDefaultRating":{"type":"boolean","writeOnly":true}},"description":"Data usage limit info .","example":"dataUsage"},"DecommissionVedgeCloud":{"type":"object","properties":{"id":{"type":"string","example":"b2afb474-f943-45b6-b673-f51b393ff924"}}},"DeleteAllListsBody":{"type":"object","properties":{"type":{"type":"string","example":"identity"}},"description":"Body for deleteAllLists call, generic api for deleting all lists of a specified listType"},"DeleteDetails":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"string"}}}},"DeleteDevice":{"type":"object","properties":{"status":{"type":"string","example":"success"}}},"DeleteResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/DeleteResponseInner"}},"DeleteResponseInner":{"type":"object","properties":{"host":{"type":"string","example":"172.16.255.11"},"reason":{"type":"string","example":"Software install task is in progress or scheduled for this device"}}},"DeleteTenantBulkModel":{"type":"object","properties":{"password":{"type":"string"},"tenantIdList":{"type":"array","items":{"type":"string"}}}},"DeleteTenantModel":{"type":"object","properties":{"password":{"type":"string"}}},"DetachSitesRequestPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/DetachSitesRequestPayloadInner"}},"DetachSitesRequestPayloadInner":{"required":["siteId","systemIp"],"type":"object","properties":{"color":{"pattern":"^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$","type":"string","example":"red"},"interface":{"type":"string","example":"GigabitEthernet1"},"siteId":{"pattern":"^\\d+$","type":"string","example":"578"},"solution":{"pattern":"^(sdwan|sd-routing)$","type":"string","example":"sd-routing"},"systemIp":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string","example":"1.1.1.178"}}},"Details":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/DeviceDetailsData"}},"DetailsForIdentityVerificationForSdoToken":{"required":["sdoSessionId"],"type":"object","properties":{"sdoSessionId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string","description":"Session ID generated by SDO Identity Service. Please use this GET API - '/v1/securedeviceonboarding/getUrlForSdoIdentityService'to get URL of this Secure Device Onboarding Identity Service.","example":"e01c5b71-b056-4602-b140-42221ccc3fec"}}},"Device":{"type":"object","properties":{"chassis-serial-number":{"type":"string","example":"SSI130300YK"},"configuredAaaUser":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"C8000v"},"device-os":{"type":"string","example":"next"},"device-type":{"type":"string","example":"vedge"},"deviceId":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"devicesAttached":{"type":"integer","format":"int32","example":0},"discoveredDeviceInterfaces":{"type":"array","items":{"type":"string"}},"host-name":{"type":"string","example":"vm5"},"loopback":{"type":"array","items":{"$ref":"#/components/schemas/Loopback"}},"personality":{"type":"string","example":"vedge"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable","enum":["reachable","unreachable"]},"registrationDate":{"type":"integer","format":"int64","example":1590186370340},"serialNumber":{"type":"string","example":"12345712"},"site-id":{"type":"string","example":"500"},"state":{"type":"string","example":"green"},"status":{"type":"string","example":"normal","enum":["error","warning","normal","new"]},"system-ip":{"type":"string","example":"172.16.255.15"},"templateStatus":{"type":"string","example":"Success"},"uuid":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"validity":{"type":"string","example":"valid","enum":["invalid","staging","valid","prestaging"]},"version":{"type":"string","example":"17.06.01.0.1422"},"wanInterfaces":{"type":"array","items":{"type":"string"}}}},"DeviceApiDetails":{"type":"object","properties":{"chassis-Number":{"type":"string","example":"390b3f83-ffc2-4081-9881-4c41bc8665e8"},"current-version":{"type":"string","example":"20.12.1"},"device-type":{"type":"string","example":"vedge"},"host-name":{"type":"string","example":"vm1"},"local-system-ip":{"type":"string","example":"172.168.0.1"},"personality":{"type":"string","example":"vedge"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"500"},"site-name":{"type":"string","example":"SITE_500"},"system-ip":{"type":"string","example":"172.168.0.1"},"uuid":{"type":"string","example":"390b3f83-ffc2-4081-9881-4c41bc8665e8"}}},"DeviceAppDetailResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppDetailResponseData"}},"header":{"$ref":"#/components/schemas/DeviceAppDetailResponseHeader"},"pageInfo":{"$ref":"#/components/schemas/DeviceAppDetailResponsePageInfo"}}},"DeviceAppDetailResponseData":{"type":"object","properties":{"application":{"type":"string","example":"skydrive"},"create_time":{"type":"number","example":1664442429015},"dest_ip":{"type":"string","example":"13.75.134.18"},"dest_port":{"type":"number","example":8248},"device_model":{"type":"string","example":"vedge-C8000V"},"entry_time":{"type":"number","example":1664442435015},"expire_time":{"type":"number","example":1664442441015},"family":{"type":"string","example":"web"},"host_name":{"type":"string","example":"vm5"},"id":{"type":"string","example":"782FiIMBjBC8ScfIzJ8_"},"ip_proto":{"type":"number","example":17},"octets":{"type":"number","example":1000000},"packets":{"type":"number","example":10000},"source_ip":{"type":"string","example":"12.166.184.245"},"source_port":{"type":"number","example":2},"vdevice_name":{"type":"string","example":"172.16.255.15"},"vip_idx":{"type":"number","example":1},"vpn_id":{"type":"number","example":1}}},"DeviceAppDetailResponseHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/DeviceAppDetailResponseHeaderChart"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderFields"}},"generatedOn":{"type":"number","example":1664508103301},"viewKeys":{"$ref":"#/components/schemas/DeviceAppDetailResponseHeaderViewKeys"}}},"DeviceAppDetailResponseHeaderChart":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.statistics.viewDpiDevicesDetails.dpiDeviceAppli"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.statistics.viewDpiDevicesDetails.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.statistics.viewDpiDevicesDetails.count"}}},"DeviceAppDetailResponseHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-dpi_devices_detials"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"DeviceAppDetailResponsePageInfo":{"type":"object","properties":{"count":{"type":"number","example":10000},"endTime":{"type":"string","example":"1664435237739"},"startTime":{"type":"string","example":"1664442435015"}}},"DeviceAppResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseData"}},"header":{"$ref":"#/components/schemas/DeviceAppResponseHeader"}}},"DeviceAppResponseData":{"type":"object","properties":{"octets":{"type":"number","example":25554477465},"vdevice_name":{"type":"string","example":"172.16.255.15"}}},"DeviceAppResponseHeader":{"type":"object","properties":{"chart":{"$ref":"#/components/schemas/DeviceAppResponseHeaderChart"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppResponseHeaderFields"}},"generatedOn":{"type":"number","example":1664507953669},"viewKeys":{"$ref":"#/components/schemas/DeviceAppResponseHeaderViewKeys"}}},"DeviceAppResponseHeaderChart":{"type":"object","properties":{"series":{"type":"array","items":{"type":"string"}},"title":{"type":"string","example":"view.statistics.clientViewDpiDevices.dpiDevice"},"xAxis":{"type":"array","items":{"type":"string"}},"xAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiDevices.time"},"yAxis":{"type":"array","items":{"type":"string"}},"yAxisLabel":{"type":"string","example":"view.statistics.clientViewDpiDevices.count"}}},"DeviceAppResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"property":{"type":"string","example":"vdevice_name"},"title":{"type":"string","example":"Devices"}}},"DeviceAppResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"string"},"property":{"type":"string","example":"vdevice_name"}}},"DeviceAppResponseHeaderViewKeys":{"type":"object","properties":{"preferenceKey":{"type":"string","example":"grid-dpi_devices"},"uniqueKey":{"type":"array","items":{"type":"string"}}}},"DeviceBlistDeleteResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"message":{"type":"string"}},"description":"Device blist delete response schema"},"DeviceBlistResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Device blist response payload","items":{"$ref":"#/components/schemas/DeviceBlistResponsePayloadInner"}},"DeviceBlistResponsePayloadInner":{"type":"object","properties":{"crashTime":{"type":"integer","format":"int64"},"crashVersion":{"type":"string"},"crashedReason":{"type":"string"},"deviceBlistState":{"type":"string"},"deviceModel":{"type":"string"},"deviceName":{"type":"string"},"nwpiState":{"type":"string"},"siteId":{"type":"number"},"systemIp":{"type":"string"},"type":{"type":"number"}},"description":"Device blist response payload"},"DeviceCheckList":{"type":"object","properties":{"message":{"type":"string","example":"Device is LTS - 1"},"status":{"type":"string","example":"GREEN"},"type":{"type":"string","example":"SOFTWARE_COMPLIANCE_CHECK"}}},"DeviceComplianceApiData":{"type":"object","properties":{"checkList":{"type":"array","items":{"$ref":"#/components/schemas/DeviceCheckList"}},"deviceDetails":{"$ref":"#/components/schemas/DeviceApiDetails"},"status":{"type":"string","example":"GREEN"}}},"DeviceComplianceApiResponse":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":9},"devices":{"type":"array","items":{"$ref":"#/components/schemas/DeviceComplianceApiData"}}}},"DeviceComplianceCheckListData":{"type":"object","properties":{"controllerCount":{"type":"integer","format":"int32","example":3},"type":{"type":"string","example":"SOFTWARE_COMPLIANCE_CHECK"},"vEdgeCount":{"type":"integer","format":"int32","example":2}}},"DeviceComplianceSummaryResponse":{"type":"object","properties":{"checkList":{"type":"array","items":{"$ref":"#/components/schemas/DeviceComplianceCheckListData"}}}},"DeviceConfig":{"type":"object","properties":{"deviceConfig":{"type":"string","example":"PHJwYyBtZXNzYWdlLWlkPSIxMDEiIHhtbG5zPSJ1cm46aWV0ZjpwYXJhbXM6eG1sOm5zOm5ldGNvbmY6YmFzZToxLjAiPg0KPGVkaXQtY29uZmlnPg0KPHRhcmdldD4NCjxjYW5kaWRhdGUvPg0KPC90YXJnZXQ+DQo8Y29uZmlnPjxuYXRpdmUgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtbmF0aXZlIj4KICAgIDxzbm1wLXNlcnZlcj4KCQkJICAgICAgICAgIDxjb21tdW5pdHkgeG1sbnM9Imh0dHA6Ly9jaXNjby5jb20vbnMveWFuZy9DaXNjby1JT1MtWEUtc25tcCI+CiAgICAgICAgICAgIDxuYW1lPnByaXZhdGU8L25hbWU+CiAgICAgICAgICAgIDxSVy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wcml2YXRlPC9uYW1lPgoJCQk8cGVybWlzc2lvbj5ydzwvcGVybWlzc2lvbj4KICAgICAgICAgIDwvY29tbXVuaXR5LWNvbmZpZz4KICAgICAgICAJCSAgICAgICAgICA8Y29tbXVuaXR5IHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxSTy8+CiAgICAgICAgICA8L2NvbW11bml0eT4KICAgICAgICAgIDxjb21tdW5pdHktY29uZmlnIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNubXAiPgogICAgICAgICAgICA8bmFtZT5wdWJsaWM8L25hbWU+CiAgICAgICAgICAgIDxwZXJtaXNzaW9uPnJvPC9wZXJtaXNzaW9uPgogICAgICAgICAgPC9jb21tdW5pdHktY29uZmlnPgoJCQkJPC9zbm1wLXNlcnZlcj4KCTwvbmF0aXZlPjwvY29uZmlnPg0KPC9lZGl0LWNvbmZpZz4NCjwvcnBjPg=="},"deviceId":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"}}},"DeviceCountersData":{"type":"object","properties":{"crashCount":{"type":"integer","format":"int32","example":0},"expectedControlConnections":{"type":"integer","format":"int32","example":3},"number-vsmart-control-connections":{"type":"integer","format":"int32","example":3},"rebootCount":{"type":"integer","format":"int32","example":2},"system-ip":{"type":"string"}}},"DeviceCountersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceCountersData"}},"header":{"$ref":"#/components/schemas/DeviceResponseHeader"}}},"DeviceCpuCount":{"type":"object","properties":{"attributeField":{"type":"string","example":"total_cpu_count"},"enable":{"type":"boolean","example":true}}},"DeviceData":{"type":"object","properties":{"board-serial":{"type":"string","example":"12345704"},"certificate-validity":{"type":"string","example":"Valid"},"connectedVManages":{"type":"array","items":{"type":"string"}},"controlConnections":{"type":"string","example":"9"},"device-groups":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"vmanage"},"device-os":{"type":"string","example":"device-os"},"device-type":{"type":"string","example":"vmanage"},"deviceId":{"type":"string","example":"169.254.10.1"},"domain-id":{"type":"string","example":"0"},"host-name":{"type":"string","example":"169.254.10.1"},"isDeviceGeoData":{"type":"boolean","example":false},"lastupdated":{"type":"string","example":"1634627015139"},"latitude":{"type":"string","example":"37.666684"},"layoutLevel":{"type":"integer","format":"int32","example":1},"local-system-ip":{"type":"string","example":"172.16.255.200"},"longitude":{"type":"string","example":"-122.777023"},"max-controllers":{"type":"string","example":"0"},"model_sku":{"type":"string","example":"None"},"personality":{"type":"string","example":"vmanage"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"200"},"state":{"type":"string","example":"green"},"state_description":{"type":"string","example":"All daemons up"},"status":{"type":"string","example":"normal"},"statusOrder":{"type":"string","example":"4"},"system-ip":{"type":"string","example":"169.254.10.1"},"testbed_mode":{"type":"boolean","example":true},"timezone":{"type":"string","example":"UTC"},"total_cpu_count":{"type":"string","example":"8"},"uptime-date":{"type":"string","example":"1634626320000"},"uuid":{"type":"string","example":"96af574a-eadd-4b6a-97bf-d5c1e98f40f2"},"validity":{"type":"string","example":"valid"},"version":{"type":"string","example":"9"}}},"DeviceDetails":{"required":["host","password","username","wan"],"type":"object","properties":{"device_uuid":{"type":"string","description":"device uuid/chassis number","example":"C8K-4facbd05-855b-45f0-af2f-c844af179bd6"},"enable_password":{"type":"string","description":"enable password","example":"admin"},"host":{"pattern":"((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9a-f]{1,4}:){7}([0-9a-f]{1,4}|:))|(([0-9a-f]{1,4}:){6}(:[0-9a-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){5}(((:[0-9a-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9a-f]{1,4}:){4}(((:[0-9a-f]{1,4}){1,3})|((:[0-9a-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){3}(((:[0-9a-f]{1,4}){1,4})|((:[0-9a-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){2}(((:[0-9a-f]{1,4}){1,5})|((:[0-9a-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9a-f]{1,4}:){1}(((:[0-9a-f]{1,4}){1,6})|((:[0-9a-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9a-f]{1,4}){1,7})|((:[0-9a-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))","type":"string","description":"host ip","example":"1.1.1.1"},"local_file_name":{"type":"string","description":"local file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"password":{"type":"string","description":"ssh password","example":"admin"},"remote_server_file_name":{"type":"string","description":"remote server file name","example":"c8000v-universalk9.17.12.01.0.175851.SSA.bin"},"remote_server_id":{"type":"string","description":"remote server Id","example":"56a32849-aafb-4703-8887-ba64c0394835"},"username":{"type":"string","description":"ssh username","example":"admin"},"wan":{"maxLength":32,"minLength":3,"pattern":"(Cellular|Dialer|Ethernet|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GigabitEthernet|HundredGigE|Loopback|Multilink|Port-channel|Serial|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vlan|Wlan-GigabitEthernet)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)","type":"string","description":"WAN interface name","example":"GigabitEthernet1"}},"description":"Device list to onboard"},"DeviceDetailsData":{"required":["devices"],"type":"object","properties":{"devices":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Device list to onboard","items":{"$ref":"#/components/schemas/DeviceDetails"}}}},"DeviceHardwareHealthDetail":{"type":"object","properties":{"bfdSessions":{"type":"string","example":"3"},"board-serial":{"type":"string","example":"12346568"},"controlConnections":{"type":"string","example":"3"},"cpuLoadDisplay":{"type":"string","example":"39.27"},"device-model":{"type":"string","example":"vedge-cloud"},"device-type":{"type":"string","example":"vedge"},"hardwareState":{"type":"string","example":"normal"},"host-name":{"type":"string","example":"vm11"},"lastupdated":{"type":"integer","format":"int64","example":1635371851165},"local-system-ip":{"type":"string","example":"172.16.255.21"},"memUsageDisplay":{"type":"string","example":"52.0"},"number-vsmart-peers":{"type":"integer","format":"int32","example":2},"ompPeers":{"type":"string","example":"2"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"100"},"system-ip":{"type":"string","example":"172.16.255.21"},"uptime-date":{"type":"integer","format":"int64","example":1635324240000},"uuid":{"type":"string","example":"63e8518c-e76f-4d5f-a4c7-28ffb669526b"},"version":{"type":"string","example":"20.7.999-1133"}}},"DeviceHealthDetailItem":{"required":["cpu_load","health","health_score","host_name","memory_utilization","qoe","reachability","site_id","system_ip"],"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}}},"DeviceHealthDetails":{"type":"object","properties":{"bfd_sessions":{"type":"integer","format":"int32"},"bfd_sessions_up":{"type":"integer","format":"int32"},"board_serial_number":{"type":"string"},"cellularBit":{"type":"string"},"cellularHealth":{"type":"array","items":{"type":"string"}},"cellularRsrp":{"type":"array","items":{"type":"string"}},"cellularRsrq":{"type":"array","items":{"type":"string"}},"chassis_number":{"type":"string"},"cloudOnRampSaaSApps":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"cloudOnRampSaaSDeviceRole":{"type":"string"},"configGroupId":{"type":"string"},"configGroupName":{"type":"string"},"configuration_device":{"type":"boolean"},"connected_vmanages":{"type":"array","items":{"type":"string"}},"controlConnectionsToVsmat":{"$ref":"#/components/schemas/DeviceHealthDetails"},"control_connections":{"type":"integer","format":"int32"},"control_connections_up":{"type":"integer","format":"int32"},"cpu_load":{"type":"number","format":"double"},"device_groups":{"type":"array","items":{"type":"string"}},"device_model":{"type":"string"},"device_type":{"type":"string"},"expected_vsmart_connections":{"type":"integer","format":"int32"},"has_geo_data":{"type":"boolean"},"health":{"type":"string","enum":["red","yellow","green"]},"latitude":{"type":"string"},"local_system_ip":{"type":"string"},"location":{"type":"string"},"longitude":{"type":"string"},"memory_utilization":{"type":"number","format":"double"},"name":{"type":"string"},"omp_peers":{"type":"integer","format":"int64"},"omp_peers_up":{"type":"integer","format":"int64"},"personality":{"type":"string"},"policyGroupId":{"type":"string"},"policyGroupName":{"type":"string"},"qoe":{"type":"integer","format":"int32"},"reachability":{"type":"string"},"region_list":{"type":"array","items":{"type":"string"}},"sdraSessionCounts":{"$ref":"#/components/schemas/DeviceHealthDetails"},"sdra_ipsec_anyconnect":{"type":"integer","format":"int64"},"sdra_ipsec_enabled":{"type":"boolean"},"sdra_ipsec_soho":{"type":"integer","format":"int64"},"sdra_ipsec_unknown":{"type":"integer","format":"int64"},"sdra_sslvpn_anyconnect":{"type":"integer","format":"int64"},"sdra_sslvpn_enabled":{"type":"boolean"},"site_id":{"type":"string"},"site_name":{"type":"string"},"software_version":{"type":"string"},"system_ip":{"type":"string"},"tags":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"total_tloc_num":{"type":"integer","format":"int64"},"up_tloc_num":{"type":"integer","format":"int64"},"uptime_date":{"type":"integer","format":"int64"},"uuid":{"type":"string"},"vpn_ids":{"type":"array","items":{"type":"string"}},"vsmart_control_connections":{"type":"integer","format":"int32"}}},"DeviceHealthEntryItem":{"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"entry_time":{"type":"number","example":1657780200000},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"}}},"DeviceHealthHistoryItem":{"type":"object","properties":{"cpu_load":{"type":"number","format":"double","example":1.32},"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double","example":10},"history":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthEntryItem"}},"host_name":{"type":"string","example":"vm11"},"memory_utilization":{"type":"number","format":"double","example":43.03},"qoe":{"type":"number","format":"double","example":10},"reachability":{"type":"string","example":"reachable"},"site_id":{"type":"string","example":"600"},"system_ip":{"type":"string","example":"172.16.255.21"}}},"DeviceHealthOverview":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/DeviceHealthOverviewDetail"},"total":{"$ref":"#/components/schemas/DeviceHealthOverviewTotal"}}},"DeviceHealthOverviewDetail":{"type":"object","properties":{"fair":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetailItem"}},"good":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetailItem"}},"poor":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetailItem"}}}},"DeviceHealthOverviewTotal":{"type":"object","properties":{"fair":{"type":"number","example":100},"good":{"type":"number","example":100},"poor":{"type":"number","example":100}}},"DeviceIP":{"type":"object","properties":{"deviceIp":{"type":"string"}},"description":"This is the valid DeviceIP"},"DeviceInfoExtendedResponse":{"type":"object","properties":{"cloudGatewayName":{"type":"string"},"configStatusMessage":{"type":"string"},"configuredSystemIP":{"type":"string"},"device-model":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"system-ip":{"type":"string"},"uptime-date":{"type":"number"},"uuid":{"type":"string"},"version":{"type":"string"}}},"DeviceInfoResponsePayloadData":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadDataDevices"}},"interfaces":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadDataInterfaces"}},"models":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfoResponsePayloadDataModels"}}}},"DeviceInfoResponsePayloadDataDevices":{"type":"object","properties":{"device-model":{"type":"string"},"device-type":{"type":"string"},"deviceId":{"type":"string"},"host-name":{"type":"string"},"latitude":{"type":"string"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"longitude":{"type":"string"},"site-id":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"DeviceInfoResponsePayloadDataInterfaces":{"type":"object","properties":{"ifname":{"type":"string"},"ip-address":{"type":"string"},"vdevice-host-name":{"type":"string"},"vdevice-name":{"type":"string"},"vpn-id":{"type":"string"}}},"DeviceInfoResponsePayloadDataModels":{"type":"object","properties":{"deviceClass":{"type":"string"},"name":{"type":"string"}}},"DeviceInterface":{"type":"object","properties":{"day0":{"type":"array","example":["GigabitEthernet0/0/0"],"items":{"type":"string","example":"[\"GigabitEthernet0/0/0\"]"}},"lan":{"type":"array","example":["GigabitEthernet","TenGigabitEthernet","Loopback"],"items":{"type":"string","example":"[\"GigabitEthernet\",\"TenGigabitEthernet\",\"Loopback\"]"}},"mgmt":{"type":"array","example":["GigabitEthernet","TenGigabitEthernet","Loopback"],"items":{"type":"string","example":"[\"GigabitEthernet\",\"TenGigabitEthernet\",\"Loopback\"]"}},"wan":{"type":"array","example":["GigabitEthernet","TenGigabitEthernet","Loopback"],"items":{"type":"string","example":"[\"GigabitEthernet\",\"TenGigabitEthernet\",\"Loopback\"]"}}}},"DeviceList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"DeviceLists":{"required":["entry_time"],"type":"object","properties":{"device_ip":{"type":"string","example":"1.1.1.1"},"entry_time":{"type":"integer","format":"int64","example":1639897200000},"host_name":{"type":"string","example":"vm1"},"site_name":{"type":"string","example":"sjc"}}},"DeviceModel":{"type":"object","properties":{"deviceModel":{"type":"string"}},"description":"This is the valid DeviceModel "},"DeviceModelsData":{"type":"object","properties":{"cpuCountAttribute":{"$ref":"#/components/schemas/DeviceCpuCount"},"deviceClass":{"type":"string","example":"cisco-router"},"deviceType":{"type":"string","example":"vedge"},"displayName":{"type":"string","example":"ISR4461"},"interfaces":{"$ref":"#/components/schemas/DeviceInterface"},"isCliSupported":{"type":"boolean","example":true},"name":{"type":"string","example":"vedge-ISR-4461"},"onboardCert":{"type":"boolean","example":true},"templateClass":{"type":"string","example":"cedge"},"templateSupported":{"type":"boolean","example":true}}},"DeviceModelsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceModelsData"}},"header":{"$ref":"#/components/schemas/DeviceResponseHeader"}}},"DeviceReachableData":{"type":"object","properties":{"availableVersions":{"type":"array","items":{"type":"string"}},"board-serial":{"type":"integer","format":"int64"},"board_type":{"type":"string"},"bootloader_version":{"type":"string"},"build_number":{"type":"integer","format":"int64"},"certificate-not-valid-after":{"type":"string"},"certificate-not-valid-before":{"type":"string"},"certificate-status":{"type":"string"},"certificate-validity":{"type":"string"},"chassis-number":{"type":"string"},"chassis-serial-number":{"type":"number","format":"float"},"connectedVManages":{"type":"array","items":{"type":"string"}},"controlConnections":{"type":"integer","format":"int64"},"controlConnectionsDown":{"type":"integer","format":"int32"},"controlConnectionsUp":{"type":"integer","format":"int64"},"cpuLoadDisplay":{"type":"number","format":"float"},"cpuState":{"type":"string"},"defaultVersion":{"type":"string"},"device-category":{"type":"string"},"device-groups":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string"},"device-os":{"type":"string"},"device-type":{"type":"string","example":"9"},"deviceId":{"type":"string"},"domain-id":{"type":"integer","format":"int32"},"expectedControlConnections":{"type":"integer","format":"int64"},"fips_mode":{"type":"string"},"firmwareAvailablePackages":{"type":"array","items":{"type":"string"}},"firmwareAvailableVersions":{"type":"array","items":{"type":"string"}},"firmwareVersion":{"type":"string"},"grid":{"type":"integer","format":"int32"},"groupId":{"type":"array","items":{"type":"string"}},"hardwareState":{"type":"string"},"hasGeoData":{"type":"boolean"},"host-name":{"type":"string"},"isDeviceGeoData":{"type":"boolean"},"lastDataSyncTime":{"type":"integer","format":"int64"},"lastupdated":{"type":"integer","format":"int64"},"latitude":{"type":"string"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"longitude":{"type":"string"},"memStatenormal":{"type":"string"},"memUsage":{"type":"integer","format":"int32"},"memUsageDisplay":{"type":"integer","format":"int32"},"model_sku":{"type":"string"},"mpPeers":{"type":"integer","format":"int32"},"name":{"type":"string"},"number-vbond-peers":{"type":"integer","format":"int32"},"number-vsmart-control-connections":{"type":"integer","format":"int64"},"number-vsmart-peers":{"type":"integer","format":"int64"},"ompPeersDown":{"type":"integer","format":"int64"},"ompPeersUp":{"type":"integer","format":"int32"},"organization-name":{"type":"string"},"personality":{"type":"string"},"platform":{"type":"string"},"policy-template-nam":{"type":"string"},"policy-template-name":{"type":"string"},"policy-template-version":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"integer","format":"int32"},"sp-organization-name":{"type":"string"},"state":{"type":"string"},"state_description":{"type":"string"},"status":{"type":"string"},"statusOrder":{"type":"integer","format":"int32"},"syncCompleted":{"type":"integer","format":"int64"},"syncQueued":{"type":"integer","format":"int64"},"syncScheduled":{"type":"integer","format":"int64"},"syncState":{"type":"string"},"system-ip":{"type":"string"},"testbed_mode":{"type":"boolean"},"timezone":{"type":"string"},"token":{"type":"string"},"total_cpu_count":{"type":"integer","format":"int64"},"uptime":{"type":"string"},"uptime-date":{"type":"integer","format":"int64"},"uuid":{"type":"string"},"vbond":{"type":"string"},"vedge-list-version":{"type":"integer","format":"int32"},"version":{"type":"string"},"vmanage-system-ip":{"type":"string"},"vmanageConnectionState":{"type":"string"},"vsmart-list-version":{"type":"integer","format":"int32","example":0}}},"DeviceResponseHeader":{"type":"object","properties":{"generatedOn":{"type":"integer","format":"int64","example":1635224742597}}},"DeviceStatusData":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":0},"detailsURL":{"type":"string","example":"/dataservice/device?personality=vbond&status=error"},"image":{"type":"string","example":"images/vsmart.png"},"name":{"type":"string","example":"vSmart"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/StatusList"}},"type":{"type":"string","example":"vSmart"}}},"DeviceTaskStatus":{"type":"object","properties":{"tasks":{"type":"string","example":"123"}},"description":"List of tasks"},"DeviceTlocDataWithBFD":{"type":"object","properties":{"bfdSessionsDown":{"type":"integer","format":"int32","example":0},"bfdSessionsUp":{"type":"integer","format":"int32","example":5},"color":{"type":"string","example":"red"},"controlConnectionsDown":{"type":"string","example":"vmanage"},"controlConnectionsUp":{"type":"integer","format":"int32","example":2},"system-ip":{"type":"string","example":"169.254.10.1"}}},"DeviceUsageDetails":{"required":["carrierName","communicationPlan","controllerId","currentDataUsage","iccid","ratePlan","ratePlanType","slotId"],"type":"object","properties":{"carrierName":{"type":"string","description":"Name of the service provider.","example":"Singtel"},"communicationPlan":{"type":"string","description":"Name of the communication plan.","example":"vm cp sms data share"},"controllerId":{"type":"string","description":"Controller Id","example":"1"},"currentDataUsage":{"type":"string","description":"Current Data Usage.","example":"10MB"},"errorDetails":{"type":"string","description":"Details of any error encountered while retrieving device data usage","example":"No eSIM ICCIDs found"},"esimStatus":{"type":"string","description":"Bootstrap eSim Status","example":"ACTIVATED"},"iccid":{"type":"string","description":"Identifier of the eSIM device.","example":"8988216716970004975"},"isBootstrap":{"type":"boolean","description":"Boolean flag that indicated if ICCID is on bootstrap account"},"otherEsimsDataUsage":{"type":"string","description":"Total data used by other eSIM devices.","example":"20MB"},"ratePlan":{"type":"string","description":"Name of the rate plan.","example":"vm fixed pool rp"},"ratePlanDataUsageLimit":{"type":"string","description":"Rate plan usage limit.","example":"50MB"},"ratePlanType":{"type":"string","description":"Rate plan type.","example":"Monthly - Pooled Subscriber"},"slotId":{"type":"integer","description":"Slot Id","format":"int32"},"totalDataUsage":{"type":"string","description":"Total data usage","example":"30MB"},"usageThresholdWarning":{"type":"array","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%.","items":{"type":"string","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%."}}}},"DeviceUuid":{"type":"object","properties":{"deviceUuid":{"type":"string","example":"C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db"}},"description":"This is valid DeviceUuid"},"DeviceVmanageResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeviceVmanageResponseData"},"header":{"$ref":"#/components/schemas/DeviceResponseHeader"}}},"DeviceVmanageResponseData":{"type":"object","properties":{"ipAddress":{"type":"string"}}},"DevicesDetails":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/DevicesDetailsDevices"}}}},"DevicesDetailsDevices":{"type":"object","properties":{"complianceStatus":{"type":"string","example":"Out Of Compliance"},"configuredSystemIP":{"type":"string","example":"172.16.254.3"},"deviceModel":{"type":"string","example":"vedge-C8530-12X4QC"},"deviceTags":{"type":"array","items":{"type":"string"}},"hostName":{"type":"string","example":"pm4"},"hsecCompatible":{"type":"string","example":"Yes"},"hsecLicenseStatus":{"type":"string"},"hsecStatus":{"type":"string","example":"-"},"inCompliantReason":{"type":"string","example":"Unassigned"},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/DevicesDetailsLicenses"}},"noOfTenantsOnBoarded":{"type":"integer","format":"int32","example":5},"uuid":{"type":"string","example":"C8530-2f351fae-e60a-4a5d-b5b9-aeb1306289ff"}}},"DevicesDetailsLicenses":{"type":"object","properties":{"billingType":{"type":"string","example":"prepaid"},"displayName":{"type":"string","example":"Essential Large"},"endDate":{"type":"string","example":"2025"},"licenseCategory":{"type":"string","example":"Base"},"licenseType":{"type":"string","example":"TERM"},"no0fAssignedLicenses":{"type":"integer","format":"int32","example":1},"saName":{"type":"string","example":"testaccount1.viptela.com"},"startDate":{"type":"string","example":"2023"},"subscriptionId":{"type":"string","example":"sub00235"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"},"vaName":{"type":"string","example":"vManage_SDWAN_01"}}},"DevicesHealth":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthDetails"}},"header":{"type":"object","additionalProperties":{"type":"object"}},"total_devices":{"type":"integer","format":"int32"}}},"DevicesHealthOverview":{"type":"object","properties":{"fair":{"type":"integer","format":"int32"},"good":{"type":"integer","format":"int32"},"poor":{"type":"integer","format":"int32"}}},"DisablePacketCaptureRes":{"type":"object","properties":{"status":{"type":"string","example":"success"}}},"DisabledAlarmDetails":{"type":"object","properties":{"endTime":{"type":"string","example":"2022-06-06 10:50:05 UTC"},"eventName":{"type":"string","example":"bfd-state-change"},"startTime":{"type":"string","example":"2022-06-06 09:50:05 UTC"}}},"DisasterRecoverySettings":{"required":["startTime"],"type":"object","properties":{"delayThreshold":{"type":"integer","format":"int32","example":0},"drPaused":{"type":"boolean","example":false},"ignoredIndexes":{"type":"array","items":{"type":"string"}},"interval":{"type":"integer","format":"int32","example":2},"intervalModified":{"type":"boolean","example":false},"pauseReplication":{"type":"boolean","example":false},"startTime":{"pattern":"^([0]?[1-9]|1[0-2]):([0-5]?[0-9])[ap]m$","type":"string","example":"12:00am"}}},"DiscoveredServices":{"type":"object","properties":{"clusterName":{"type":"string","example":"someClusterName"},"ip":{"type":"array","items":{"type":"string"}},"name":{"type":"string","example":"serviceName"},"namespace":{"type":"string","example":"awsNamespace"},"port":{"type":"array","items":{"type":"string"}},"protocol":{"type":"string","example":"tcp"},"serverName":{"type":"array","items":{"type":"string"}}}},"DnaSenseResponse":{"type":"object","properties":{"html":{"type":"string","description":"Sense Post Contents","example":"Documentation for Monitor Overview..."}},"description":"Dna Sense Response"},"DocCountRes":{"type":"object","properties":{"count":{"type":"integer","format":"int64","example":35174}}},"DomainDetail":{"type":"object","properties":{"domain":{"maxLength":200,"minLength":1,"type":"string"},"resolvedIp":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"DomainMetricResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Domain metric schema for GET response","items":{"$ref":"#/components/schemas/DomainMetricResponsePayloadInner"}},"DomainMetricResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"data.received_timestamp":{"type":"integer","format":"int64"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Domain metric schema for GET response"},"ERSActiveDirectoryGroups":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/UsergroupObject"}}}},"ERSActiveDirectoryUsers":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserObject"}}}},"EditLicenseResponse":{"type":"object","properties":{"appliedFilters":{"$ref":"#/components/schemas/AppliedFilters"},"baseLicenses":{"$ref":"#/components/schemas/EditLicenseResponseBaseLicenses"},"tenantLicenses":{"$ref":"#/components/schemas/EditLicenseResponseTenantLicenses"}}},"EditLicenseResponseBaseLicenses":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/EditLicenseResponseLicenses"}},"platformClass":{"type":"string","example":"C8530"}}},"EditLicenseResponseLicenses":{"type":"object","properties":{"available":{"type":"integer","format":"int32","example":20},"displayName":{"type":"string","example":"Advantage Large"},"inUse":{"type":"integer","format":"int32","example":5},"isAssigned":{"type":"boolean","example":true},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"}}},"EditLicenseResponseTenantLicenses":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/EditLicenseResponseLicenses"}},"totalTenantLicRequired":{"type":"integer","format":"int32","example":10}}},"EnrollOTPResponse":{"type":"object","properties":{"authToken":{"type":"string"},"cdnaServerIP":{"type":"string"},"cline_id":{"type":"string"},"enrolled":{"type":"boolean"},"lastUpdated":{"type":"string"},"member_id":{"type":"string"},"token_url":{"type":"string"}},"description":"Enroll CDNA Server Response."},"EnrollOTPSettings":{"required":["token"],"type":"object","properties":{"token":{"type":"string"}}},"EntityOwnershipInfo":{"type":"object","properties":{"bucket":{"type":"string"},"entityName":{"type":"string"},"owner":{"type":"string"}}},"Entry":{"type":"object","properties":{"userGroup":{"type":"string","example":"SDWAN-IDENTITY.CISCO.COM/Users/Schema Admins"}},"description":"list"},"EquinixCredentials":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"}}},"EquinixLocationInfo":{"type":"object","properties":{"eqBillingAccountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/MultiCloudEdgeBillingAccountInfo"}},"eqNEInfo":{"$ref":"#/components/schemas/EquinixNEInfo"},"metroCode":{"type":"string"},"metroName":{"type":"string"},"networkRegion":{"type":"string"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"EquinixNEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","items":{"type":"string"}},"productSizeList":{"type":"array","items":{"type":"string"}}}},"EquinixPartnerPort":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string"},"connectType":{"type":"string"},"productUid":{"type":"string"},"speed":{"type":"string"},"vxcId":{"type":"string"},"vxcPermitted":{"type":"boolean"}}},"Ethernet":{"required":["ethernetInterfaceList","name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"ethernetInterfaceList":{"type":"array","items":{"$ref":"#/components/schemas/EthernetInterface"}}}}]},"EthernetInterface":{"required":["interfaceName","portType"],"type":"object","properties":{"aaaServerInfo":{"$ref":"#/components/schemas/AaaServerInfo"},"adminState":{"pattern":"(enabled|disabled)","type":"string"},"corporateLan":{"type":"boolean"},"interfaceName":{"pattern":"(^GigabitEthernet0/0$|^GigabitEthernet0/1$|^GigabitEthernet0/2$)","type":"string"},"ipAssignment":{"pattern":"(dynamic|static)","type":"string"},"ipv6Assignment":{"pattern":"(AutoConfig-SLAC)","type":"string"},"portType":{"pattern":"(LAN|WAN)","type":"string"},"staticIpAddress":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"staticIpAddressSubnetMask":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"staticRouteIp":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"wanConfiguration":{"pattern":"(Active)","type":"string"}}},"EventAppHopListResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Application and HopList schema for GET response","items":{"$ref":"#/components/schemas/EventAppHopListResponsePayloadInner"}},"EventAppHopListResponsePayloadInner":{"type":"object","properties":{"application":{"type":"string"},"downHopListInfo":{"type":"array","items":{"type":"object"}},"downMaxHopNum":{"type":"integer","format":"int32"},"entry_time":{"type":"integer","format":"int64"},"serverSideKey":{"type":"string"},"trace_id":{"type":"integer","format":"int32"},"type":{"type":"string"},"upHopListInfo":{"type":"array","items":{"type":"object"}},"upMaxHopNum":{"type":"integer","format":"int32"},"vpn_id":{"type":"string"}},"description":"Application and HopList schema for GET response"},"EventAppScoreBandwidthResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Event Application Performance Score and Bandwidth schema for GET response","items":{"$ref":"#/components/schemas/EventAppScoreBandwidthResponsePayloadInner"}},"EventAppScoreBandwidthResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Event Application Performance Score and Bandwidth schema for GET response"},"EventFlowFromAppHopResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Trace Event Flow From Application And Hop schema for GET response","items":{"$ref":"#/components/schemas/EventFlowFromAppHopResponsePayloadInner"}},"EventFlowFromAppHopResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace_id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Trace Event Flow From Application And Hop schema for GET response"},"EventName":{"type":"object","properties":{"eventName":{"type":"string"}},"description":"This is valid eventName"},"EventQueryInputResponse":{"type":"object","properties":{"component":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"severityOptions":{"type":"array","items":{"$ref":"#/components/schemas/SimpleKeyValueMapping"}},"timeOptions":{"type":"array","items":{"$ref":"#/components/schemas/TimeOptions"}}}},"EventReadoutFilterResponsePayload":{"type":"object","properties":{"userName":{"type":"array","description":"User Name List","items":{"type":"string","description":"User Name List"}}},"description":"Event readouts Filter Response schema"},"EventReadoutResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Event Readout schema for GET response","items":{"$ref":"#/components/schemas/EventReadoutResponsePayloadInner"}},"EventReadoutResponsePayloadInner":{"type":"object","properties":{"application":{"type":"string"},"dropSendPkts":{"type":"array","items":{"type":"object"}},"entry_time":{"type":"integer","format":"int64"},"eventHopPolicyInfo":{"type":"array","items":{"type":"object"}},"eventHopStatistics":{"type":"array","items":{"type":"object"}},"eventHopTimeInfo":{"type":"array","items":{"type":"object"}},"eventImpactedFlowNum":{"type":"array","items":{"type":"object"}},"eventList":{"type":"array","items":{"type":"object"}},"eventNum":{"type":"array","items":{"type":"object"}},"readoutAggFlag":{"type":"boolean"},"totalFlowNum":{"type":"integer","format":"int32"},"trace_id":{"type":"integer","format":"int32"}},"description":"Event Readout schema for GET response"},"EventReadoutsResponsePayloadData":{"type":"object","properties":{"app":{"type":"string"},"app_grp":{"type":"string"},"app_vis":{"type":"string"},"art_vis":{"type":"string"},"common_app":{"type":"string"},"detail":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadDetail"}},"device_ip":{"type":"string"},"dia_vis":{"type":"string"},"domain_mon":{"type":"string"},"dscp":{"type":"string"},"dst_ip":{"type":"string"},"dst_pfx":{"type":"string"},"dst_pfx_len":{"type":"string"},"dst_port":{"type":"string"},"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"hub_wan_vis":{"type":"string"},"local_drop_rate_threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos_mon":{"type":"string"},"sampling":{"type":"string"},"source_site":{"type":"string"},"source_site_vmanage_version":{"type":"string"},"spl_intvl":{"type":"string"},"src_if":{"type":"string"},"src_ip":{"type":"string"},"src_pfx":{"type":"string"},"src_pfx_len":{"type":"string"},"src_port":{"type":"string"},"state":{"type":"string"},"stop_time":{"type":"integer","format":"int64"},"trace_id":{"type":"integer","format":"int32"},"trace_name":{"type":"string"},"vpn_id":{"type":"string"},"wan_drop_rate_threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}}},"EventReadoutsResponsePayloadDetail":{"type":"object","properties":{"application":{"type":"string"},"dropSendPkts":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadDropSendPkts"}},"eventHopPolicyInfo":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopTimeInfo"}},"eventHopStatistics":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopStatistics"}},"eventHopTimeInfo":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopTimeInfo"}},"eventImpactedFlowNum":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventImpactedFlowNum"}},"eventList":{"type":"array","items":{"type":"string"}},"eventNum":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadEventNum"}},"totalFlowNum":{"type":"integer","format":"int32"}}},"EventReadoutsResponsePayloadDropCauses":{"type":"object","properties":{"dropCause":{"type":"string"}}},"EventReadoutsResponsePayloadDropSendPkts":{"type":"object","properties":{"dropPkts":{"type":"integer","format":"int32"},"event":{"type":"string"},"sendPkts":{"type":"integer","format":"int32"}}},"EventReadoutsResponsePayloadEventHopStatistics":{"type":"object","properties":{"event":{"type":"string"},"hopStatistics":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadHopStatistics"}}}},"EventReadoutsResponsePayloadEventHopTimeInfo":{"type":"object","properties":{"eventHop":{"type":"string"},"eventHopWithEdge":{"type":"string"},"timeInfo":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadTimeInfo"}}}},"EventReadoutsResponsePayloadEventImpactedFlowNum":{"type":"object","properties":{"event":{"type":"string"},"impactedFlowNum":{"type":"string"}}},"EventReadoutsResponsePayloadEventNum":{"type":"object","properties":{"event":{"type":"string"},"eventNum":{"type":"string"}}},"EventReadoutsResponsePayloadHopStatistics":{"type":"object","properties":{"dropCauses":{"type":"array","items":{"$ref":"#/components/schemas/EventReadoutsResponsePayloadDropCauses"}},"eventNum":{"type":"string"},"hop":{"type":"string"},"hopWithEdge":{"type":"string"}}},"EventReadoutsResponsePayloadTimeInfo":{"type":"object","properties":{"endTime":{"type":"string"},"eventNum":{"type":"string"},"startTime":{"type":"string"}}},"EventSeverityResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/EventsBySeverity"}},"EventStats":{"type":"object","properties":{"Discarded Events":{"type":"integer","format":"int32","example":0},"Processed Events":{"type":"integer","format":"int32","example":0},"Total":{"type":"integer","format":"int32","example":0}}},"EventStatsDataResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadData1"}}},"description":"Event Stats Data schema for GET response"},"EventStatsDataResponsePayloadData":{"type":"object","properties":{"device_site_id":{"type":"string"},"event_stats_object":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadDataEventStatsObject"}}},"EventStatsDataResponsePayloadData1":{"type":"object","properties":{"auto-on-task-id":{"type":"integer","format":"int32"},"data":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadData"},"tenant":{"type":"string"},"type":{"type":"string"}}},"EventStatsDataResponsePayloadDataEventStatsObject":{"type":"object","properties":{"event_stats_list":{"type":"array","items":{"$ref":"#/components/schemas/EventStatsDataResponsePayloadDataEventStatsObjectEventStatsList"}},"total_event_counter":{"type":"integer","format":"int32"}}},"EventStatsDataResponsePayloadDataEventStatsObjectEventStatsList":{"type":"object","properties":{"event_counter":{"type":"integer","format":"int32"},"event_failed_to_trace_counter":{"type":"integer","format":"int32"},"event_name":{"type":"string"},"event_to_trace_counter":{"type":"integer","format":"int32"}}},"EventsBySeverity":{"type":"object","properties":{"component":{"type":"string","example":"System"},"details":{"type":"string","example":"host-name=vm12; user-name=admin; user-id=2276"},"entry_time":{"type":"string"},"eventname":{"type":"string","example":"system-login-change"},"host_name":{"type":"string","example":"vm12"},"severity_level":{"type":"string","enum":["MINOR","MAJOR","MEDIUM","CRITICAL"]},"system_ip":{"type":"string","example":"172.16.255.22"}}},"ExecutiveSummaryReport":{"required":["emailRecipient","reportName","scheduleConfig","timeRange"],"type":"object","properties":{"businessHours":{"$ref":"#/components/schemas/ReportBusinessHours"},"emailRecipient":{"maxItems":5,"minItems":0,"type":"array","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"],"items":{"type":"string","description":"Email address list to receive the report files","example":"[\"alice@cisco.com\",\"bob@google.com\"]"}},"fileType":{"type":"string","enum":["pdf","csv"]},"reportName":{"maxLength":32,"minLength":1,"pattern":"(?=^.{1,32}$)[^&<>! \"]+$","type":"string","description":"Report Name","example":"ExecutiveSummaryReport"},"scheduleConfig":{"$ref":"#/components/schemas/ScheduleConfig"},"siteIds":{"maxItems":500,"minItems":0,"type":"array","description":"Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.","example":[100,200],"items":{"type":"integer","format":"int64"}},"templateType":{"type":"string","enum":["executive_summary","site_availability","link_availability","link_utilization","link_sla","app_usage","ips_events_collected","firewall_enforcement","malware_files_collected","internet_browsing"]},"timeRange":{"type":"string","description":"Time range for report(one_week/one_month)","example":"one_week","enum":["one_day","one_week","one_month"]}},"description":"Executive summary report template"},"FeatureProfile":{"required":["name","solution","type"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the feature Profile.","example":"Profile file description"},"id":{"type":"string","description":"System generated unique identifier of the feature profile in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the feature Profile. Must be unique.","example":"system feature profile"},"profileParcelCount":{"type":"integer","description":"Number of Parcels attached with Feature Profile","format":"int64","readOnly":true},"solution":{"type":"string","description":"Solution of the feature Profile.","example":"sdwan"},"type":{"type":"string","description":"Type of the feature Profile.","example":"system"}},"description":"List of devices UUIDs associated with this group","example":"West coast retail store devices"},"FeatureTemplateType":{"type":"object","properties":{"umbrella":{"$ref":"#/components/schemas/Umbrella"}},"description":"Response from metaDataType API"},"FecAndPktDupResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"header":{"$ref":"#/components/schemas/FecAndPktDupResponseHeader"}}},"FecAndPktDupResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"string"}},"generatedOn":{"type":"number","example":1664508540280}}},"Field":{"type":"object","properties":{"dataType":{"type":"string","example":"number"},"display":{"type":"string","example":"keyvalue"},"property":{"type":"string","example":"vip_idx"}}},"FinalizedDomainDataResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Finalized Domain Data schema for GET response","items":{"$ref":"#/components/schemas/FinalizedDomainDataResponsePayloadInner"}},"FinalizedDomainDataResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Finalized Domain Data schema for GET response"},"FindSoftwareVersion":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FindSoftwareVersionData"}}}},"FindSoftwareVersionData":{"type":"object","properties":{"version":{"type":"string","example":"17.12.01.0.177566.1681743991"}}},"FindVEdgeSoftwareVersion":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FindVEdgeSoftwareVersionData"}}}},"FindVEdgeSoftwareVersionData":{"type":"object","properties":{"version":{"type":"string","example":"17.12.01.0.177566.1681743991"},"versionId":{"type":"string","example":"a35a640d-2414-4923-a2c4-02bbd37bf2ad"}}},"FirmwareImageRemoteUpgrade":{"type":"object","properties":{"action":{"type":"string","example":"firmwareupgrade"},"actionEnd":{"type":"string","example":"Wed Jan 12 03:00:00 IST 2023"},"actionEndMillis":{"type":"integer","format":"int32","example":1641936600000},"actionName":{"type":"string","example":"firmware_upgrade"},"actionStart":{"type":"string","example":"Tue Jan 11 23:00:00 IST 2023"},"actionStartMillis":{"type":"integer","format":"int32","example":1641922200000},"deviceType":{"type":"string","example":"vedge"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgradeDevices"}},"input":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgradeInput"},"timeZone":{"type":"string","example":"Asia/Kolkata"}}},"FirmwareImageRemoteUpgradeDevices":{"type":"object","properties":{"deviceIP":{"type":"string","example":"40.1.1.1"},"deviceId":{"type":"string","example":"CG113-4GW6B-KWC254402PM"}}},"FirmwareImageRemoteUpgradeInput":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareImageRemoteUpgradeInputData"}},"versionType":{"type":"string","example":"remote"}}},"FirmwareImageRemoteUpgradeInputData":{"type":"object","properties":{"family":{"type":"string","example":"Teleworker"},"remoteServerId":{"type":"string","example":"192448a2-36bd-4f50-af04-03b428cd5a8f"},"version":{"type":"string","example":"875d4845-df12-4fdf-91f6-b73c601b2c3f"}}},"FlowInfoResponseData":{"type":"object","properties":{"app_group":{"type":"string"},"app_name":{"type":"string"},"appqoe_diverted":{"type":"boolean"},"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"big_drop":{"type":"boolean"},"big_wan_drop":{"type":"boolean"},"device_trace_id":{"type":"integer","format":"int32"},"domain":{"type":"array","items":{"type":"string"}},"domain_name":{"type":"string"},"domain_src":{"type":"string"},"downstream_device_list":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseDataDownstreamDeviceList"}},"downstream_dscp":{"type":"string"},"downstream_hop_list":{"$ref":"#/components/schemas/FlowInfoResponseDataDownstreamHopList"},"dpi_policy_used":{"type":"boolean"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"dst_sgt":{"type":"string"},"fif_dpi_not_classified":{"type":"boolean"},"flow_fin":{"type":"boolean"},"flow_id":{"type":"integer","format":"int32"},"flow_key":{"type":"string"},"flow_moved":{"type":"boolean"},"flow_readout":{"type":"object"},"max_local_drop_rate":{"type":"integer","format":"int32"},"max_wan_drop_rate":{"type":"integer","format":"int32"},"nat_translated":{"type":"boolean"},"path_changed":{"type":"boolean"},"policy_bypassed":{"type":"boolean"},"protocol":{"type":"string"},"qos_congested":{"type":"boolean"},"received_timestamp":{"type":"integer","format":"int64"},"server_no_response":{"type":"boolean"},"sla_violated":{"type":"boolean"},"sla_violated_bfd":{"type":"boolean"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"src_sgt":{"type":"string"},"start_device":{"type":"string"},"start_timestamp":{"type":"integer","format":"int64"},"tcp_flow_reset":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"},"upstream_device_list":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseDataUpstreamDeviceList"}},"upstream_dscp":{"type":"string"},"upstream_hop_list":{"type":"array","items":{"$ref":"#/components/schemas/FlowInfoResponseDataUpstreamHopList"}},"utd_diverted":{"type":"boolean"},"vpn_id":{"type":"string"},"wan_color_asym":{"type":"boolean"}}},"FlowInfoResponseDataDownstreamDeviceList":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"localColor":{"type":"string"},"remoteColor":{"type":"string"}}},"FlowInfoResponseDataDownstreamHopList":{"type":"object","properties":{"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"},"fif_dpi_not_classified":{"type":"boolean"}}},"FlowInfoResponseDataUpstreamDeviceList":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"ingress_pre_invalid":{"type":"boolean"}}},"FlowInfoResponseDataUpstreamHopList":{"type":"object","properties":{"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"}}},"FlowlogAggreation":{"type":"object","properties":{"count":{"type":"integer","format":"int64","example":6},"entry_time":{"type":"integer","format":"int64","example":1653575400000}}},"FlowlogAggregationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FlowlogAggreation"},"entryTimeList":{"type":"array","items":{"type":"integer","format":"int64"}},"header":{"$ref":"#/components/schemas/FlowlogAggregationResponseHeader"}}},"FlowlogAggregationResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/FlowlogAggregationResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FlowlogAggregationResponseHeaderFields"}},"generatedOn":{"type":"integer","format":"int64","example":1664160118911}}},"FlowlogAggregationResponseHeaderColumns":{"type":"object","properties":{"dataType":{"type":"string","example":"date"},"isDisplay":{"type":"boolean","example":true},"property":{"type":"string","example":"entry_time"},"title":{"type":"string","example":"Entry_time"}}},"FlowlogAggregationResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","example":"date"},"property":{"type":"string","example":"entry_time"}}},"FlowlogDataObject":{"type":"object","properties":{"action":{"type":"string","example":"action"},"dest_ip":{"type":"string","example":"10.74.49.77"},"dest_port":{"type":"integer","format":"int32","example":771},"device_model":{"type":"string","example":"vedge-cloud"},"direction":{"type":"string","example":"service"},"dscp":{"type":"integer","format":"int32","example":7},"egress_intf":{"type":"string","example":"cpu"},"entry_time":{"type":"integer","format":"int64","example":1664150431860},"flow_active":{"type":"string","example":"active"},"host_name":{"type":"string","example":"vm1"},"ingress_intf":{"type":"string","example":"GigabitEthernet5"},"ip_proto":{"type":"integer","format":"int32","example":7},"policy_name":{"type":"string","example":"policy"},"src_ip":{"type":"string","example":"10.124.10.249"},"src_port":{"type":"integer","format":"int32","example":0},"start_time":{"type":"integer","format":"int64","example":1664150431860},"statcycletime":{"type":"integer","format":"int64","example":1664150431860},"stats_data_id":{"type":"string","example":"4OBG_HEB_JLsavezVUfr"},"tenant":{"type":"string","example":"feb962f1-a182-4516-997e-4beb9c31515c"},"total_bytes":{"type":"integer","format":"int64","example":172060},"total_pkts":{"type":"integer","format":"int64","example":172060},"vdevice_name":{"type":"string","example":"10.124.10.249"},"vmanage_system_ip":{"type":"string","example":"10.124.10.249"},"vpn_id":{"type":"integer","format":"int32","example":512}}},"FlowlogPaginationResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FlowlogDataObject"}},"pageInfo":{"$ref":"#/components/schemas/FlowlogPaginationResponsePageInfo"}}},"FlowlogPaginationResponsePageInfo":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":100},"endTime":{"type":"string","example":"1664148997536"},"hasMoreData":{"type":"string","example":"true"},"scrollId":{"type":"string","example":"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ"},"startTime":{"type":"string","example":"1664159158463"},"totalCount":{"type":"integer","format":"int32","example":39802}}},"ForceStopPacketCaptureRes":{"type":"object","properties":{"status":{"type":"string","example":"success"}}},"FormPacketCaptureRes":{"type":"object","properties":{"status":{"type":"string","example":"success"}}},"FormPostResp":{"type":"object","properties":{"activityList":{"type":"string","example":"[Number of vEdges uploaded successfully: 1, Uploaded vEdges (chassisId, serial number): , - ESR-6300-LIC-K9-FAUSTEST126, 030557201979336385BE]"},"id":{"type":"string","example":"b5091b8e-e5ea-4096-8e4c-f17d0d60f2dd"},"vedgeListUploadMsg":{"type":"string","example":"Number of vEdges uploaded successfully: 1"},"vedgeListUploadStatus":{"type":"string","example":"vEdge list uploaded successfully"}}},"GatewayAssociation":{"type":"object","properties":{"advertisedPrefixList":{"type":"array","example":["10.10.0.0/24","10.20.0.0/24"],"items":{"type":"string","example":"[\"10.10.0.0/24\",\"10.20.0.0/24\"]"}},"associatedGateway":{"$ref":"#/components/schemas/GatewayAssociationAssociatedGateway"},"associationAction":{"type":"string","example":"ASSOCIATE","enum":["ASSOCIATE","DISASSOCIATE","REMOVE_PREFIX_LIST","NO_ACTION"]},"associationId":{"type":"string","example":"12345"},"associationState":{"type":"string","example":"ASSOCIATED"},"stateChangeError":{"type":"string"}},"description":"Generic multicloud gateway association object"},"GatewayAssociationAssociatedGateway":{"type":"object","properties":{"cloudAccountId":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudType":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]},"description":{"type":"string"},"gatewayId":{"type":"string"},"gatewayName":{"type":"string"},"region":{"type":"string"}},"description":"Cloud Connectivity Gateway Object"},"GatewaysConfiggroupBody":{"required":["configGroupName"],"type":"object","properties":{"configGroupName":{"maxLength":255,"minLength":1,"type":"string"}}},"GatewaysPushconfigBody":{"required":["edgeGatewayName","edgeType"],"type":"object","properties":{"edgeGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"edgeType":{"maxLength":255,"minLength":1,"type":"string"}}},"GcpCloudRouter":{"required":["name","network"],"type":"object","properties":{"attachmentDetails":{"type":"array","description":"List of GCR Attachments","items":{"$ref":"#/components/schemas/GcpInterconnectAttachment"}},"cloudRouterAsn":{"pattern":"\\d+","type":"string"},"id":{"type":"string"},"name":{"pattern":"(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)","type":"string"},"network":{"type":"string"},"region":{"type":"string"}},"description":"Google cloud GCR Object."},"GcpCredentials":{"required":["auth_provider_x509_cert_url","auth_uri","client_email","client_id","client_x509_cert_url","private_key","private_key_id","project_id","token_uri","type"],"type":"object","properties":{"auth_provider_x509_cert_url":{"type":"string"},"auth_uri":{"type":"string"},"client_email":{"type":"string"},"client_id":{"type":"string"},"client_x509_cert_url":{"type":"string"},"private_key":{"type":"string"},"private_key_id":{"type":"string"},"project_id":{"type":"string"},"token_uri":{"type":"string"},"type":{"type":"string"}}},"GcpInterconnectAttachment":{"type":"object","properties":{"cloudRouterIpAddress":{"type":"string"},"customerIpAddress":{"type":"string"},"id":{"type":"string"},"mtu":{"type":"string","description":"MTU of the Interconnect attachment","example":"1500"},"name":{"pattern":"(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)","type":"string"},"pairingKey":{"type":"string","example":"96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1"},"region":{"type":"string"},"secondaryZone":{"type":"string","description":"Option to create Interconnect attachment in secondary zone","example":"true"},"state":{"type":"string"}},"description":"Google cloud Interconnect Attachment Object."},"GeneralSchema":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"GenerateBootstrapConfigForVedge":{"type":"object","properties":{"bootstrapConfig":{"type":"string","example":"#cloud-config\\nvinitparam:\\n - uuid : ESR-6300-LIC-K9-FAUSTEST126\\n - vbond : 10.0.12.26\\n - org : vIPtela Inc Regression\\n"}}},"GenerateBootstrapConfigForVedgesResponse":{"type":"object","properties":{"id":{"type":"string","example":"b1af2563-cfa0-4ebb-989b-4d5e87f92d45"}}},"GenerateDeactivateInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerateDeactivateInfoData"}}}},"GenerateDeactivateInfoData":{"type":"object","properties":{"availableVersions":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"device-model":{"type":"string","example":"vedge-C8000V"},"device-type":{"type":"string","example":"vedge"},"host-name":{"type":"string","example":"vm5"},"personality":{"type":"string","example":"vedge"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"500"},"system-ip":{"type":"string","example":"172.16.255.15"},"uptime-date":{"type":"string","example":"1686317760000"},"uuid":{"type":"string","example":"C8K-a06af989-6a80-472d-ac0f-ed5560b5068b"},"version":{"type":"string","example":"17.13.01.0.180213"}}},"GenerateDeviceActionList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GenerateDeviceActionListInner"}},"GenerateDeviceActionListInner":{"type":"object","properties":{"isCancelEnabled":{"type":"boolean"},"isParallelExecutionEnabled":{"type":"boolean"},"name":{"type":"string"}}},"GenerateDeviceList":{"type":"object","properties":{"data":{"type":"array","example":{"device-model":"vmanage","device-os":"next","local-system-ip":"172.16.255.22","system-ip":"172.16.255.22","site-id":"200","uuid":"b642c56f-c899-4ca4-a3d6-d915e0660f9a","platform":"x86_64","isScheduleUpgradeSupported":false,"personality":"vmanage","device-type":"vmanage","reachability":"reachable","availableVersions":[],"host-name":"vm12","version":"20.13.999-2846","layoutLevel":1,"uptime-date":1683523320000,"isMultiStepUpgradeSupported":false,"defaultVersion":"20.13.999-2846","platformFamily":"vmanage","current-partition":"20.13.999-2846"},"items":{"$ref":"#/components/schemas/GenerateDeviceListData"}}}},"GenerateDeviceListData":{"type":"object","properties":{"availableVersions":{"type":"array","items":{"type":"string"}},"current-partition":{"type":"string"},"defaultVersion":{"type":"string"},"device-model":{"type":"string"},"device-os":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"isMultiStepUpgradeSupported":{"type":"boolean"},"isScheduleUpgradeSupported":{"type":"boolean"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"personality":{"type":"string"},"platform":{"type":"string"},"platformFamily":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"system-ip":{"type":"string"},"uptime-date":{"type":"integer","format":"int32"},"uuid":{"type":"string"},"version":{"type":"string"}},"example":{"device-model":"vmanage","device-os":"next","local-system-ip":"172.16.255.22","system-ip":"172.16.255.22","site-id":"200","uuid":"b642c56f-c899-4ca4-a3d6-d915e0660f9a","platform":"x86_64","isScheduleUpgradeSupported":false,"personality":"vmanage","device-type":"vmanage","reachability":"reachable","availableVersions":[],"host-name":"vm12","version":"20.13.999-2846","layoutLevel":1,"uptime-date":1683523320000,"isMultiStepUpgradeSupported":false,"defaultVersion":"20.13.999-2846","platformFamily":"vmanage","current-partition":"20.13.999-2846"}},"GenerateDeviceStateData":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerateDeviceStateDataData"}}}},"GenerateDeviceStateDataData":{"type":"object","properties":{"@rid":{"type":"integer","format":"int32","example":3413},"auto-downstream-bandwidth":{"type":"string","example":"0"},"auto-upstream-bandwidth":{"type":"string","example":"0"},"bia-address":{"type":"string","example":"00:50:56:00:01:0e"},"createTimeStamp":{"type":"string","example":"1681732399130"},"description":{"type":"string","example":"Service Management VPN Interface Ethernet"},"hwaddr":{"type":"string","example":"00:50:56:00:01:0e"},"if-admin-status":{"type":"string","example":"if-state-up"},"if-oper-status":{"type":"string","example":"if-oper-state-ready"},"ifindex":{"type":"string","example":"1"},"ifname":{"type":"string","example":"GigabitEthernet1"},"interface-type":{"type":"string","example":"iana-iftype-ethernet-csmacd"},"ip-address":{"type":"string","example":"10.0.1.14"},"ipv4-subnet-mask":{"type":"string","example":"255.255.255.0"},"ipv4-tcp-adjust-mss":{"type":"string","example":"0"},"ipv6-tcp-adjust-mss":{"type":"string","example":"0"},"lastupdated":{"type":"integer","format":"int32","example":1682322326889},"mtu":{"type":"string","example":"1500"},"recordId":{"type":"string","example":"0:CEdgeInterfaceNode:1681732387143:3340"},"rx-drops":{"type":"integer","format":"int32","example":0},"rx-errors":{"type":"integer","format":"int32","example":1},"rx-octets":{"type":"integer","format":"int32","example":22625972},"rx-packets":{"type":"string","example":"367109"},"speed-mbps":{"type":"string","example":"1000"},"tx-drops":{"type":"integer","format":"int32","example":0},"tx-errors":{"type":"integer","format":"int32","example":0},"tx-octets":{"type":"integer","format":"int32","example":12993252},"tx-packets":{"type":"integer","format":"int32","example":38282},"vdevice-dataKey":{"type":"string","example":"172.16.255.14-512-GigabitEthernet1-10.0.1.14-00:50:56:00:01:0e"},"vdevice-host-name":{"type":"string","example":"vm4"},"vdevice-name":{"type":"string","example":"172.16.255.14"},"vmanage-system-ip":{"type":"string","example":"172.16.255.14"},"vpn-id":{"type":"string","example":"512"}}},"GenerateDeviceStateDataFields":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GenerateDeviceStateDataFieldsInner"}},"GenerateDeviceStateDataFieldsInner":{"type":"object","properties":{"dataType":{"type":"string"},"display":{"type":"string"},"property":{"type":"string"}}},"GenerateDeviceStateDataWithQueryString":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerateDeviceStateDataData"}}}},"GenerateGenericBootstrapConfigForVedges":{"type":"object","properties":{"id":{"type":"string","example":"b4d93025-cf37-41a5-a2a6-d9113ede034c"}}},"GenerateRebootDeviceList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerateRebootDeviceListData"}}}},"GenerateRebootDeviceListData":{"type":"object","properties":{"availableServices":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"device-model":{"type":"string","example":"vsmart"},"device-os":{"type":"string","example":"next"},"device-type":{"type":"string","example":"vsmart"},"host-name":{"type":"string","example":"vm10"},"layoutLevel":{"type":"integer","format":"int32","example":2},"local-system-ip":{"type":"string","example":"172.16.255.20"},"personality":{"type":"string","example":"vsmart"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"200"},"system-ip":{"type":"string","example":"172.16.255.20"},"uptime-date":{"type":"integer","format":"int32","example":1683651060000},"uuid":{"type":"string","example":"3ee91f17-fc89-4d25-9e31-684e823d5eba"},"version":{"type":"string","example":"20.13.999-2847"}}},"GenerateRediscoverInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerateRediscoverInfoData"}}}},"GenerateRediscoverInfoData":{"type":"object","properties":{"board-serial":{"type":"string","example":"12345982"},"certificate-validity":{"type":"string","example":"Valid"},"connectedVManages":{"type":"array","items":{"type":"string"}},"controlConnections":{"type":"string","example":"8"},"device-groups":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"vmanage"},"device-os":{"type":"string","example":"next"},"device-type":{"type":"string","example":"vmanage"},"deviceId":{"type":"string","example":"172.16.255.22"},"domain-id":{"type":"string","example":"0"},"host-name":{"type":"string","example":"vm12"},"isDeviceGeoData":{"type":"boolean","example":false},"lastupdated":{"type":"integer","format":"int32","example":1683524985013},"latitude":{"type":"string","example":"37.666684"},"layoutLevel":{"type":"integer","format":"int32","example":1},"local-system-ip":{"type":"string","example":"172.16.255.22"},"longitude":{"type":"string","example":"-122.777023"},"max-controllers":{"type":"string","example":"0"},"model_sku":{"type":"string","example":"None"},"personality":{"type":"string","example":"vmanage"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"200"},"state":{"type":"string","example":"green"},"state_description":{"type":"string","example":"All daemons up"},"status":{"type":"string","example":"normal"},"statusOrder":{"type":"integer","format":"int32","example":4},"system-ip":{"type":"string","example":"172.16.255.22"},"testbed_mode":{"type":"boolean","example":true},"timezone":{"type":"string","example":"UTC"},"total_cpu_count":{"type":"string","example":"4"},"uptime-date":{"type":"integer","format":"int32","example":1683523320000},"uuid":{"type":"string","example":"b642c56f-c899-4ca4-a3d6-d915e0660f9a"},"validity":{"type":"string","example":"valid"},"version":{"type":"string","example":"20.13.999-2846"}}},"GenerateRemovePartitionInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenerateRemovePartitionInfoData"}}}},"GenerateRemovePartitionInfoData":{"type":"object","properties":{"availableVersions":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"device-model":{"type":"string","example":"vmanage"},"device-type":{"type":"string","example":"vmanage"},"host-name":{"type":"string","example":"vm12"},"personality":{"type":"string","example":"vmanage"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable"},"site-id":{"type":"string","example":"200"},"system-ip":{"type":"string","example":"172.16.255.22"},"uptime-date":{"type":"string","example":"1686317760000"},"uuid":{"type":"string","example":"eb4c84bd-5da6-4adc-8ba5-21360549da74"},"version":{"type":"string","example":"20.13.999-2912"}}},"GetAccounts":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"clientEmail":{"type":"string"},"cloudGatewayEnabled":{"type":"boolean"},"cloudType":{"type":"string"},"credType":{"type":"string"},"description":{"type":"string"},"gcpBillingId":{"type":"string"},"privateKeyId":{"type":"string"},"regionList":{"type":"string"},"serviceDiscoveryEnabled":{"type":"boolean"}}},"GetAllUnclaimedDevices":{"type":"object","properties":{"@rid":{"type":"number","example":8168},"chassis-number":{"type":"string","example":"ISR4351/K9-FDO23070Y63"},"createTimeStamp":{"type":"number","example":1693223805135},"lastupdated":{"type":"number","example":1693223805106},"org":{"type":"string","example":"srikann-viptela"},"serial-number":{"type":"string","example":"383CB73"},"status":{"type":"string"},"subject-serial-number":{"type":"string","example":"FDO23070Y63"},"vdevice-dataKey":{"type":"string","example":"1.1.1.2-ISR4351/K9-FDO23070Y63"},"vdevice-host-name":{"type":"string","example":"vbond-ztp"},"vdevice-name":{"type":"string","example":"1.1.1.2"},"vmanage-system-ip":{"type":"string","example":"1.1.1.2"}}},"GetAuditLogAggregation":{"required":["header"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"entryTimeList":{"type":"array","items":{"type":"string"}},"header":{"$ref":"#/components/schemas/AuditLogHeader"}}},"GetAuditLogBySeverity":{"required":["data","header"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"header":{"$ref":"#/components/schemas/AuditLogHeader"},"total_records":{"type":"integer","format":"int32","example":2}}},"GetAuditLogData":{"required":["data","header"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"header":{"$ref":"#/components/schemas/AuditLogHeader"}}},"GetAuditLogDoccount":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":44}}},"GetBootstrapConfigZip":{"type":"object","properties":{"file":{"type":"string","example":"binary"}}},"GetControlConnections":{"type":"object","properties":{"actualControlConnectionsToVsmart":{"type":"integer","format":"int32","example":0},"data":{"type":"array","items":{"$ref":"#/components/schemas/ControlConnectionInfo"}},"expectedControlConnectionsToVsmart":{"type":"integer","format":"int32","example":2}}},"GetControllerVEdgeSyncStatus":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GetControllerVEdgeSyncStatusData"}}},"GetControllerVEdgeSyncStatusData":{"type":"object","properties":{"ControllersOutOfSync":{"type":"number","example":1},"tenantList":{"type":"array","items":{"$ref":"#/components/schemas/GetControllerVEdgeSyncStatusDataTenantList"}},"totalControllers":{"type":"number","example":4}}},"GetControllerVEdgeSyncStatusDataTenantList":{"type":"object","properties":{"chasisNumber":{"type":"string","example":"71001c48-fdcf-4ac0-aaf3-ca4a20386a18"},"deviceType":{"type":"string","example":"vedge"},"managementSystemIP":{"type":"string","example":"172.18.47.115"},"serialNumber":{"type":"string","example":"f0b1985ba82e4c4889c225c59ca9a878"},"tenant":{"type":"string","example":"tenantName"}}},"GetDataCenters":{"type":"object","properties":{"mapping":{"type":"array","items":{"$ref":"#/components/schemas/MappingEntries"}},"title":{"type":"string"}}},"GetDeviceConfiguration":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BringupInfo"}}}},"GetDeviceLicenses":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetDeviceLicensesInner"}},"GetDeviceLicensesInner":{"type":"object","properties":{"billing_model":{"type":"string","example":"committed"},"billing_type":{"type":"string","example":"PREPAID"},"display_name":{"type":"string","example":"Routing DNA Advantage: Tier 2"},"end_date":{"type":"string","example":"2025-Nov-08"},"inUse":{"type":"string","example":"4"},"license_category":{"type":"string","example":"regular"},"license_type":{"type":"string","example":"TERM"},"saname":{"type":"string","example":"testaccount1.viptela.com"},"start_date":{"type":"string","example":"2023-Aug-29"},"subscription_id":{"type":"string","example":"SR100446"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T2_A,1.0_b072e613-aa2c-4ed0-ab46-ae91ddc7dfb5"},"vaname":{"type":"string","example":"DEFAULT"}}},"GetFileDownloadStatusRes":{"type":"object","properties":{"fileDownloadStatus":{"type":"string","example":"NOT_STARTED","enum":["NOT_STARTED","STARTED","IN_PROGRESS","COMPLETED","ERROR"]},"sessionStatus":{"type":"string","enum":["START","STOP","IN_PROGRESS","NOT_STARTED"]}}},"GetHSECDevicesPayloadInner":{"type":"object","properties":{"configuredSystemIP":{"type":"string","example":"172.16.255.15"},"deviceModel":{"type":"string","example":"vedge-C8000V"},"hostName":{"type":"string","example":"hostname"},"hsecLicenseStatus":{"type":"string","example":"assigned"},"isHsecSupported":{"type":"boolean","example":true},"reachability":{"type":"string","example":"reachability"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T2_A,1.0_b072e613-aa2c-4ed0-ab46-ae91ddc7dfb5"},"uuid":{"type":"string","example":"C8K-a9d1a657-790a-40d6-a9bd-a55751e73340"}}},"GetHSECInstallDevicesPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetHSECDevicesPayloadInner"}},"GetImageProperties":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetImagePropertiesData"}}}},"GetImagePropertiesData":{"type":"object","properties":{"imagePropertiesJson":{"$ref":"#/components/schemas/GetImagePropertiesImagePropertiesJson"}}},"GetImagePropertiesImagePropertiesJson":{"type":"object","properties":{"image_properties":{"$ref":"#/components/schemas/GetImagePropertiesImagePropertiesJsonImageProperties"}}},"GetImagePropertiesImagePropertiesJsonImageProperties":{"type":"object","properties":{"applicationDescription":{"type":"string","example":"Unified Threat Defense"},"applicationMaxInstances":{"type":"number","example":1},"applicationVendor":{"type":"string","example":"Cisco Systems, Inc."},"arch":{"type":"string","example":"aarch64"},"imageType":{"type":"string","example":"lxc"},"name":{"type":"string","example":"UTD-Snort-Feature"},"version":{"type":"string","example":"1.13.5_SV3.1.55.0_XEmain"},"vnf_type":{"type":"string","example":"app-hosting"}}},"GetLicenseResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetLicenseResponseInner"}},"GetLicenseResponseInner":{"type":"object","properties":{"billing_model":{"type":"string","example":"UNCOMMITTED"},"billing_type":{"type":"string","example":"USAGE"},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicenseInfo"}},"subscription_id":{"type":"string","example":"32BJDSLL789AF"}}},"GetManagementSystemIPInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetManagementSystemIPInfoData"}}}},"GetManagementSystemIPInfoData":{"type":"object","properties":{"chasisNumber":{"type":"string","example":"b679806c-d107-4c2b-bc80-4665f1ab87a8"},"deviceType":{"type":"string","example":"vbond"},"managementSystemIP":{"type":"string","example":"172.16.255.26"},"serialNumber":{"type":"string","example":"12345712"}}},"GetMapResponse":{"type":"object","properties":{"conn":{"type":"string"},"destId":{"type":"string"},"destType":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"}}},"GetMslaDevicesPayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetSingleMslaDevicePayload"}}}},"GetRMACandidates":{"type":"object","properties":{"deviceIP":{"type":"string","example":"172.16.255.19"},"host-name":{"type":"string","example":"vm-9"},"managementSystemIP":{"type":"string","example":"172.16.255.19"},"uuid":{"type":"string","example":"ec7af44a-8731-442d-9b5e-62f3dc407454"},"validity":{"type":"string","example":"valid"}}},"GetRegions":{"type":"object","properties":{"cloudType":{"type":"string"},"regionList":{"type":"string"}}},"GetRootCertStatusAll":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetRootCertStatusAllData"}}}},"GetRootCertStatusAllData":{"type":"object","properties":{"lastUpdateTime":{"type":"string","example":"2023-05-02 07:41:34"},"rootCertMd5":{"type":"string","example":"8b147197d6dbde1f89db5909c594d88b13a5c8bc"},"rootCertStatus":{"type":"string","example":"done"}}},"GetSingleMslaDevicePayload":{"type":"object","properties":{"License_status":{"type":"string","example":"subscribed"},"UUID":{"type":"string","example":"d8ac4576-7085-4d51-a6a1-f09600755677"},"configuredSystemIP":{"type":"string","example":"172.16.254.3"},"deviceModel":{"type":"string","example":"vedge-cloud"},"hostName":{"type":"string","example":"vm4"},"hsecCompatible":{"type":"string","example":"No"},"hsecStatus":{"type":"string","example":"-"},"licenseType":{"type":"string","example":"prepaid"},"licenses":{"type":"array","items":{"type":"string"}},"msla":{"type":"string","example":"false"},"saAccount":{"type":"string","example":"316448"},"saNamme":{"type":"string","example":"testaccount1.viptela.com"},"subscription_id":{"type":"array","items":{"type":"string"}},"tag":{"type":"array","items":{"type":"string"}},"templateName":{"type":"string","example":"t1"},"vaAccount":{"type":"array","items":{"type":"string"}},"vaName":{"type":"string","example":"vManage_SDWAN_01"}}},"GetSitesResponse":{"type":"object","properties":{"acceleratedVpn":{"type":"boolean"},"aggTunnelStatus":{"type":"string"},"attached":{"type":"boolean"},"color":{"type":"string"},"hostname":{"type":"string"},"interface":{"type":"string"},"preferredInterface":{"type":"boolean","example":true},"privateIp":{"type":"string"},"publicIp":{"type":"string"},"siteId":{"type":"string"},"systemIp":{"type":"string"},"tunnelCount":{"type":"number"},"tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"$ref":"#/components/schemas/TunnelsInner"}},"uuid":{"type":"string"}}},"GetStatDataFieldArray":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetStatDataFields"}},"GetStatDataFields":{"type":"object","properties":{"dataType":{"type":"string","example":"date"},"property":{"type":"string","example":"entry_time"}}},"GetStatQueryFieldArray":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetStatQueryFields"}},"GetStatQueryFieldOptions":{"required":["key","value"],"type":"object","properties":{"enableDateFields":{"type":"boolean","example":true},"isSelected":{"type":"boolean","example":true},"key":{"type":"string","example":"last_1_hour"},"number":{"type":"string","example":"1"},"value":{"type":"string","example":"Last 1 hour"}}},"GetStatQueryFields":{"required":["dataType","isRequired","multiSelect","name","property"],"type":"object","properties":{"dataType":{"type":"string","example":"date"},"fieldData":{"$ref":"#/components/schemas/GetStatQueryFieldsFieldData"},"isRequired":{"type":"boolean","example":true},"multiSelect":{"type":"boolean","example":true},"name":{"type":"string","example":"vmanage.server.auditlog.auditLogTime"},"options":{"type":"array","items":{"$ref":"#/components/schemas/GetStatQueryFieldOptions"}},"property":{"type":"string","example":"entry_time"}}},"GetStatQueryFieldsFieldData":{"type":"object","properties":{"type":{"type":"string","example":"dateList"}}},"GetTenantManagementSystemIPs":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/GetTenantManagementSystemIPsInner"}},"GetTenantManagementSystemIPsInner":{"type":"object","properties":{"chasisNumber":{"type":"string","example":"6a417181-11ba-4753-a68b-0e72440ebb49"},"deviceType":{"type":"string","example":"vsmart"},"managementSystemIP":{"type":"string","example":"169.254.10.6"},"serialNumber":{"type":"string","example":"12445B57"}}},"GetTunnelsResponse":{"type":"object","properties":{"Private IP":{"type":"array","items":{"$ref":"#/components/schemas/GetTunnelsResponsePrivateIP"}}}},"GetTunnelsResponsePrivateIP":{"type":"object","properties":{"hostname":{"type":"string"},"tunnels":{"type":"string"}}},"GetVnfProperties":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetVnfPropertiesData"}}}},"GetVnfPropertiesData":{"type":"object","properties":{"vnfPropertiesJson":{"$ref":"#/components/schemas/GetVnfPropertiesVnfPropertiesJson"}}},"GetVnfPropertiesVnfPropertiesJson":{"type":"object","properties":{"vnfProperties":{"$ref":"#/components/schemas/GetVnfPropertiesVnfPropertiesJsonVnfProperties"}}},"GetVnfPropertiesVnfPropertiesJsonVnfProperties":{"type":"object","properties":{"applicationDescription":{"type":"string","example":"Unified Threat Defense"},"applicationMaxInstances":{"type":"number","example":1},"applicationVendor":{"type":"string","example":"Cisco Systems, Inc."},"arch":{"type":"string","example":"x86_64"},"imageType":{"type":"string","example":"lxc"},"name":{"type":"string","example":"UTD-Snort-Feature"},"version":{"type":"string","example":"1.13.1_SV3.1.55.0_XEmain"},"vnf_type":{"type":"string","example":"app-hosting"}}},"GetVnicInfoRes":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/VnicInfo"}},"GlobalSettings":{"required":["cgwBgpAsnOffset","cloudGatewaySolution","cloudType","instanceSize","ipSubnetPool","orgBgpAsn","skuScaleUnit","softwareImageId"],"type":"object","properties":{"accountId":{"type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"cgwBgpAsnOffset":{"pattern":"^[0-9]+$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]+$","type":"string"},"cloudType":{"type":"string"},"enableAutoCorrect":{"pattern":"^(true|false)$","type":"string"},"enableDefRouteAdvertize":{"pattern":"^(true|false)$","type":"string","description":"Used for Azure Global settings"},"enableMonitoring":{"pattern":"^(true|false)$","type":"string","description":"Used for Azure Global settings"},"enablePeriodicAudit":{"pattern":"^(true|false)$","type":"string"},"instanceSize":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"intraTagComm":{"pattern":"^(true|false)$","type":"string"},"ipSubnetPool":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$","type":"string"},"mapTvpc":{"pattern":"^(true|false)$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"multicloudSystemSettings":{"$ref":"#/components/schemas/MulticloudSystemSettings"},"name":{"pattern":"^[a-zA-Z_]+$","type":"string"},"networkTier":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for GCP Global settings"},"orgBgpAsn":{"pattern":"^[0-9]+$","type":"string","description":"Used for GCP, Azure and Azure GovCloud Global settings"},"policyManagement":{"pattern":"^(true|false)$","type":"string","description":"Used for GCP Global settings"},"programDefaultRoute":{"pattern":"^(true|false)$","type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"serviceDirPollTimer":{"pattern":"^[0-9]+$","type":"string","description":"Used for GCP Global settings"},"skuScaleUnit":{"pattern":"^[0-9]+$","type":"string","description":"Used for Azure/Azure GovCloud Global settings"},"softwareImageId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]+$","type":"string"},"tunnelCount":{"pattern":"^[0-9]+$","type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"tunnelType":{"pattern":"^(ipsec|gre)$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"}}},"GlobalSettingsAdj":{"required":["cgwBgpAsnOffset","cloudGatewaySolution","cloudType","instanceSize","ipSubnetPool","orgBgpAsn","skuScaleUnit","softwareImageId"],"type":"object","properties":{"accountId":{"type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"cgwBgpAsnOffset":{"pattern":"^[0-9]+$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"cloudGatewaySolution":{"pattern":"^[a-zA-Z_]+$","type":"string"},"cloudType":{"type":"string"},"enableAutoCorrect":{"pattern":"^(true|false)$","type":"string"},"enableDefRouteAdvertize":{"pattern":"^(true|false)$","type":"string","description":"Used for Azure Global settings"},"enableMonitoring":{"pattern":"^(true|false)$","type":"string","description":"Used for Azure Global settings"},"enablePeriodicAudit":{"pattern":"^(true|false)$","type":"string"},"instanceSize":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"intraTagComm":{"pattern":"^(true|false)$","type":"string"},"ipSubnetPool":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))(?:\\s*,\\s*(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9]))*$","type":"string"},"mapTvpc":{"pattern":"^(true|false)$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"},"multicloudSystemSettings":{"$ref":"#/components/schemas/MulticloudSystemSettings"},"name":{"pattern":"^[a-zA-Z_]+$","type":"string"},"networkTier":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for GCP Global settings"},"orgBgpAsn":{"pattern":"^[0-9]+$","type":"string","description":"Used for GCP, Azure and Azure GovCloud Global settings"},"policyManagement":{"pattern":"^(true|false)$","type":"string","description":"Used for GCP Global settings"},"programDefaultRoute":{"pattern":"^(true|false)$","type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"serviceDirPollTimer":{"pattern":"^[0-9]+$","type":"string","description":"Used for GCP Global settings"},"skuScaleUnit":{"pattern":"^[0-9]+$","type":"string","description":"Used for Azure/Azure GovCloud Global settings"},"softwareImageId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]+$","type":"string"},"tunnelCount":{"pattern":"^[0-9]+$","type":"string","description":"Used for AWS/AWS GovCloud Global settings"},"tunnelType":{"pattern":"^(ipsec|gre)$","type":"string","description":"Used for GCP, AWS and AWS GovCloud Global settings"}}},"GroupId":{"type":"object","properties":{"groupId":{"type":"string"}},"description":"This is the valid GroupId"},"GuestWifi":{"type":"object","properties":{"securityAuthType":{"pattern":"(OPEN|WPA2-PSK_AES)","type":"string"},"ssid":{"maxLength":32,"minLength":1,"type":"string"},"visibility":{"type":"boolean"},"wpaPskKey":{"type":"string"}}},"GwDeviceSiteIds":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"integer","format":"int64"}},"GwDeviceStatus":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"},"statusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}},"unreachableCount":{"type":"integer","format":"int64"}}},"GwSiteStatus":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"},"statusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}}}},"GwStatus":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"name":{"type":"string"},"statusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}}}},"HandleFileGenerationStatusNotificationRequest":{"required":["detailedMessage","status","transactionId"],"type":"object","properties":{"checksum":{"type":"string","description":"MD5 checksum value of the file"},"detailedMessage":{"type":"string","description":"Success or Failure reason in detail"},"fileName":{"type":"string","description":"Full path of the generated file"},"status":{"type":"string"},"transactionId":{"type":"string","description":"Transaction Id sent in the file generation RPC"}}},"Header":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/HeaderElement"}},"name":{"type":"string"},"value":{"type":"string"}}},"HeaderElement":{"type":"object","properties":{"name":{"type":"string"},"parameterCount":{"type":"integer","format":"int32"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}},"value":{"type":"string"}}},"HeaderObject":{"type":"object","properties":{"columns":{"type":"object","example":{}},"fields":{"type":"object","example":{}},"generatedOn":{"type":"integer","format":"int32","example":1643067620683},"viewKeys":{"type":"object","example":{}}},"description":"Header for Response"},"Hops":{"type":"object","properties":{"errorInfo":{"type":"string","example":"Host unreachable"},"hopName":{"type":"string"},"hopNumber":{"type":"string","example":"1"},"ipAddress":{"type":"string","example":"3::2"},"meanLatency":{"type":"string","example":"1.269"}}},"Host":{"type":"object","properties":{"dataCenterName":{"pattern":"^[a-zA-Z0-9_]*$","type":"string"},"dcPersonality":{"pattern":"^(primary|secondary|arbitrator)$","type":"string"},"ifname":{"pattern":"^[a-zA-Z0-9_ ]*$","type":"string"},"ip":{"pattern":"^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string"},"name":{"pattern":"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-_]*[a-zA-Z0-9])?)?$","type":"string"},"serialno":{"type":"string"}}},"HostVpcTagPost":{"type":"object","properties":{"hostVpcs":{"type":"array","description":"Used for AWS, AWS GovCloud and GCP cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPostHostVpcsItems"}},"interconnectTag":{"type":"boolean"},"tagName":{"type":"string"},"vnets":{"type":"array","description":"Used for Azure and Azure GovCloud cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPostVnetsItems"}}}},"HostVpcTagPostAdj":{"required":["tagName"],"type":"object","properties":{"hostVpcs":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Used for AWS, AWS GovCloud and GCP cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPostHostVpcsItems"}},"interconnectTag":{"type":"boolean"},"tagName":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"vnets":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Used for Azure and Azure GovCloud cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPostVnetsItems"}}}},"HostVpcTagPut":{"type":"object","properties":{"hostVpcs":{"type":"array","description":"Used for AWS, AWS GovCloud and GCP cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPutHostVpcsItems"}},"interconnectTag":{"type":"boolean"},"tagName":{"type":"string"},"vnets":{"type":"array","description":"Used for Azure and Azure GovCloud cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPutVnetsItems"}}}},"HostVpcTagPutAdj":{"required":["hostVpcs","tagName","vnets"],"type":"object","properties":{"hostVpcs":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Used for AWS, AWS GovCloud and GCP cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPutHostVpcsItems"}},"interconnectTag":{"type":"boolean"},"tagName":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"vnets":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Used for Azure and Azure GovCloud cloud types","items":{"$ref":"#/components/schemas/AllOfhostVpcTagPutVnetsItems"}}}},"HostVpcTagResponse":{"required":["accountId","cloudType","hostVpcId","region","vnetId"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"hostVpcId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroups":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"tag":{"type":"string"},"vnetId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"}}},"HostVpcsResponse":{"required":["accountId","cloudType","hostVpcId","region","vnetId"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"hostVpcId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"hostVpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for AWS, AWS GovCloud and GCP cloud types"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroups":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetId":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vnetKey":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"},"vpcName":{"pattern":"^[a-zA-Z0-9_/\\-]*$","type":"string","description":"Used for Azure and Azure GovCloud cloud types"}}},"HttpError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Message about bad request or parameters errors"},"errorType":{"type":"string","description":"Type of error"},"operation":{"type":"string","description":"Operation title"}}},"IDPInfo":{"type":"object","properties":{"domains":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"idpMetadata":{"type":"string"},"mode":{"type":"string"}}},"Image":{"type":"object","properties":{"image":{"type":"string"}},"description":"This is the valid Image type "},"ImageData":{"type":"object","properties":{"applicationVendor":{"type":"string"},"applicationVendorVendor":{"type":"string","writeOnly":true},"arch":{"type":"string"},"controllerVersion":{"type":"string"},"cwVersion":{"type":"string"},"description":{"type":"string"},"displayChecksum":{"type":"string"},"displayChecksumType":{"type":"string"},"displayChecksumValidity":{"type":"string"},"family":{"type":"string"},"fileEntries":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"fileSizeStr":{"type":"string"},"fileSizebyte":{"type":"string"},"imagePropertiesJson":{"type":"string"},"imageType":{"type":"string","enum":["ImageType{type='software'}","ImageType{type='container'}","ImageType{type='lxc'}","ImageType{type='virtualmachine'}","ImageType{type='virtualmachine-diskimg'}","ImageType{type='virtualmachine-scaffold'}","ImageType{type='utdsignature'}","ImageType{type='utdsignatureips'}","ImageType{type='utdsignaturecustom'}","ImageType{type='waas'}","ImageType{type='dockertype'}","ImageType{type='firmware'}","ImageType{type='rumreport'}","ImageType{type='licensefile'}","ImageType{type='ackfile'}","ImageType{type='na'}"]},"imageTypeName":{"type":"string"},"md5Checksum":{"type":"string"},"networkFunctionType":{"type":"string"},"remoteServerId":{"type":"string"},"remoteServers":{"type":"string"},"sha256Checksum":{"type":"string"},"sha512Checksum":{"type":"string"},"smuCompatibleWith":{"type":"string"},"smuDefectId":{"type":"string"},"smuDescription":{"type":"string"},"smuType":{"type":"string"},"storageData":{"type":"string"},"systemPropertiesXml":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tempImagePath":{"type":"string"},"updatedFileName":{"type":"string"},"version":{"type":"string"},"versionTypeName":{"type":"string"},"vnfPropertiesJson":{"type":"string"}}},"ImportTraceRequest":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}},"ImportTraceResponse":{"type":"object","properties":{"msg":{"type":"string"},"state":{"type":"boolean"}}},"InProgressCount":{"type":"object","properties":{"inProgressCount":{"type":"integer","format":"int32","example":5}}},"InitBlob":{"type":"object","properties":{"vmanage_init_blob":{"$ref":"#/components/schemas/InitBlobVmanageInitBlob"}}},"InitBlobVmanageInitBlob":{"required":["internalCredentials","jwtCredentials","mode","pnp"],"type":"object","properties":{"internalCredentials":{"$ref":"#/components/schemas/InitBlobVmanageInitBlobInternalCredentials"},"jwtCredentials":{"$ref":"#/components/schemas/InitBlobVmanageInitBlobJwtCredentials"},"mode":{"type":"string","description":"vManage Mode","enum":["SDWANaaS","default"]},"pnp":{"$ref":"#/components/schemas/InitBlobVmanageInitBlobPnp"},"sdwanPortalUrl":{"type":"string","description":"SDWAN Portal Url"},"webhookUrl":{"type":"string","description":"Webhook Url to send notifications"}}},"InitBlobVmanageInitBlobInternalCredentials":{"required":["password","resetUrl","userName"],"type":"object","properties":{"password":{"type":"string","description":"password"},"resetUrl":{"type":"string","description":"Url to reset credentials"},"userName":{"type":"string","description":"userName"}}},"InitBlobVmanageInitBlobJwtCredentials":{"required":["client_id","client_secret","resetUrl","tokenUrl"],"type":"object","properties":{"client_id":{"type":"string","description":"client id"},"client_secret":{"type":"string","description":"client secret"},"resetUrl":{"type":"string","description":"Url to reset credentials"},"tokenUrl":{"type":"string","description":"Url to fetch token"}}},"InitBlobVmanageInitBlobPnp":{"required":["client_id","client_secret","resetUrl"],"type":"object","properties":{"client_id":{"type":"string","description":"client id"},"client_secret":{"type":"string","description":"client secret"},"env":{"type":"string","description":"PnP environment","enum":["STAGING","PROD_STAGING","PRODUCTION"]},"resetUrl":{"type":"string","description":"Url to reset credentials"}}},"InitiateFileGenerationRequest":{"required":["deviceUUID","requestedFileFormat","statsCommand"],"type":"object","properties":{"deviceUUID":{"type":"string","description":"UUID of the device"},"requestedFileFormat":{"type":"string"},"statsCommand":{"type":"string"}}},"InlineResponse200":{"type":"object","properties":{"total_flow_count":{"type":"string"}}},"InlineResponse2001":{"type":"object","properties":{"edgeBillingAccountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectBillingAccountInfo"}}}},"InlineResponse20010":{"type":"object","properties":{"gcpCloudRouters":{"type":"array","items":{"$ref":"#/components/schemas/GcpCloudRouter"}}}},"InlineResponse20011":{"type":"object","properties":{"portSpeeds":{"type":"array","description":"Supported speeds","example":["50, 100"],"items":{"type":"string","description":"Supported speeds","example":"[\"50, 100\"]"}}}},"InlineResponse20012":{"type":"object","properties":{"dlMetroBandwidth":{"type":"integer","description":"Device-Link metro speed","format":"int64","example":200}}},"InlineResponse20013":{"type":"object","properties":{"topology":{"$ref":"#/components/schemas/InlineResponse20013Topology"}}},"InlineResponse20013Topology":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse20013TopologyDevices"}}}},"InlineResponse20013TopologyCriteria":{"type":"object","properties":{"attribute":{"type":"string","description":"Name of attribute type","example":"tag"},"value":{"type":"string","description":"Value of attribute","example":"ICGW_NAME"}}},"InlineResponse20013TopologyDevices":{"type":"object","properties":{"criteria":{"$ref":"#/components/schemas/InlineResponse20013TopologyCriteria"},"unsupportedFeatures":{"$ref":"#/components/schemas/InlineResponse20013TopologyUnsupportedFeatures"}}},"InlineResponse20013TopologyUnsupportedFeatures":{"type":"object","properties":{"parcelId":{"type":"string","description":"Config-Group Parcel Id","example":"e16efd46-6d7b-4d09-872d-d34ce307400f"},"parcelType":{"type":"string","description":"Config-Group Parcel Type","example":"wan/vpn/interface/ethernet"}}},"InlineResponse20014":{"type":"object","properties":{"creationOptions":{"$ref":"#/components/schemas/InlineResponse20014CreationOptions"}}},"InlineResponse20014CreationOptions":{"type":"object","properties":{"expressRouteCircuitServiceProviderList":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse20014CreationOptionsExpressRouteCircuitServiceProviderList"}},"resourceGroupList":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse20014CreationOptionsResourceGroupList"}}}},"InlineResponse20014CreationOptionsExpressRouteCircuitServiceProviderList":{"type":"object","properties":{"bandwidthsOffered":{"type":"array","example":[50,100,200],"items":{"type":"integer","format":"int64"}},"id":{"type":"string"},"location":{"type":"string"},"name":{"type":"string"},"peeringLocations":{"type":"array","items":{"type":"string"}},"provisioningState":{"type":"string","description":"Provisioning state of the resource","example":"Succeeded"},"type":{"type":"string","description":"Type of Resource","example":"/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/"}}},"InlineResponse20014CreationOptionsResourceGroupList":{"type":"object","properties":{"id":{"type":"string"},"location":{"type":"string"},"name":{"type":"string"}}},"InlineResponse20015":{"type":"object","properties":{"swPackages":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectServiceTypes"}}}},"InlineResponse20016":{"type":"object","properties":{"sshKeys":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectSshKeyInfo"}}}},"InlineResponse2002":{"type":"object","properties":{"loopbackCgwColor":{"type":"array","example":["gold","biz-internet","private1","private2"],"items":{"type":"string","example":"[\"gold\",\"biz-internet\",\"private1\",\"private2\"]"}},"loopbackTunnelColor":{"type":"array","example":["gold","biz-internet","private1","private2"],"items":{"type":"string","example":"[\"gold\",\"biz-internet\",\"private1\",\"private2\"]"}}}},"InlineResponse2003":{"type":"object","properties":{"configuredHostname":{"type":"string","example":"ICGW1"},"configuredSystemIP":{"type":"string","example":"1.1.1.10"},"deviceModel":{"type":"string","example":"C8000v"},"uuid":{"type":"string"}}},"InlineResponse2004":{"type":"object","properties":{"data":{"type":"array","example":[{"size":"Small","spec":"small"},{"size":"Medium","spec":"medium"}],"items":{"$ref":"#/components/schemas/InlineResponse2004Data"}}}},"InlineResponse2004Data":{"type":"object","properties":{"size":{"type":"string","description":"instance size","example":"Small"},"spec":{"type":"string","description":"instance size","example":"small"}},"example":[{"size":"Small","spec":"small"},{"size":"Medium","spec":"medium"}]},"InlineResponse2005":{"type":"object","properties":{"data":{"type":"array","example":["C8000v 17.05.01a","C8000v 17.06.01a"],"items":{"type":"string","example":"[\"C8000v 17.05.01a\",\"C8000v 17.06.01a\"]"}}}},"InlineResponse2006":{"type":"object","properties":{"edgePartnerPortsList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectPartnerPorts"}}}},"InlineResponse2007":{"type":"object","properties":{"portSpeeds":{"type":"array","example":["50","100","200","500","1000","5000"],"items":{"type":"string","example":"[\"50\",\"100\",\"200\",\"500\",\"1000\",\"5000\"]"}}}},"InlineResponse2008":{"type":"object","properties":{"connectivityGateway":{"type":"array","items":{"$ref":"#/components/schemas/CloudConnectivityGateway"}}},"description":"Cloud Connectivity Gateway Object"},"InlineResponse2009":{"type":"object","properties":{"vWans":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse2009VWans"}}}},"InlineResponse2009VWans":{"type":"object","properties":{"vWan":{"$ref":"#/components/schemas/AzureVirtualWan"},"vWanInUse":{"type":"boolean","example":false}}},"InlineResponse200RunningTasks":{"type":"object","properties":{"action":{"type":"string"},"detailsURL":{"type":"string"},"endTime":{"type":"string"},"name":{"type":"boolean"},"processId":{"type":"string"},"rid":{"type":"string"},"scheduledAction":{"type":"boolean"},"startTime":{"type":"string"},"status":{"type":"string"},"tenantId":{"type":"string"},"tenantName":{"type":"string"},"userSessionIP":{"type":"string"},"userSessionUserName":{"type":"string"}}},"InlineResponse200Topology":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/InlineResponse200TopologyDevices"}}}},"InlineResponse200TopologyCriteria":{"type":"object","properties":{"attribute":{"type":"string","description":"Name of attribute type","example":"tag"},"value":{"type":"string","description":"Value of attribute","example":"CGW_NAME"}}},"InlineResponse200TopologyDevices":{"type":"object","properties":{"criteria":{"$ref":"#/components/schemas/InlineResponse200TopologyCriteria"},"unsupportedFeatures":{"$ref":"#/components/schemas/InlineResponse200TopologyUnsupportedFeatures"}}},"InlineResponse200TopologyUnsupportedFeatures":{"type":"object","properties":{"parcelId":{"type":"string","description":"Config-Group Parcel Id","example":"e16efd46-6d7b-4d09-872d-d34ce307400f"},"parcelType":{"type":"string","description":"Config-Group Parcel Type","example":"wan/vpn/interface/ethernet"}}},"InlineResponse400":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/InlineResponse400Error"}}},"InlineResponse400Error":{"type":"object","properties":{"code":{"type":"string","description":"Error code associated with the error event"},"details":{"type":"string","description":"Error message details"},"message":{"type":"string","description":"Error message title"},"type":{"type":"string","description":"Error message type"}}},"InstallPkg":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}},"InstalledCerts":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/InstalledCertsInner"}},"InstalledCertsInner":{"type":"object","properties":{"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----"},"signerVmanageUUID":{"type":"string"}}},"InstanceSizeResponse":{"type":"object","properties":{"size":{"type":"string","example":"n1-standard-4"},"spec":{"type":"string","example":"n1-standard-4 (4 vCPU)"}}},"InterconnectAccount":{"required":["attCredentials","edgeAccountId","edgeAccountName","edgeType","equinixCredentials","megaportCredentials"],"type":"object","properties":{"attCredentials":{"$ref":"#/components/schemas/InterconnectAccountAttCredentials"},"billingProviderType":{"type":"string"},"credType":{"type":"string"},"description":{"maxLength":1024,"minLength":1,"pattern":"^[a-zA-Z0-9_\\-\\s]+$","type":"string"},"edgeAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountName":{"maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_\\-\\s]+$","type":"string"},"edgeType":{"type":"string"},"equinixCredentials":{"$ref":"#/components/schemas/InterconnectAccountEquinixCredentials"},"megaportCredentials":{"$ref":"#/components/schemas/InterconnectAccountMegaportCredentials"},"regionList":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"List of regions","items":{"type":"string","description":"List of regions"}}}},"InterconnectAccountAttCredentials":{"required":["clientId","clientSecret"],"type":"object","properties":{"clientId":{"type":"string","description":"Client id of the AT&T Account.","example":"att-abcd-1234"},"clientSecret":{"type":"string","description":"Client secret of the AT&T Account.","example":"XXXX-XXXX-XXXX"}},"description":"AT&T Credential information."},"InterconnectAccountEquinixCredentials":{"required":["clientId","clientSecret"],"type":"object","properties":{"clientId":{"type":"string","description":"Client id of the Equinix Account.","example":"abcd-1234"},"clientSecret":{"type":"string","description":"Client secret of the Equinix Account.","example":"XXXX-XXXX-XXXX"}},"description":"Equinix Credential information."},"InterconnectAccountMegaportCredentials":{"required":["password","username"],"type":"object","properties":{"password":{"type":"string","description":"Password of the Megaport Account.","example":"XXXXX"},"username":{"type":"string","description":"Username of the Megaport Account.","example":"cisco@megaport.com"}},"description":"Megaport Credential Information"},"InterconnectBillingAccountInfo":{"type":"object","properties":{"edgeBillingAccountId":{"type":"string","description":"Interconnect billing account Id","example":"12345"},"edgeBillingAccountName":{"type":"string","description":"Interconnect billing account name","example":"Cisco IC"}},"description":"Interconnect billing account Information"},"InterconnectConfigGroupSettings":{"required":["configGroupId","configGroupName"],"type":"object","properties":{"configGroupId":{"maxLength":255,"minLength":1,"type":"string","description":"Config Group Id","example":"482eb6f3-1168-4b6f-901a-bd2c788b370d"},"configGroupName":{"maxLength":255,"minLength":1,"type":"string","description":"Config Group name","example":"My-CG-1"}}},"InterconnectConnectedSite":{"type":"object","properties":{"bfdSessions":{"type":"integer","format":"int32"},"bfdSessionsUp":{"type":"integer","format":"int32"},"device-model":{"type":"string"},"device-type":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"statusBfd":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"InterconnectDashboard":{"type":"object","properties":{"connections":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDashboardConnections"}},"devices":{"type":"array","items":{"type":"string"}},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeGatewayId":{"type":"string"},"edgeGatewayName":{"type":"string"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"linkList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectDashboardLinkList"}},"region":{"type":"string"},"resourceState":{"type":"string"},"resourceStateUpdateTs":{"type":"string"}}},"InterconnectDashboardConnections":{"type":"object","properties":{"connectivityName":{"type":"string"},"resourceState":{"type":"string"}}},"InterconnectDashboardLinkList":{"type":"object","properties":{"deviceLinkName":{"type":"string"},"resourceState":{"type":"string"}}},"InterconnectDeviceInfoExtended":{"type":"object","properties":{"configStatusMessage":{"type":"string"},"configuredSystemIP":{"type":"string"},"device-model":{"type":"string"},"device-type":{"type":"string"},"edgeGatewayName":{"type":"string"},"host-name":{"type":"string"},"lastUpdated":{"type":"number"},"local-system-ip":{"type":"string"},"reachability":{"type":"string"},"site-id":{"type":"string"},"status":{"type":"string"},"system-ip":{"type":"string"},"uptimeDate":{"type":"number"},"uuid":{"type":"string"},"version":{"type":"string"}}},"InterconnectDeviceLink":{"required":["bandwidth","deviceLinkName","edgeAccountId","edgeType"],"type":"object","properties":{"bandwidth":{"type":"string","description":"Device-Link Bandwidth Input.","example":"50"},"deviceLinkName":{"maxLength":50,"minLength":3,"pattern":"^[\\w.-]{3,50}$","type":"string","description":"Name of the Interconnect Device-Link.","example":"my-device-link"},"deviceLinkUuid":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string","description":"Uuid of the Interconnect Device-Link","example":"496bddbd-e104-44a7-ba62-7a285f642304"},"deviceLinksubnet":{"type":"string","description":"Subnet pool for Interconnect Gateway interfaces in the Device-Link.","example":"20.10.0.0/16"},"deviceList":{"maxItems":2147483647,"minItems":2,"type":"array","items":{"$ref":"#/components/schemas/InterconnectDeviceLinkDeviceList"}},"dlMetroBandwidth":{"type":"string","description":"Device-Link Bandwidth at a given Metro.","example":"150"},"edgeAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountName":{"maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9_\\-\\s]+$","type":"string"},"edgeType":{"type":"string"},"linkBandwidth":{"type":"string","description":"Device-Link Bandwidth.","example":"50"},"resourceState":{"type":"string"},"resourceStateMessage":{"type":"string"},"resourceStateUpdateTs":{"type":"string"},"subnet":{"pattern":"^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$","type":"string","description":"Subnet pool for Interconnect Gateway interfaces in the Device-Link.","example":"20.10.0.0/16"},"version":{"type":"string","description":"Version of the payload.","example":"1"}},"description":"Interconnect Device-Link Object"},"InterconnectDeviceLinkDeviceList":{"type":"object","properties":{"deviceInterfaceId":{"type":"string","description":"Interface used on the Interconnect Gateway to connect to the Device-Link.","example":"GigabitEthernet4"},"deviceIntfIpAddress":{"type":"string","description":"IP assigned to the Interconnect Gateway interface to connect to the Device-Link.","example":"20.10.0.2"},"deviceName":{"pattern":"^[\\w.-]{3,50}$","type":"string","description":"Name of the Interconnect Gateway in the Device-Link.","example":"ICGW_1"},"deviceUuid":{"type":"string","description":"Uuid of Interconnect Gateway in the Device-Link.","example":"0dc43131-47c9-4fce-8499-f02e3340c9fb"},"egwLoopBackCidr":{"type":"string","description":"IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.","example":"172.31.251.8/30"}}},"InterconnectGatewayExtended":{"required":["deviceUuid","edgeAccountId","edgeBillingAccountId","edgeGatewayName","edgeType","ipTransit","licenseType","region","regionId","siteName"],"type":"object","properties":{"configGroupSettings":{"$ref":"#/components/schemas/InterconnectConfigGroupSettings"},"description":{"maxLength":255,"minLength":1,"type":"string"},"deviceUuid":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeBillingAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"edgeType":{"type":"string"},"egwBgpAsn":{"type":"string","description":"BGP ASN assigned to Interconnect Gateway","example":"64500"},"ipTransit":{"maxLength":255,"minLength":1,"type":"string"},"ipTransitId":{"type":"string"},"ipTransitSkuId":{"type":"string"},"isCustomSetting":{"type":"boolean","description":"Custom Settings enabled for Interconnect Gateway","example":true},"licenseSkuId":{"type":"string","description":"License Sku Id of Interconnect Gateway","example":"12345"},"licenseType":{"type":"string","enum":["PAYG","PREPAID","DIRECT"]},"loopbackCidr":{"type":"string","description":"Ip pool allocated to Interconnect Gateway for Loopback Interfaces","example":"172.31.251.4/30"},"mrfSettings":{"$ref":"#/components/schemas/InterconnectMrfSettings"},"region":{"maxLength":255,"minLength":1,"type":"string"},"regionId":{"maxLength":255,"minLength":1,"type":"string"},"resourceState":{"type":"string"},"resourceStateMessage":{"type":"string"},"resourceStateUpdateTs":{"type":"string"},"serviceChainAttachments":{"type":"string"},"settings":{"$ref":"#/components/schemas/InterconnectGatewaySettings"},"siteName":{"maxLength":255,"minLength":1,"type":"string"}}},"InterconnectGatewayMonitoring":{"required":["deviceUuid","edgeAccountId","edgeGatewayName","edgeType","region","siteName"],"type":"object","properties":{"description":{"maxLength":255,"minLength":1,"type":"string"},"deviceUuid":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountId":{"maxLength":255,"minLength":1,"type":"string"},"edgeAccountName":{"type":"string"},"edgeGatewayId":{"type":"string"},"edgeGatewayName":{"maxLength":255,"minLength":1,"type":"string"},"edgeType":{"type":"string"},"isCustomSetting":{"type":"boolean","description":"Custom Settings enabled for Interconnect Gateway","example":true},"region":{"maxLength":255,"minLength":1,"type":"string"},"resourceState":{"type":"string"},"siteName":{"maxLength":255,"minLength":1,"type":"string"},"status":{"type":"string"}}},"InterconnectGatewaySettings":{"required":["instanceSize","softwareImageId"],"type":"object","properties":{"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX","ATT"]},"egwCustomSettingName":{"type":"string","description":"Assigned name of the Interconnect Gateway Custom Settings"},"instanceSize":{"maxLength":255,"minLength":1,"type":"string"},"ipSubnetPool":{"type":"string","description":"Ip subnet pool assigned to the gateway","example":"192.168.10.0/24"},"softwareImageId":{"maxLength":255,"minLength":1,"pattern":"^C8000v.*$","type":"string"}}},"InterconnectGlobalSettings":{"required":["bgpAsn","edgeGatewaySolution","edgeType","instanceSize","loopbackCgwColor","loopbackTunnelColor","softwareImageId"],"type":"object","properties":{"bgpAsn":{"pattern":"\\d+","type":"string"},"edgeGatewaySolution":{"type":"string"},"edgeType":{"type":"string"},"instanceSize":{"maxLength":255,"minLength":1,"type":"string"},"invoiceReference":{"type":"string"},"ipSubnetPool":{"type":"string"},"loopbackCgwColor":{"type":"string"},"loopbackTunnelColor":{"type":"string"},"multicloudSystemSettings":{"$ref":"#/components/schemas/MulticloudSystemSettings"},"softwareImageId":{"maxLength":255,"minLength":1,"pattern":"^C8000v.*$","type":"string"}}},"InterconnectLicense":{"type":"object","properties":{"currentStatus":{"type":"string","example":"AVAILABLE"},"edgeAccountName":{"type":"string","example":"mp-license-acc"},"endDate":{"type":"string","example":"2025-01-15"},"prodType":{"type":"string","example":"AWSHC"},"sku":{"type":"string","example":"AWS-HC-IIVXC-C"},"skuDaysForExpiry":{"type":"number","example":924},"skuId":{"type":"string"},"smartAccountId":{"type":"string","example":"100259"},"startDate":{"type":"string","example":"2022-01-19"},"subscriptionReferenceId":{"type":"string","example":"Sub1077241"},"technicalServiceUid":{"type":"string"},"virtualAccountId":{"type":"string","example":"109733"},"vxcBandwidth":{"type":"string","example":"1000"},"webOrderId":{"type":"string","example":"91358156"}}},"InterconnectLocationInfoAtt":{"type":"object","properties":{"attNEInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo"},"metroCode":{"type":"string","example":"DT"},"metroName":{"type":"string"},"networkRegion":{"type":"string","example":"AMER"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"InterconnectLocationInfoEquinix":{"type":"object","properties":{"eqBillingAccountInfoList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectBillingAccountInfo"}},"eqNEInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo"},"metroCode":{"type":"string","example":"DT"},"metroName":{"type":"string"},"networkRegion":{"type":"string","example":"AMER"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"InterconnectLocationInfoMegaport":{"type":"object","properties":{"address":{"type":"string","example":"24700"},"country":{"type":"string","example":"USA"},"liveDate":{"type":"string","example":"1589292000000"},"market":{"type":"string","example":"US"},"metroName":{"type":"string","example":"Detroit"},"mpMVEInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo"},"networkRegion":{"type":"string","example":"MP1"},"siteCode":{"type":"string","example":"det-on1"},"status":{"type":"string","example":"Active"}}},"InterconnectLocationInfoMegaportMpMVEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","example":["oldest","current","newest"],"items":{"type":"string","example":"[\"oldest\",\"current\",\"newest\"]"}},"productSizeList":{"type":"array","example":["small","medium","large"],"items":{"type":"string","example":"[\"small\",\"medium\",\"large\"]"}}}},"InterconnectLocations":{"type":"object","properties":{"edgeLocationInfoList":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectLocationsEdgeLocationInfoList"}}}},"InterconnectLocationsEdgeLocationInfoList":{"type":"object","properties":{"attLocationInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoAtt"},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"eqLocationInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoEquinix"},"locationId":{"type":"string"},"locationName":{"type":"string"},"mpLocationInfo":{"$ref":"#/components/schemas/InterconnectLocationInfoMegaport"}}},"InterconnectMrfSettings":{"type":"object","properties":{"mrfRouterRole":{"type":"string","description":"Multi Region Fabric router role","example":"border"},"mrfTransportGateway":{"type":"boolean","description":"Multi Region Fabric Transport Gateway","example":false},"nhmRegionId":{"type":"integer","description":"Network Hierarchy Region Id","format":"int64","example":123},"nhmRegionName":{"type":"string","description":"Network Hierarchy Region name","example":"My-Region"}}},"InterconnectPartnerPorts":{"type":"object","properties":{"attPartnerPort":{"$ref":"#/components/schemas/InterconnectPartnerPortsDetails"},"cloudType":{"type":"string","enum":["AWS","AWS_GOVCLOUD","AZURE","AZURE_GOVCLOUD","GCP"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"eqPartnerPort":{"$ref":"#/components/schemas/InterconnectPartnerPortsDetails"},"locationId":{"type":"string"},"mpPartnerPort":{"$ref":"#/components/schemas/InterconnectPartnerPortsDetails"},"name":{"type":"string"}},"description":"Interconnect partner port information"},"InterconnectPartnerPortsDetails":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string","description":"Megaport companyId for the region.","example":"2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc"},"connectType":{"type":"string","enum":["AWS","AWSHC","PRIMARY","SECONDARY","INTERCONNECT_ATTACHMENT"]},"productUid":{"type":"string","description":"Megaport id for the region.","example":"2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc"},"speed":{"type":"string","description":"Bandwidth speeds supported at the region."},"vxcId":{"type":"string","description":"Cross connect (VXC) id connected to the region","example":"None"},"vxcPermitted":{"type":"boolean","description":"Cross Connect enabled Megaport region.","example":true}},"description":"Megaport specific partner port fields."},"InterconnectService":{"type":"object","properties":{"flavor":{"type":"string","description":"Virtual Instance flavor of the service instance","example":"VM100"},"interfaceCount":{"type":"string","description":"Number of interfaces for the service","example":"10"},"mgmtIP":{"type":"string","description":"IP of the management interface of the service","example":"100.1.1.1"},"name":{"type":"string","description":"Name of the service","example":"My-Firewall"},"serviceRegion":{"type":"string","description":"Region where the service is deployed","example":"NY"},"serviceRole":{"type":"string","description":"HA role of the service","example":"Primary"},"status":{"type":"string","description":"Status of the service","example":"PROMISIONED"},"swVersion":{"type":"string","description":"Software version running on the service","example":"10.1.3"},"uuid":{"type":"string","description":"provider assigned service Uuid"}}},"InterconnectServiceSwVersion":{"type":"object","properties":{"imageName":{"type":"string","description":"Service Software Version Image Name","example":"PaloAlto-VM-Series-10.1.3-9554"},"version":{"type":"string","description":"Service Software Version","example":"10.1.3"}}},"InterconnectServiceTypes":{"type":"object","properties":{"name":{"type":"string","description":"Name of the service package","example":"PA-100"},"packageCode":{"type":"string","description":"provider assigned service package code","example":"PA100"},"serviceSwVersion":{"type":"array","items":{"$ref":"#/components/schemas/InterconnectServiceSwVersion"}}}},"InterconnectSshKeyInfo":{"type":"object","properties":{"keyName":{"type":"string","description":"Ssh Key Name","example":"service-ssh-key"},"keyType":{"type":"string","description":"Ssh key Type","example":"RSA"},"keyValue":{"type":"string","description":"Ssh Key Value","example":"ssh-rsa xxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}},"InterconnectWidget":{"type":"object","properties":{"edgeGatewaySolution":{"type":"string","enum":["MVE","NE"]},"edgeType":{"type":"string","enum":["MEGAPORT","EQUINIX"]},"gwDeviceSiteIds":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"integer","format":"int64"}},"gwDeviceStatus":{"$ref":"#/components/schemas/GwDeviceStatus"},"gwSitestatus":{"$ref":"#/components/schemas/GwSiteStatus"},"gwStatus":{"$ref":"#/components/schemas/GwStatus"},"numAccounts":{"type":"integer","format":"int64"},"numConn":{"type":"integer","format":"int64"},"numSdwanTunnels":{"type":"integer","format":"int64"}}},"InterfaceAggResp":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"interface":{"type":"string"},"rx_kbps":{"type":"number"},"tx_kbps":{"type":"number"},"vdevice_name":{"type":"string"}}},"InterfaceAggRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceAggResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"interface aggregation response with page info"},"InterfaceColorResponse":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"type":"string"}},"InterfaceDocCountRequest":{"type":"object","properties":{"dataType":{"type":"string"},"property":{"type":"string"}}},"InterfaceQuery":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/QueryWithRule"}}},"InterfaceResp":{"type":"object","properties":{"device_model":{"type":"string"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"entry_time":{"type":"string"},"fec_re":{"type":"integer","format":"int32"},"fec_rx":{"type":"integer","format":"int64"},"fec_tx":{"type":"integer","format":"int64"},"host_name":{"type":"string"},"id":{"type":"string"},"jitter":{"type":"integer","format":"int32"},"latency":{"type":"number"},"local_color":{"type":"string"},"local_system_ip":{"type":"string"},"loss":{"type":"integer","format":"int32"},"loss_percentage":{"type":"integer","format":"int32"},"name":{"type":"string"},"proto":{"type":"string"},"remote_color":{"type":"string"},"remote_system_ip":{"type":"string"},"rx_octets":{"type":"integer","format":"int64"},"rx_pkts":{"type":"integer","format":"int64"},"sla_class_list":{"type":"string"},"sla_class_names":{"type":"string"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"statcycletime":{"type":"string"},"state":{"type":"string"},"tenant":{"type":"string"},"total":{"type":"integer","format":"int32"},"tunnel_color":{"type":"string"},"tx_octets":{"type":"number"},"tx_pkts":{"type":"integer","format":"int64"},"vdevice_name":{"type":"string"},"vip_idx":{"type":"integer","format":"int32"},"vmanage_system_ip":{"type":"string"},"vqoe_score":{"type":"integer","format":"int32"}},"description":"interface specific response"},"InterfaceRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"interface response with page info"},"InterfaceStatisticsRes":{"type":"object","properties":{"admin_status":{"type":"string","example":"Up"},"af_type":{"type":"string","example":"IPv4"},"bw_down":{"type":"number","example":1000000},"bw_up":{"type":"number","example":1000000},"device_model":{"type":"string","example":"vedge-C8000V"},"down_capacity_percentage":{"type":"number","example":0.0015},"entry_time":{"type":"integer","format":"int32","example":1687177528488},"host_name":{"type":"string","example":"vm6"},"id":{"type":"string","example":"ZmOr04gBUJf8VowqUaIl"},"interface":{"type":"string","example":"GigabitEthernet1"},"interface_type":{"type":"string","example":"physical"},"oper_status":{"type":"string","example":"Up"},"platform_type":{"type":"string"},"rx_drops":{"type":"number","example":0},"rx_errors":{"type":"number","example":0},"rx_kbps":{"type":"number","example":15},"rx_octets":{"type":"number","example":679091},"rx_pkts":{"type":"number","example":3876},"rx_pps":{"type":"number","example":0},"statcycletime":{"type":"integer","format":"int32","example":1687178400026},"stats_data_id":{"type":"string"},"system-ip":{"type":"string"},"tenant":{"type":"string","example":"default"},"total_mbps":{"type":"number","example":0},"tx_drops":{"type":"number","example":0},"tx_errors":{"type":"number","example":0},"tx_kbps":{"type":"number","example":14},"tx_octets":{"type":"number","example":769358},"tx_pkts":{"type":"number","example":3757},"tx_pps":{"type":"number","example":11},"up_capacity_percentage":{"type":"number","example":0.0014},"vdevice_name":{"type":"string","example":"172.16.255.16"},"vip_idx":{"type":"number","example":7},"vip_time":{"type":"integer","format":"int32"},"vmanage_system_ip":{"type":"string","example":"172.16.255.16"},"vnf_name":{"type":"string"},"vnic_id":{"type":"string"},"vpn_id":{"type":"number","example":0}}},"InvalidateVmanageRootCA":{"type":"object","properties":{"VmanageRootCAInvalidated":{"type":"string","example":"true"}}},"IpSecSecurity":{"type":"object","properties":{"authenticationType":{"pattern":"(ah-sha1-hmac|sha1-hmac)","type":"string"},"ipSecPairwiseKeying":{"type":"string"},"rekeyTime":{"type":"integer","format":"int32"},"replayWindow":{"type":"integer","format":"int32"}}},"IsVnetAttached":{"type":"object","properties":{"isVnetAttached":{"type":"boolean","example":true}}},"IseServer":{"required":["iseServerIP","password","sgt","userAndUserGroup","userName","vpn"],"type":"object","properties":{"activeDirectoryDomain":{"type":"string","example":"SDWAN-IDENTITY.CISCO.COM"},"iseCertName":{"type":"string","example":"iseCertificate"},"iseRootCert":{"type":"string"},"iseServerIP":{"type":"string","example":"172.27.216.141"},"joinPoint":{"type":"string","example":"SDWAN-IDENTITY"},"password":{"type":"string","example":"testPassword"},"pxGridCertName":{"type":"string","example":"pxGridCertificate"},"pxGridRootCert":{"type":"string"},"sgt":{"type":"string","example":"false"},"userAndUserGroup":{"type":"string","example":"true"},"userName":{"type":"string","example":"admin"},"vpn":{"type":"string","example":"0"}}},"Itemsinfo":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/RegionPrefixinfo"}},"LicenseDistribution":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/LicenseDistributionResult"}}},"LicenseDistributionResult":{"type":"object","properties":{"display_name":{"type":"string","example":"somename"},"lastUpdated":{"type":"string","example":"1706830360239"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P,1.0_5446d77e-a22d-4343-a9f9-cefb53116b22"},"totalDevices":{"type":"integer","format":"int32","example":1},"totalLicense":{"type":"integer","format":"int32","example":1}}},"LicenseInfo":{"type":"object","properties":{"Available":{"type":"string","example":"0"},"Purchased":{"type":"integer","format":"int64"},"billing_model":{"type":"string","example":"UNCOMMITTED"},"billing_type":{"type":"string","example":"USAGE"},"display_name":{"type":"string","example":"Routing DNA Essentials: Tier 1"},"inUse":{"type":"string","example":"1"},"quantity":{"type":"string","example":"1"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T1_E,1.0_e3ff4086-b5f3-4845-b0ac-7a23d3b4a139"}}},"LicenseUplodFile":{"type":"object","properties":{"data":{"type":"string"},"name":{"type":"string","format":"binary"}}},"LicensesRequest":{"type":"object","properties":{"appliedFilters":{"$ref":"#/components/schemas/AppliedFilters"},"uuids":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"LicensesResponse":{"type":"object","properties":{"baseLicenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesResponseBaseLicenses"}},"tenantLicenses":{"$ref":"#/components/schemas/LicensesResponseTenantLicenses"}}},"LicensesResponseBaseLicenses":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesResponseLicenses"}},"platformClass":{"type":"string","example":"C8530-12X4QC"},"uuids":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"LicensesResponseLicenses":{"type":"object","properties":{"available":{"type":"integer","format":"int32","example":20},"displayName":{"type":"string","example":"Advantage Large"},"inUse":{"type":"integer","format":"int32","example":5},"isPreferred":{"type":"boolean","example":true},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"}}},"LicensesResponseTenantLicenses":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesResponseLicenses"}},"totalTenantLicRequired":{"type":"integer","format":"int32","example":10}}},"LinkObject":{"type":"object","properties":{"href":{"type":"string","example":"https://172.27.216.141:9060/ers/config/adminuser/versioninfo"},"rel":{"type":"string","example":"self"},"type":{"type":"string","example":"application/json"}}},"LocalBackupInfo":{"type":"object","properties":{"backupState":{"pattern":"^(SCHEDULED|IN_PROGRESS|CONFIG_DB_BACKUP_SUCCESS|CONFIG_DB_BACKUP_FAILED|STATS_DB_EXPORT_SUCCESS|STATS_DB_EXPORT_FAILED|CONFIG_DB_CONSISTENCY_CHECK_FAILED|LEADER_SUCCESS|ALL_SUCCESS|FAILURE|DELETED)$","type":"string","description":"Current stage of database backup workflow. This could be [SCHEDULED/IN_PROGRESS/CONFIG_DB_BACKUP_SUCCESS/CONFIG_DB_BACKUP_FAILED/STATS_DB_EXPORT_SUCCESS/STATS_DB_EXPORT_FAILED/CONFIG_DB_CONSISTENCY_CHECK_FAILED/LEADER_SUCCESS/ALL_SUCCESS/FAILURE/DELETED]","example":"IN_PROGRESS"},"backupType":{"pattern":"^(SCHEDULED|ON_DEMAND)$","type":"string","description":"Type of backup. This could be [SCHEDULED/ON_DEMAND]","example":"ON_DEMAND"},"createTime":{"type":"integer","description":"Epoch timestamp","format":"int64","example":1650994911131},"destination":{"$ref":"#/components/schemas/LocalDestination"},"downloadURL":{"pattern":"^\\/dataservice\\/tenantbackup\\/download\\/\\d+\\/backup_\\d+_\\d{6}-\\d{6}\\.tar\\.gz$","type":"string","description":"Destination to download database backup from","example":"/dataservice/tenantbackup/download/1570057020772/backup_1570057020772_100919-181838.tar.gz"},"followerIpAddressList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"List of vManage servers IP address who are running in follower mode","example":["10.0.105.38","10.0.105.39"],"items":{"type":"string","description":"List of vManage servers IP address who are running in follower mode","example":"[\"10.0.105.38\",\"10.0.105.39\"]"}},"localBackupInfoId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string","description":"A unique UUID per database back up request","example":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"},"scheduleId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string","description":"A unique UUID for scheduled database backup task","example":"9b08dce2-d33f-11ec-9d64-0242ac120002"},"srcIpAddress":{"pattern":"^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","description":"IP address of the source vmanage server for database backup","example":"10.0.105.32"},"taskId":{"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","type":"string","description":"Unique task Id for a given database backup task","example":"f81ee476-d33f-11ec-9d64-0242ac120002"},"taskName":{"pattern":"^[a-zA-Z0-9 _\\-\\\\\\/]+$","type":"string","description":"Task name in human readable format","example":"Schedule backup on 6/1/2022"}}},"LocalBackupListResult":{"type":"object","properties":{"backupList":{"type":"array","description":"List of all local backup info objects in the system","items":{"$ref":"#/components/schemas/LocalBackupInfo"}}}},"LocalDestination":{"type":"object","properties":{"backupDest":{"pattern":"^(LOCAL|S3|SFTP|AZURE)$","type":"string","description":"Storage type. This could be [LOCAL/S3/SFTP/AZURE]","example":"LOCAL"},"backupDir":{"pattern":"^(?:\\/|\\w:)?(?:[\\\\\\/][\\w\\-\\s]+)*(?:[\\\\\\/])?$","type":"string","description":"Location where the database backup file on a storage type. ","example":"/opt/data/backup/scheduledbackup/"},"backupStorageInGB":{"minimum":1,"type":"integer","description":"Size of the database backup allowed to the stored at a backup destination","format":"int32","example":10},"backupTTLInDays":{"minimum":1,"type":"integer","description":"Time to live for a database backup copy in the backup destination in days","format":"int32","example":30},"numOfReplica":{"minimum":1,"type":"integer","description":"Number of replicas of the database backup file","format":"int32","example":2},"vmVersion":{"pattern":"^\\d+(\\.\\d+)*$","type":"string","description":"vManage software version against which the database backup was taken","example":"20.9"}}},"Loggers":{"type":"object","properties":{"isDebugEnabled":{"type":"boolean"},"name":{"type":"string","example":"com.cisco.example.package"}}},"LoggingSystemMessages":{"type":"object","properties":{"maxFileSize":{"type":"integer","format":"int32"},"priority":{"type":"string"},"rotations":{"type":"integer","format":"int32"}}},"LoginAccessToRouter":{"type":"object","properties":{"authenticationOrder":{"type":"string"},"localPassword":{"type":"string"},"localUser":{"type":"string"}}},"Loopback":{"type":"object","properties":{"interfaceIP":{"type":"string","example":"127.0.0.1"},"interfaceName":{"type":"string","example":"Loopback0"}}},"LteApn":{"required":["name"],"type":"object","properties":{"name":{"type":"string"}},"description":"List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false ","example":[]},"LteTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"MapDefaults":{"type":"object","properties":{"conn":{"type":"string","example":"enabled"},"connType":{"type":"string","example":"Intra"},"destType":{"type":"string","example":"vpn"},"editable":{"type":"boolean","example":false},"srcType":{"type":"string","example":"vpn"}}},"MapDevicesRequest":{"required":["devices"],"type":"object","properties":{"devices":{"type":"array","items":{"type":"string"}}}},"MapStatus":{"type":"object","properties":{"destId":{"type":"string"},"destType":{"type":"string"},"mapped":{"type":"array","items":{"$ref":"#/components/schemas/MapStatusMapped"}},"outstandingMapping":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"},"unmapped":{"type":"string"}}},"MapStatusMapped":{"type":"object","properties":{"cloudType":{"type":"string"},"destId":{"type":"string"},"destRegion":{"type":"string"},"destType":{"type":"string"},"sourceRegion":{"type":"string"},"sourceTag":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"},"tunnelId":{"type":"string"}}},"MapSummary":{"type":"object","properties":{"Account ID":{"$ref":"#/components/schemas/MapSummaryAccountID"},"Azure Virtual WAN Hub ID":{"type":"string"},"accountName":{"type":"string"},"additionalDetails":{"type":"string"},"cloudGatewayName":{"type":"string"},"cloudGatewaySolution":{"type":"string"},"cloudProviderMgmtReference":{"type":"string"},"cloudType":{"type":"string"},"connectedSites":{"type":"integer","format":"int32"},"connectivityState":{"type":"string"},"connectivityStateUpdateTs":{"type":"string"},"devices":{"type":"array","items":{"$ref":"#/components/schemas/MapSummaryDevices"}},"hostVpcs":{"$ref":"#/components/schemas/MapSummaryHostVpcs"},"operState":{"type":"string"},"region":{"type":"string"},"status":{"type":"string"},"tags":{"$ref":"#/components/schemas/MapSummaryTags"},"tunnels":{"type":"array","items":{"$ref":"#/components/schemas/MapSummaryTunnels"}},"vpns":{"$ref":"#/components/schemas/MapSummaryVpns"}}},"MapSummaryAccountID":{"type":"object","properties":{"Site To Cloud NCC Hub Name":{"type":"string"},"Site To Cloud NCC Spoke Name":{"type":"string"},"Site To Cloud Primary GCR Name":{"type":"string"},"Site To Cloud VPC ID":{"type":"string"},"Site To Cloud VPC Name":{"type":"string"},"Site To Site NCC Hub Name":{"type":"string"},"Site To Site VPC ID":{"type":"string"},"Site To Site VPC Name":{"type":"string"},"WAN VPC ID":{"type":"string"},"WAN VPC Name":{"type":"string"}}},"MapSummaryDevices":{"type":"object","properties":{"reachability":{"type":"string"},"systemIp":{"type":"string"},"uuid":{"type":"string"}}},"MapSummaryHostVpcs":{"type":"object","properties":{"accountId":{"type":"string"},"hostVpcId":{"type":"string"},"tag":{"type":"string"}}},"MapSummaryTags":{"type":"object","properties":{"tag":{"type":"string"}}},"MapSummaryTunnels":{"type":"object","properties":{"acceptedRouteCount":{"type":"integer","format":"int32"},"lastStatusChangeTimestamp":{"type":"string"},"outerIpAddr":{"type":"string"},"status":{"type":"string"},"statusMessage":{"type":"string"},"tunnelId":{"type":"string"}}},"MapSummaryVpns":{"type":"object","properties":{"vpnId":{"type":"string"}}},"MapVpnsResponse":{"type":"object","properties":{"id":{"type":"string","example":"a0b3f15d-a4e6-4e1d-86f9-8936284dbe1b"},"referenceCount":{"type":"integer","format":"int32","example":0},"segmentId":{"type":"string","example":"10"},"segmentName":{"type":"string","example":"vpn10"},"solution":{"type":"string","example":"sd-routing"}},"description":"List of vpns for MultiCloud"},"MappingEntries":{"type":"object","properties":{"CITY/COUNTRY":{"type":"string"},"FQDN":{"type":"string"},"IP":{"type":"string"}}},"MegaportCredentials":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}}},"MegaportLocationInfo":{"type":"object","properties":{"address":{"type":"string"},"country":{"type":"string"},"liveDate":{"type":"string"},"market":{"type":"string"},"metroName":{"type":"string"},"mpMVEInfo":{"$ref":"#/components/schemas/MegaportMVEInfo"},"networkRegion":{"type":"string"},"siteCode":{"type":"string"},"status":{"type":"string"}}},"MegaportMVEInfo":{"type":"object","properties":{"imageNameList":{"type":"array","items":{"type":"string"}},"productSizeList":{"type":"array","items":{"type":"string"}}}},"MegaportPartnerPort":{"type":"object","properties":{"authorizationKey":{"type":"string"},"companyUid":{"type":"string"},"connectType":{"type":"string"},"productUid":{"type":"string"},"speed":{"type":"string"},"vxcId":{"type":"string"},"vxcPermitted":{"type":"boolean"}}},"MessagingResp":{"type":"object","properties":{"deviceIP":{"type":"string","example":"172.16.255.26"},"vmanages":{"type":"array","items":{"type":"string"}}}},"MetricData":{"type":"object","properties":{"time":{"type":"string","description":"timestamp in seconds","example":"123344555"},"value":{"type":"string","description":"count/value for corresponding timestamp","example":"718"}}},"MigrateTenantModel":{"type":"object","properties":{"desc":{"type":"string"},"isDestinationOverlayMT":{"type":"boolean"},"migrationKey":{"type":"string"},"name":{"type":"string"},"orgName":{"type":"string"},"subDomain":{"type":"string"},"wanEdgeForecast":{"type":"string"}}},"Model400Error":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Model400ErrorError"}}},"Model400ErrorError":{"required":["code","details","message"],"type":"object","properties":{"code":{"type":"string","description":"Error code associated with the error event"},"details":{"type":"string","description":"Error message details"},"message":{"type":"string","description":"Error message title"}},"description":"error message"},"MplsTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"MslaLicenses":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/MslaLicensesInner"}},"MslaLicensesInner":{"type":"object","properties":{"available":{"type":"string","example":"30"},"billing_type":{"type":"string","example":"prepaid"},"display_name":{"type":"string","example":"Routing DNA Premier: Tier 3"},"end_date":{"type":"string","example":"024-Feb-25"},"inUse":{"type":"string","example":"5"},"license_category":{"type":"string","example":"Tenant"},"saname":{"type":"string","example":"testaccount1.viptela.com"},"subscription_id":{"type":"string","example":"77823882922"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T3_P,1.0_4fbf7891-fdee-4b78-9d70-696b260ef347"},"vaname":{"type":"string","example":"DEFAULT"}}},"MultiCloudEdgeAccountInfo":{"type":"object","properties":{"accountCredentials":{"type":"string"},"attCredentials":{"$ref":"#/components/schemas/AttCredentials"},"billingProviderType":{"type":"string"},"credType":{"type":"string"},"description":{"type":"string"},"edgeAccountId":{"type":"string"},"edgeAccountName":{"type":"string"},"edgeBillingAccountInfo":{"$ref":"#/components/schemas/MultiCloudEdgeBillingAccountInfo"},"edgeLocationInfoList":{"type":"array","items":{"$ref":"#/components/schemas/MultiCloudEdgeLocationInfo"}},"edgePartnerPortsList":{"type":"array","items":{"$ref":"#/components/schemas/MultiCloudEdgePartnerPort"}},"edgeType":{"type":"string"},"equinixCredentials":{"$ref":"#/components/schemas/EquinixCredentials"},"megaportCredentials":{"$ref":"#/components/schemas/MegaportCredentials"},"orgName":{"type":"string"},"regionList":{"type":"array","items":{"type":"string"}}}},"MultiCloudEdgeBillingAccountInfo":{"type":"object","properties":{"edgeBillingAccountId":{"type":"string"},"edgeBillingAccountName":{"type":"string"},"edgeType":{"type":"string"}}},"MultiCloudEdgeLocationInfo":{"type":"object","properties":{"attLocationInfo":{"$ref":"#/components/schemas/AttLocationInfo"},"edgeType":{"type":"string"},"eqLocationInfo":{"$ref":"#/components/schemas/EquinixLocationInfo"},"locationId":{"type":"string"},"locationName":{"type":"string"},"mpLocationInfo":{"$ref":"#/components/schemas/MegaportLocationInfo"}}},"MultiCloudEdgePartnerPort":{"type":"object","properties":{"attPartnerPort":{"$ref":"#/components/schemas/AttPartnerPort"},"cloudType":{"type":"string"},"edgeType":{"type":"string"},"eqPartnerPort":{"$ref":"#/components/schemas/EquinixPartnerPort"},"locationId":{"type":"string"},"mpPartnerPort":{"$ref":"#/components/schemas/MegaportPartnerPort"},"name":{"type":"string"}}},"MultiCloudGatewaysConfiggroupBody":{"required":["configGroupName"],"type":"object","properties":{"configGroupName":{"pattern":"^[a-zA-Z0-9_/\\\\\\-]+$","type":"string"},"configGroupSolution":{"pattern":"^(sdwan|sd-routing)$","type":"string"}}},"MulticloudSystemSettings":{"type":"object","properties":{"enableMonitoring":{"type":"boolean","writeOnly":true},"useConfigurationGroup":{"pattern":"^(true|false)$","type":"string","description":"Enable or disable Configuration Group for Gateways"}}},"NATRule":{"required":["description","inPort","insideIp","interface","outPort","protocol"],"type":"object","properties":{"description":{"type":"string"},"inPort":{"maximum":65535,"minimum":1,"type":"integer","format":"int32"},"insideIp":{"type":"string"},"interface":{"type":"string"},"outPort":{"maximum":65535,"minimum":1,"type":"integer","format":"int32"},"protocol":{"pattern":"^udp$|^tcp$|^icmp$","type":"string"}}},"NPingRequest":{"type":"object","properties":{"count":{"type":"string","example":"5"},"destPort":{"type":"string","example":"22"},"df":{"type":"string","example":"true"},"host":{"type":"string","example":"3::2"},"interfaceIP":{"type":"string","example":"3::1"},"mtu":{"type":"string","example":"128"},"probeType":{"type":"string","example":"tcp"},"rapid":{"type":"string","example":"true"},"size":{"type":"string","example":"128"},"source":{"type":"string","example":"3::1"},"sourcePort":{"type":"string","example":"22"},"tos":{"type":"string","example":"1"},"ttl":{"type":"string","example":"1"},"vpn":{"type":"string","example":"0"}}},"NPingResponse":{"type":"object","properties":{"avgRoundTrip":{"type":"number","example":3.964},"lossPercentage":{"type":"number","example":0},"maxRoundTrip":{"type":"number","example":14.43},"minRoundTrip":{"type":"number","example":1.221},"packetsReceived":{"type":"number","example":5},"packetsTransmitted":{"type":"number","example":5},"rawOutput":{"type":"array","items":{"type":"string"}}}},"NameValuePair":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"Neo4jMetricsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricData"}},"limit":{"type":"integer","description":"limit given in reqeust. By default - 500","format":"int64","example":50},"pageNo":{"type":"integer","description":"Page Number given in request. By default - 1","format":"int32","example":3},"recordsCurrentPage":{"type":"integer","description":"Records present on the current page","format":"int64","example":20},"totalPages":{"type":"integer","description":"Total Pages calculates based on limit and totalRecords values","format":"int32","example":3},"totalRecords":{"type":"integer","description":"Total count of metrics records ignoring limit","format":"int32","example":120}}},"NetconfConfig":{"type":"object","properties":{"deviceConfig":{"type":"string","example":"ICA8bmF0aXZlIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLW5hdGl2ZSI+CiAgICAgICAgICAgICAgICA8c2VydmljZS1pbnNlcnRpb24+CiAgICAgICAgICAgICAgICAgICAgPGFwcG5hdi1jb250cm9sbGVyLWdyb3VwIHhtbG5zPSJodHRwOi8vY2lzY28uY29tL25zL3lhbmcvQ2lzY28tSU9TLVhFLXNlcnZpY2UtaW5zZXJ0aW9uIj4KICAgICAgICAgICAgICAgICAgICAgICAgPGdyb3VwLW5hbWU+QVBQUU9FLUFDRzwvZ3JvdXAtbmFtZT4KICAgICAgICAgICAgICAgICAgICAgICAgPGFwcHFvZS8+CiAgICAgICAgICAgICAgICAgICAgICAgIDxhcHBuYXYtY29udHJvbGxlcnM+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8YWRkcmVzcz4xOTIuMTY4LjAuMjwvYWRkcmVzcz4KICAgICAgICAgICAgICAgICAgICAgICAgPC9hcHBuYXYtY29udHJvbGxlcnM+CiAgICAgICAgICAgICAgICAgICAgPC9hcHBuYXYtY29udHJvbGxlci1ncm91cD4KICAgICAgICAgICAgICA8L3NlcnZpY2UtaW5zZXJ0aW9uPgogIDwvbmF0aXZlPg=="},"deviceId":{"type":"string","example":"C8K-8f8cc50c-b05b-4a60-956b-5bdd8e79e5c0"}}},"NetconfConfigHeader":{"type":"object","properties":{"generateOn":{"type":"integer","format":"int64","example":1649645769219}}},"NetworkAvailabilityResp":{"required":["health","jitter","latency","loss"],"type":"object","properties":{"availability":{"type":"number","example":0.9},"health":{"type":"string","example":"good","enum":["good","fair","poor"]},"jitter":{"type":"number","example":40},"latency":{"type":"number","example":500},"latitude":{"type":"string","example":"12.1114325"},"longitude":{"type":"string","example":"120.235674"},"loss":{"type":"number","example":1.2},"siteid":{"type":"string","example":"100"},"sitename":{"type":"string","example":"sjc"}}},"NetworkProtocol":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"DHCPPool":{"$ref":"#/components/schemas/DHCPPool"},"DNSSettings":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string"},"NTPSettings":{"maxItems":4,"minItems":1,"type":"array","items":{"type":"string"}},"NATRules":{"type":"array","items":{"$ref":"#/components/schemas/NATRule"}},"NTPInherit":{"type":"boolean"}}}]},"Node":{"required":["ip","password","username"],"type":"object","properties":{"ip":{"pattern":"^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"10.0.12.26"},"name":{"pattern":"^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-_]*[a-zA-Z0-9])?)?$","type":"string","example":"vm16"},"password":{"type":"string","example":"p@ssw0rd"},"serialno":{"type":"string"},"status":{"pattern":"^(UP|DOWN|PARTIAL|UNKNOWN)$","type":"string"},"username":{"type":"string","example":"admin"},"uuid":{"type":"string"}}},"NotificationsRuleData":{"type":"object","properties":{"@rid":{"type":"integer","format":"int64","example":1158},"accountDetails":{"type":"string","example":"cqx@cisco.com"},"alarmName":{"type":"string","example":"BFD_Node_Up"},"devicesAttached":{"type":"string","example":"1712133e-0246-4281-8152-3317b796d2bc"},"emailThreshold":{"type":"integer","format":"int64","example":5},"lastUpdated":{"type":"integer","format":"int64","example":1588177200725},"notificationRuleId":{"type":"string","example":"e947efc8-e86a-4eb4-b8ce-7ed0c2828f13"},"notificationRuleName":{"type":"string","example":"testwebhook"},"severity":{"type":"string","example":"Medium"},"updatedBy":{"type":"string","example":"admin"},"webhookPassword":{"type":"string","example":"$CRYPT$R21YRfP4HWOv+Z9nSi7zRw==$hEU/zplzA+IJlI/4LsNY/Q=="},"webhookUrl":{"type":"string","example":"https://localhost:8444"},"webhookUsername":{"type":"string","example":"admin"}}},"NotificationsRulesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationsRuleData"}}}},"NvaRulesListRequest":{"type":"object","properties":{"securityRulesList":{"type":"array","items":{"$ref":"#/components/schemas/NvaRulesListRequestSecurityRulesList"}}}},"NvaRulesListRequestSecurityRulesList":{"required":["destinationPortRange","protocol","sourceAddressPrefix"],"type":"object","properties":{"destinationPortRange":{"pattern":"^\\d+$","type":"string","example":"22"},"protocol":{"pattern":"^(TCP|UDP)$","type":"string","example":"TCP"},"sourceAddressPrefix":{"pattern":"^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$","type":"string","example":"192.168.1.1/32"}}},"NvaRulesResponse":{"type":"object","properties":{"accountId":{"type":"string","example":"112948124124"},"accountName":{"type":"string","example":"test_account_name"},"cloudType":{"type":"string","example":"AZURE"},"expirationTime":{"type":"string","example":"6/10/2022 6:12:36 PM UTC"},"nvaId":{"type":"string","example":"/subscriptions/112948124124/resourceGroups/test-resource-group/providers/Microsoft.Network/networkVirtualAppliances/CiscoSdwanV2-nva-399bdf13-65e9-4177-876b-d125bee704d6"},"resourceGroupName":{"type":"string","example":"test-resource-group"},"ruleName":{"type":"string","example":"test_rule"},"securityRulesList":{"$ref":"#/components/schemas/NvaRulesListRequest"}}},"NvaSkuListResponse":{"type":"object","properties":{"accountId":{"type":"string","example":"112948124124"},"accountName":{"type":"string","example":"test_account_name"},"cloudType":{"type":"string","example":"AZURE"},"nvaSkuId":{"type":"string","example":"ciscosdwan"},"nvaSkuName":{"type":"string","example":"ciscosdwan"},"scaleValueList":{"type":"array","items":{"$ref":"#/components/schemas/NvaSkuListResponseScaleValueList"}},"versionList":{"type":"array","items":{"type":"string"}}}},"NvaSkuListResponseScaleValueList":{"type":"object","properties":{"instanceCount":{"type":"integer","format":"int32"},"instanceType":{"type":"string"},"scaleUnit":{"type":"string"}}},"NvasResponse":{"type":"object","properties":{"nvaId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/networkVirtualAppliances/CiscoSdwanV2-nva-f383f40c-d07e-41be-bbc7-aa7abbfbf7fc"},"nvaName":{"type":"string","example":"CiscoSdwanV2-nva-f383f40c-d07e-41be-bbc7-aa7abbfbf7fc"},"source":{"type":"string","example":"vManage"},"uuids":{"type":"array","example":["C8K-2F69B355-2B3D-2801-EB48-F44789422299","C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9"],"items":{"type":"string","example":"[\"C8K-2F69B355-2B3D-2801-EB48-F44789422299\",\"C8K-10A9ACE8-2283-B45A-4E3A-23DFA39DBEF9\"]"}}}},"NwpiDSCPResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"DSCP for GET response","items":{"$ref":"#/components/schemas/NwpiDSCPResponsePayloadInner"}},"NwpiDSCPResponsePayloadInner":{"type":"object","properties":{"dscpName":{"type":"string"},"value":{"type":"integer","format":"int32"}},"description":"DSCP for GET response"},"NwpiDomainMonitor":{"type":"object","properties":{"clientIp":{"type":"string"},"deviceToDomainId":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/UuidToDomainId"}},"domainAppGrp":{"maxLength":200,"minLength":1,"type":"string"},"domainAppVis":{"maxLength":200,"minLength":1,"type":"string"},"domainList":{"type":"array","items":{"$ref":"#/components/schemas/DomainDetail"}},"traceId":{"type":"string"}}},"NwpiDomainMonitorStateRespPayload":{"type":"object","properties":{"device-list":{"type":"array","items":{"$ref":"#/components/schemas/NwpiDomainMonitorStateRespPayloadDevicelist"}},"entry_time":{"type":"string"},"message":{"type":"string"},"monitor-state":{"type":"string"},"trace-id":{"type":"integer","format":"int32"}},"description":"Nwpi get MonitorState response payload"},"NwpiDomainMonitorStateRespPayloadDevicelist":{"type":"object","properties":{"app-vis":{"type":"string"},"art-vis":{"type":"string"},"connectedVManages":{"type":"string"},"device-ip":{"type":"string"},"device-type":{"type":"string"},"dia-vis":{"type":"string"},"domain-mon":{"type":"string"},"domain_monitor_can_be_started":{"type":"string"},"dscp-is-valid":{"type":"string"},"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"expire-time":{"type":"integer","format":"int64"},"local-system-ip":{"type":"string"},"message":{"type":"string"},"parent-trace-id":{"type":"integer","format":"int32"},"qos-mon":{"type":"string"},"site-id":{"type":"string"},"source-site":{"type":"string"},"state":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"},"vpn-id":{"type":"string"}}},"NwpiMonitorReqPayload":{"type":"object","properties":{"clientIp":{"type":"string"},"deviceToDomainId":{"type":"array","items":{"$ref":"#/components/schemas/NwpiMonitorReqPayloadDeviceToDomainId"}},"domainAppGrp":{"type":"string"},"domainAppVis":{"type":"string"},"domainList":{"type":"array","items":{"$ref":"#/components/schemas/NwpiMonitorReqPayloadDomainList"}},"traceId":{"pattern":"^[1-9][0-9]{0,5}$","type":"string"}},"description":"Nwpi monitor payload schema"},"NwpiMonitorReqPayloadDeviceToDomainId":{"type":"object","properties":{"domain":{"type":"string"},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/NwpiMonitorReqPayloadMapping"}}}},"NwpiMonitorReqPayloadDomainList":{"type":"object","properties":{"domain":{"type":"string"},"resolvedIp":{"type":"array","items":{"type":"string"}}}},"NwpiMonitorReqPayloadMapping":{"type":"object","properties":{"domainId":{"type":"integer","format":"int32"},"uuid":{"type":"string"}}},"NwpiMonitorRespPayload":{"type":"object","properties":{"message":{"type":"string"},"monitor-state":{"type":"string"}},"description":"Nwpi monitor response payload schema"},"NwpiNbarAppGroupResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Nbar Application Group for GET response","items":{"$ref":"#/components/schemas/NwpiNbarAppGroupResponsePayloadInner"}},"NwpiNbarAppGroupResponsePayloadInner":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object"}},"name":{"type":"string"}},"description":"Nbar Application Group for GET response"},"NwpiPreloadRespPayload":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/NwpiPreloadRespPayloadDevices"}},"interfaces":{"type":"array","items":{"$ref":"#/components/schemas/NwpiPreloadRespPayloadInterfaces"}},"models":{"type":"array","items":{"$ref":"#/components/schemas/NwpiPreloadRespPayloadModels"}}},"description":"Nwpi preload response payload schema"},"NwpiPreloadRespPayloadDevices":{"type":"object","properties":{"device-model":{"type":"string"},"device-type":{"type":"string"},"deviceId":{"type":"string"},"host-name":{"type":"string"},"latitude":{"type":"string"},"layoutLevel":{"type":"integer","format":"int32"},"local-system-ip":{"type":"string"},"longitude":{"type":"string"},"site-id":{"type":"string"},"system-ip":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"}}},"NwpiPreloadRespPayloadInterfaces":{"type":"object","properties":{"ifname":{"type":"string"},"ip-address":{"type":"string"},"vdevice-host-name":{"type":"string"},"vdevice-name":{"type":"string"},"vpn-id":{"type":"string"}}},"NwpiPreloadRespPayloadModels":{"type":"object","properties":{"deviceClass":{"type":"string"},"name":{"type":"string"}}},"NwpiProtocolResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Protocol for GET response","items":{"$ref":"#/components/schemas/NwpiProtocolResponsePayloadInner"}},"NwpiProtocolResponsePayloadInner":{"type":"object","properties":{"protocolName":{"type":"string"},"value":{"type":"integer","format":"int32"}},"description":"Protocol for GET response"},"NwpiResponsePayload":{"type":"object","properties":{"status":{"type":"string"}},"description":"Nwpi common response payload schema"},"NwpiSettingDataPayload":{"type":"object","properties":{"peerSiteThreshold":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Nwpi setting data schema"},"NwpiTraceDeleteRespPayload":{"type":"object","properties":{"action":{"type":"string"},"trace-id":{"type":"string"}},"description":"Nwpi trace delete response schema"},"NwpiTraceHistoryRespPayload":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NwpiTraceHistoryRespPayloadData"},"entry_time":{"type":"integer","format":"int64"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Nwpi traceHistory response payload schema"},"NwpiTraceHistoryRespPayloadData":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/NwpiDomainMonitorStateRespPayloadDevicelist"}},"summary":{"$ref":"#/components/schemas/NwpiTraceHistoryRespPayloadDataSummary"}}},"NwpiTraceHistoryRespPayloadDataSummary":{"type":"object","properties":{"agg-client-prefix":{"type":"string"},"agg-src-sgt":{"type":"string"},"agg-svr-prefix":{"type":"string"},"agg-user-name":{"type":"string"},"app":{"type":"string"},"app-grp":{"type":"string"},"app-vis":{"type":"string"},"art-vis":{"type":"string"},"common_app":{"type":"string"},"device-ip":{"type":"string"},"devicesCheckInfo":{"type":"string"},"dia-vis":{"type":"string"},"domain-mon":{"type":"string"},"dscp":{"type":"string"},"dst-ip":{"type":"string"},"dst-pfx":{"type":"string"},"dst-pfx-len":{"type":"string"},"dst-port":{"type":"string"},"duration":{"type":"string"},"health-app-server-mem":{"type":"string"},"health-cpu-core":{"type":"string"},"health-cpu-load":{"type":"string"},"health-cpu-load-average":{"type":"string"},"health-mem-usage":{"type":"string"},"health-running-traces":{"type":"integer","format":"int32"},"health-server-ip":{"type":"string"},"hub-wan-vis":{"type":"string"},"local-drop-rate-threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos-mon":{"type":"string"},"sampling":{"type":"string"},"source-site":{"type":"string"},"source-site-vmanage-version":{"type":"string"},"spl-intvl":{"type":"string"},"src-if":{"type":"string"},"src-ip":{"type":"string"},"src-pfx":{"type":"string"},"src-pfx-len":{"type":"string"},"src-port":{"type":"string"},"state":{"type":"string"},"stop-time":{"type":"integer","format":"int32"},"taskId":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"trace-trigger-event":{"type":"string"},"trace_stop_type":{"type":"string"},"username":{"type":"string"},"vpn-id":{"type":"string"},"vpn-list":{"type":"string"},"wan-drop-rate-threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}}},"NwpiTraceStartReqPayload":{"type":"object","properties":{"app":{"type":"array","items":{"type":"string"}},"app-vis":{"type":"string"},"art-vis":{"type":"string"},"dia-vis":{"type":"string"},"dscp":{"type":"string"},"dst-pfx":{"type":"string"},"dst-port":{"type":"string"},"duration":{"type":"string"},"hub-wan-vis":{"type":"string"},"protocol":{"type":"string"},"sampling":{"type":"string"},"source-site":{"type":"string"},"spl-intvl":{"type":"string"},"src-if":{"type":"string"},"src-pfx":{"type":"string"},"src-port":{"type":"string"},"trace-name":{"type":"string"},"vpn-id":{"type":"string"}},"description":"Trace start payload schema"},"NwpiTraceStartRespPayload":{"type":"object","properties":{"action":{"type":"string"},"domain-mon":{"type":"boolean"},"entry_time":{"type":"integer","format":"int64"},"expire-time":{"type":"integer","format":"int64"},"local-drop-rate-threshold":{"type":"integer","format":"int32"},"qos-mon":{"type":"boolean"},"source-site":{"type":"string"},"state":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"traces":{"type":"array","items":{"$ref":"#/components/schemas/NwpiTraceStartRespPayloadTraces"}},"wan-drop-rate-threshold":{"type":"integer","format":"int32"}},"description":"Nwpi trace start response payload schema"},"NwpiTraceStartRespPayloadTraces":{"type":"object","properties":{"device-ip":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"local-system-ip":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"uuid":{"type":"string"}}},"NwpiTraceStopRespPayload":{"type":"object","properties":{"action":{"type":"string"},"domain-mon":{"type":"boolean"},"entry_time":{"type":"integer","format":"int64"},"message":{"type":"string"},"qos-mon":{"type":"boolean"},"state":{"type":"string"},"trace-id":{"type":"string"},"trace-name":{"type":"string"},"traces":{"type":"array","items":{"$ref":"#/components/schemas/NwpiTraceStopRespPayloadTraces"}}},"description":"Nwpi trace stoppayload schema"},"NwpiTraceStopRespPayloadTraces":{"type":"object","properties":{"action":{"type":"string"},"device-ip":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"local-system-ip":{"type":"string"},"message":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"uuid":{"type":"string"}}},"NwpiflowDetailRespPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Nwpi flowDetail payload schema","items":{"$ref":"#/components/schemas/NwpiflowDetailRespPayloadInner"}},"NwpiflowDetailRespPayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Nwpi flowDetail payload schema"},"NwpiflowMetricRespPayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Nwpi flowMetric payload schema","items":{"$ref":"#/components/schemas/NwpiflowMetricRespPayloadInner"}},"NwpiflowMetricRespPayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Nwpi flowMetric payload schema"},"NwpipacketRespPayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NwpipacketRespPayloadData1"}}},"description":"Nwpi trace packet payload schema"},"NwpipacketRespPayloadData":{"type":"object","properties":{"device_name":{"type":"string"},"device_version":{"type":"string"},"flow_id":{"type":"integer","format":"int32"},"packet":{"$ref":"#/components/schemas/NwpipacketRespPayloadDataPacket"},"packet_received_timestamp":{"type":"integer","format":"int64"},"system_ip":{"type":"string"},"trace_id":{"type":"integer","format":"int32"}}},"NwpipacketRespPayloadData1":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NwpipacketRespPayloadData"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}}},"NwpipacketRespPayloadDataPacket":{"type":"object","properties":{"app_awared":{"type":"boolean"},"event_name":{"type":"array","items":{"type":"string"}},"packet":{"$ref":"#/components/schemas/NwpipacketRespPayloadDataPacketPacket"},"packet_fwd_decision":{"type":"string"},"packet_id":{"type":"integer","format":"int32"},"parent_pkt_id":{"type":"integer","format":"int32"}}},"NwpipacketRespPayloadDataPacketPacket":{"type":"object","properties":{"egress_fia":{"type":"array","items":{"$ref":"#/components/schemas/NwpipacketRespPayloadDataPacketPacketEgressFia"}},"ingress_fia":{"type":"array","items":{"$ref":"#/components/schemas/NwpipacketRespPayloadDataPacketPacketEgressFia"}}}},"NwpipacketRespPayloadDataPacketPacketEgressFia":{"type":"object","properties":{"feature_detail":{"type":"string"},"feature_name":{"type":"string"},"fia_color":{"type":"string"},"policy_key":{"type":"string"}}},"NwpitraceFlowRespPayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadData1"}}},"description":"Nwpi traceFlow response payload schema"},"NwpitraceFlowRespPayloadData":{"type":"object","properties":{"app_group":{"type":"string"},"app_name":{"type":"string"},"appqoe_diverted":{"type":"boolean"},"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"big_drop":{"type":"boolean"},"big_wan_drop":{"type":"boolean"},"device_trace_id":{"type":"integer","format":"int32"},"domain_name":{"type":"string"},"domain_src":{"type":"string"},"downstream_device_list":{"type":"array","items":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataDownstreamDeviceList"}},"downstream_dscp":{"type":"string"},"downstream_hop_list":{"type":"array","items":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataDownstreamHopList"}},"dpi_policy_used":{"type":"boolean"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"dst_sgt":{"type":"string"},"fif_dpi_not_classified":{"type":"boolean"},"flow_fin":{"type":"boolean"},"flow_id":{"type":"integer","format":"int32"},"flow_key":{"type":"string"},"flow_moved":{"type":"boolean"},"flow_readout":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataFlowReadout"},"max_local_drop_rate":{"type":"integer","format":"int32"},"max_wan_drop_rate":{"type":"integer","format":"int32"},"nat_translated":{"type":"boolean"},"path_changed":{"type":"boolean"},"policy_bypassed":{"type":"boolean"},"protocol":{"type":"string"},"qos_congested":{"type":"boolean"},"received_timestamp":{"type":"integer","format":"int64"},"server_no_response":{"type":"boolean"},"sla_violated":{"type":"boolean"},"sla_violated_bfd":{"type":"boolean"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"src_sgt":{"type":"string"},"start_device":{"type":"string"},"start_timestamp":{"type":"integer","format":"int64"},"tcp_flow_reset":{"type":"boolean"},"test_id":{"type":"integer","format":"int32"},"timestamp":{"type":"integer","format":"int64"},"upstream_device_list":{"type":"array","items":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataUpstreamDeviceList"}},"upstream_dscp":{"type":"string"},"upstream_hop_list":{"type":"array","items":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataDownstreamHopList"}},"user_group":{"type":"string"},"user_name":{"type":"string"},"utd_diverted":{"type":"boolean"},"vpn_id":{"type":"string"},"wan_color_asym":{"type":"boolean"}}},"NwpitraceFlowRespPayloadData1":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadData"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}}},"NwpitraceFlowRespPayloadDataDownstreamDeviceList":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"down_fwd_decision":{"type":"string"},"egress_next_invalid":{"type":"boolean"},"localColor":{"type":"string"},"remoteColor":{"type":"string"},"up_fwd_decision":{"type":"string"}}},"NwpitraceFlowRespPayloadDataDownstreamHopList":{"type":"object","properties":{"appqoe_diverted":{"type":"boolean"},"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"big_drop":{"type":"boolean"},"big_wan_drop":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"},"fif_dpi_not_classified":{"type":"boolean"},"flow_id":{"type":"integer","format":"int32"},"his_q_d_avg_pkts":{"type":"integer","format":"int32"},"his_q_d_max_pkts":{"type":"integer","format":"int32"},"his_q_d_min_pkts":{"type":"integer","format":"int32"},"hop_index":{"type":"integer","format":"int32"},"jitter":{"type":"string"},"latency":{"type":"string"},"local_color":{"type":"string"},"local_drop_cause_num":{"type":"integer","format":"int32"},"local_drop_rate":{"type":"string"},"local_edge":{"type":"string"},"local_system_ip":{"type":"string"},"nat_translated":{"type":"boolean"},"path_changed":{"type":"boolean"},"policy_bypassed":{"type":"boolean"},"q_d_avg_pkts":{"type":"integer","format":"int32"},"q_d_max_pkts":{"type":"integer","format":"int32"},"q_d_min_pkts":{"type":"integer","format":"int32"},"q_id":{"type":"integer","format":"int32"},"q_lim_pkts":{"type":"integer","format":"int32"},"qos_congested":{"type":"boolean"},"remote_color":{"type":"string"},"remote_drop_cause_num":{"type":"integer","format":"int32"},"remote_drop_rate":{"type":"string"},"remote_edge":{"type":"string"},"remote_system_ip":{"type":"string"},"server_no_response":{"type":"boolean"},"sla_violated":{"type":"boolean"},"sla_violated_bfd":{"type":"boolean"},"tcp_flow_reset":{"type":"boolean"},"total_bytes":{"type":"string"},"total_packets":{"type":"string"},"utd_diverted":{"type":"boolean"},"wan_color_asym":{"type":"boolean"},"wan_drop_rate":{"type":"string"},"wan_drop_str":{"type":"string"}}},"NwpitraceFlowRespPayloadDataFlowReadout":{"type":"object","properties":{"application":{"type":"string"},"flowLastUpdateTime":{"type":"string"},"flowStartTime":{"type":"string"},"totalFlowNumCounted":{"type":"boolean"},"totalFlowNumLast15MinsCounted":{"type":"boolean"}}},"NwpitraceFlowRespPayloadDataUpActualPath":{"type":"object","properties":{"Interface":{"type":"string"},"Type":{"type":"string"}}},"NwpitraceFlowRespPayloadDataUpstreamDeviceList":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"down_actual_path":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataUpActualPath"},"down_fwd_decision":{"type":"string"},"egress_next_invalid":{"type":"boolean"},"ingress_pre_invalid":{"type":"boolean"},"localColor":{"type":"string"},"remoteColor":{"type":"string"},"up_actual_path":{"$ref":"#/components/schemas/NwpitraceFlowRespPayloadDataUpActualPath"},"up_fwd_decision":{"type":"string"}}},"OMP":{"type":"object","properties":{"advertisementInterval":{"type":"integer","format":"int32"},"advertisements":{"pattern":"(IPv4|BGP|OSPF|Connected|Static)","type":"string"},"ecmpLimit":{"type":"integer","format":"int32"},"eorTimer":{"type":"integer","format":"int32"},"gracefulRestart":{"type":"integer","format":"int32"},"holdTime":{"type":"integer","format":"int32"},"pathsAdvertisedPerPrefix":{"type":"integer","format":"int32"}}},"OnDemandQueueEntry":{"type":"object","properties":{"complete":{"type":"boolean"},"completionTime":{"type":"integer","format":"int64"},"creationTime":{"type":"integer","format":"int64"},"data_type":{"type":"string","enum":["DPI","ConnectionEvents"]},"device_id":{"type":"string"},"end_time":{"type":"integer","format":"int64"},"id":{"type":"string"},"startProcessingTime":{"type":"integer","format":"int64"},"start_time":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["QUEUED","IN_PROGRESS","COMPLETED","FAILED"]},"tenant_id":{"type":"string"},"time_period":{"type":"string","enum":["LAST_N_HOURS","CUSTOM"]},"value":{"type":"integer","format":"int32"}}},"OnDemandSchedule":{"required":["scheduleType"],"type":"object","description":"On-demand schedule","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"}]},"OneOfAlarmConsumedEventsItems":{"type":"object"},"OneTimeSchedule":{"required":["scheduleType","startTime"],"type":"object","description":"One time schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is yyyy-MM-dd HH:mm:ss,UTC timezone","example":"2022-07-01 14:30:00"}}}]},"OrgID":{"type":"object","properties":{"vipObjectType":{"type":"string","example":"object"},"vipType":{"type":"string","example":"constant"},"vipValue":{"type":"string","example":"980"},"vipVariableName":{"type":"string","example":"system_org_id"}},"description":"Org ID"},"PackagingDistribution":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PackagingDistributionData"}}},"PackagingDistributionData":{"type":"object","properties":{"availableCssm":{"type":"integer","format":"int32","example":1},"license":{"type":"string","example":"Routing DNA Advantage: Tier 0"},"usedCssm":{"type":"string","example":"33"},"usedVmanage":{"type":"integer","format":"int32","example":1}}},"PacketCaptureInfo":{"type":"object","properties":{"@rid":{"type":"integer","format":"int32","example":3765},"JSessionId":{"type":"string","example":"2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac"},"isNewSession":{"type":"boolean","example":true},"isOwner":{"type":"boolean","example":true},"renewalTime":{"type":"integer","format":"int64","example":1695089425303},"requestStatus":{"type":"string","enum":["START","STOP","IN_PROGRESS","NOT_STARTED"]},"sessionId":{"type":"string","format":"uuid","example":"a9fd18d5-0303-43d1-b821-2358992e0274"},"startTime":{"type":"integer","format":"int64","example":1695089425303},"status":{"type":"string","example":"success","enum":["success","failure"]},"statusMessage":{"type":"string","example":"ok"},"type":{"type":"string","example":"pcap"},"user":{"type":"string","example":"admin"},"userIp":{"type":"string","example":"10.0.1.1"},"uuid":{"type":"string","example":"C8K-86adc384-8408-4cec-acdb-8117c40a8a24"}}},"PageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"number of alarms to be fetched","format":"int64"},"endTime":{"type":"integer","description":"end time of alarms to be fetched","format":"int64"},"startTime":{"type":"integer","description":"start time of alarms to be fetched","format":"int64"}}},"PartnerDevice":{"type":"object","properties":{"chassis-serial-number":{"type":"string","example":"SSI130300YK"},"configuredAaaUser":{"type":"array","items":{"type":"string"}},"device-model":{"type":"string","example":"C8000v"},"device-os":{"type":"string","example":"next"},"device-type":{"type":"string","example":"vedge"},"deviceId":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"devicesAttached":{"type":"integer","format":"int32","example":0},"discoveredDeviceInterfaces":{"type":"array","items":{"type":"string"}},"host-name":{"type":"string","example":"vm5"},"loopback":{"type":"array","items":{"$ref":"#/components/schemas/Loopback"}},"personality":{"type":"string","example":"vedge"},"platform":{"type":"string","example":"x86_64"},"reachability":{"type":"string","example":"reachable","enum":["reachable","unreachable"]},"registrationDate":{"type":"integer","format":"int64","example":1590186370340},"serialNumber":{"type":"string","example":"12345712"},"site-id":{"type":"string","example":"500"},"state":{"type":"string","example":"green"},"status":{"type":"string","example":"normal","enum":["error","warning","normal","new"]},"system-ip":{"type":"string","example":"172.16.255.15"},"templateStatus":{"type":"string","example":"Success"},"uuid":{"type":"string","example":"C8K-cfb84064-12e9-4f7c-b9d9-bf78ce4dfb5f"},"validity":{"type":"string","example":"valid","enum":["invalid","staging","valid","prestaging"]},"version":{"type":"string","example":"17.06.01.0.1422"},"wanInterfaces":{"type":"array","items":{"type":"string"}}}},"PartnerDevicesRes":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/PartnerDevice"}}}},"PartnerListRes":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/PartnerRes"}},"PartnerRes":{"type":"object","properties":{"description":{"type":"string","example":"dnac-test"},"devicesAttached":{"type":"integer","format":"int32","example":0},"id":{"type":"string","example":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"},"name":{"type":"string","example":"DNAC-test"},"owner":{"type":"string","example":"admin"},"partnerId":{"type":"string","example":"dnac-test"},"registrationDate":{"type":"integer","format":"int64","example":1632900123277},"type":{"type":"string","example":"dnac","enum":["aci","dnac","wcm","mdp"]}}},"PartnerSite":{"type":"object","properties":{"partnerId":{"type":"string","example":"dnac-test"},"sites":{"type":"array","items":{"type":"string"}}}},"PayloadItems":{"required":["_rid","business_relevance","common_family","common_family_display","common_name","common_name_display","nbar_family","nbar_name","qosmos_family","qosmos_name","traffic_class","uuid"],"type":"object","properties":{"_rid":{"type":"string","example":"0:PolicyAppListsNode:1675729045113:1700"},"business_relevance":{"type":"string","example":"business-irrelevant"},"common_family":{"type":"string","example":"web"},"common_family_display":{"type":"string","example":"Web"},"common_name":{"type":"string","example":"zulily"},"common_name_display":{"type":"string","example":"Zulily"},"nbar_family":{"type":"string","example":"web"},"nbar_name":{"type":"string","example":"zulily"},"qosmos_family":{"type":"string","example":"web"},"qosmos_name":{"type":"string","example":"zulily"},"traffic_class":{"type":"string","example":"transactional-data"},"uuid":{"type":"string","format":"uuid","example":"345fa8c9-6115-434b-b1f7-2c1d97f09f91"}}},"PingRequest":{"type":"object","properties":{"count":{"type":"string","example":"5"},"host":{"type":"string","example":"10.1.12.16"},"rapid":{"type":"string","example":"true"},"size":{"type":"string","example":"128"},"source":{"type":"string","example":"10.1.12.15"},"vpn":{"type":"string","example":"0"}}},"PingResponse":{"type":"object","properties":{"avgRoundTrip":{"type":"number","example":0.389},"lossPercentage":{"type":"number","example":0},"maxRoundTrip":{"type":"number","example":0.534},"minRoundTrip":{"type":"number","example":0.226},"packetsReceived":{"type":"number","example":5},"packetsTransmitted":{"type":"number","example":5},"rawOutput":{"type":"array","items":{"type":"string"}}}},"PolicyGroup":{"required":["name","solution","state","version"],"type":"object","properties":{"copyInfo":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"origin":{"type":"string"},"originInfo":{"type":"object","additionalProperties":{"type":"string"}},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"sdwan","enum":["mobility","sdwan","sd-routing","common","nfvirtual","service-insertion","cellulargateway"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"version":{"type":"integer","description":" Group Version Flag","format":"int64"}}},"PolicyRule":{"type":"object","properties":{"action":{"pattern":"(drop|pass)","type":"string"},"destIp":{"type":"string"},"destPort":{"type":"integer","format":"int32"},"protocolType":{"type":"array","items":{"type":"string"}},"sourceIp":{"type":"string"},"sourcePort":{"type":"integer","format":"int32"}}},"PostAccounts":{"required":["accountName","azureCredentials","cloudType","gcpCredentials"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"maxLength":255,"minLength":1,"type":"string"},"awsIamCredentials":{"$ref":"#/components/schemas/AwsIamCredentials"},"awsKeyCredentials":{"$ref":"#/components/schemas/AwsKeyCredentials"},"azureCredentials":{"$ref":"#/components/schemas/AzureCredentials"},"cloudGatewayEnabled":{"pattern":"^(true|false)$","type":"string"},"cloudType":{"type":"string"},"description":{"maxLength":1024,"minLength":0,"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"gcpBillingId":{"pattern":"^[a-zA-Z0-9_./\\-\\s]+$","type":"string"},"gcpCredentials":{"$ref":"#/components/schemas/GcpCredentials"},"kubernetesDiscoveryEnabled":{"pattern":"^(true|false)$","type":"string"},"serviceDiscoveryEnabled":{"pattern":"^(true|false)$","type":"string"}}},"PostAccountsResponse":{"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"type":"string"},"cloudType":{"type":"string"},"regionList":{"type":"string"}}},"PostCgwConfigGroupResponse":{"type":"object","properties":{"createdBy":{"type":"string"},"createdOn":{"type":"number"},"description":{"type":"string"},"devices":{"type":"array","items":{"type":"string"}},"fullConfigCli":{"type":"boolean"},"id":{"type":"string"},"iosConfigCli":{"type":"boolean"},"lastUpdatedBy":{"type":"string"},"lastUpdatedOn":{"type":"number"},"name":{"type":"string"},"numberOfDevices":{"type":"integer","format":"int32"},"numberOfDevicesUpToDate":{"type":"integer","format":"int32"},"origin":{"type":"string"},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/PostCgwConfigGroupResponseProfiles"}},"solution":{"type":"string"},"source":{"type":"string"},"state":{"type":"string"},"topology":{"type":"string"},"version":{"type":"integer","format":"int32"}}},"PostCgwConfigGroupResponseProfiles":{"type":"object","properties":{"createdBy":{"type":"string"},"createdOn":{"type":"number"},"description":{"type":"string"},"id":{"type":"string"},"lastUpdatedBy":{"type":"string"},"lastUpdatedOn":{"type":"number"},"name":{"type":"string"},"profileParcelCount":{"type":"string"},"solution":{"type":"string"},"type":{"type":"string"}}},"PostMapRequest":{"required":["cloudType"],"type":"object","properties":{"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string"},"connMatrix":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestConnMatrix"}}}},"PostMapRequestConnMatrix":{"required":["conn","destId","destType","srcId","srcType"],"type":"object","properties":{"conn":{"type":"string"},"destId":{"type":"string"},"destType":{"type":"string"},"mapped":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestMapped"}},"outstandingMapping":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestMapped"}},"srcId":{"type":"string"},"srcType":{"type":"string"},"unmapped":{"type":"array","items":{"$ref":"#/components/schemas/PostMapRequestMapped"}}}},"PostMapRequestMapped":{"type":"object","properties":{"cgwAttachment":{"type":"string"},"cloudType":{"type":"string"},"destId":{"type":"string"},"destRegion":{"type":"string"},"destTag":{"type":"string"},"destType":{"type":"string"},"region":{"type":"string"},"sourceRegion":{"type":"string"},"sourceTag":{"type":"string"},"srcId":{"type":"string"},"srcType":{"type":"string"},"tunnelId":{"type":"string"}}},"Prefixinfo":{"type":"object","properties":{"owned":{"type":"array","example":["23.89.48.0/20","64.68.96.0/24","64.68.103.0/24"],"items":{"type":"string","example":"[\"23.89.48.0/20\",\"64.68.96.0/24\",\"64.68.103.0/24\"]"}}}},"ProcessFirmwareRemoteImageReq":{"type":"object","properties":{"filePath":{"type":"string","example":"/home/admin/"},"remoteServerId":{"type":"string","example":"f7ae1f4b-9900-424f-92ca-22d2231f55dc"}}},"ProcessGetFirmwareRemoteImageReq":{"type":"object","properties":{"description":{"type":"string","example":"Firmware Image Path"},"filePath":{"type":"string","example":"/home/admin/"},"remoteServerId":{"type":"string","example":"f7ae1f4b-9900-424f-92ca-22d2231f55dc"},"versionId":{"type":"string","example":"9917f2ad-c152-406b-87cc-a3b251d0e1a8"}}},"ProcessLxcActivate":{"type":"object","properties":{"action":{"type":"string","enum":["lxc_activate"]},"deviceType":{"type":"string","enum":["vedge","vmanage","vbond","controller"]},"devices":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLxcActivateDevices"}},"input":{"$ref":"#/components/schemas/ProcessLxcActivateInput"}}},"ProcessLxcActivateDevices":{"type":"object","properties":{"deviceIP":{"$ref":"#/components/schemas/DeviceIP"},"deviceId":{"$ref":"#/components/schemas/DeviceUuid"},"installImages":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLxcActivateInstallImages"}},"vEdgeVPN":{"type":"integer","format":"int32","example":0},"versionType":{"type":"string","example":"vmanage"}}},"ProcessLxcActivateInput":{"type":"object","properties":{"vEdgeVPN":{"type":"integer","format":"int32","example":0},"versionType":{"type":"string","example":"vmanage"}}},"ProcessLxcActivateInstallImages":{"type":"object","properties":{"networkFunctionType":{"type":"string","example":"app-hosting"},"remoteServerId":{"type":"string","example":"b07865e0-29c4-4e46-b1ab-90e7a268eae"},"versionName":{"type":"string","example":"1.13.6_SV3.1.55.0_XEmain"},"versionTypeName":{"type":"string","example":"UTD-Snort-Feature"}}},"ProcessLxcDelete":{"type":"object","properties":{"action":{"type":"string","enum":["lxc_delete"]},"deviceType":{"type":"string","enum":["vedge","vmanage","vbond","controller"]},"devices":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLxcDeleteDevices"}}}},"ProcessLxcDeleteDevices":{"type":"object","properties":{"deviceIP":{"$ref":"#/components/schemas/DeviceIP"},"deviceId":{"$ref":"#/components/schemas/DeviceUuid"},"installImages":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLxcActivateInstallImages"}}}},"ProcessLxcUpgrade":{"type":"object","properties":{"action":{"type":"string","enum":["lxc_upgrade"]},"deviceType":{"type":"string","enum":["vedge","vmanage","vbond","controller"]},"devices":{"type":"array","items":{"$ref":"#/components/schemas/ProcessLxcDeleteDevices"}},"input":{"$ref":"#/components/schemas/ProcessLxcActivateInput"}}},"ProcessResponse":{"type":"object","properties":{"id":{"type":"string","description":"Procees Id of the task","example":"51d0a0e4-983a-471c-9abb-724d58144884"}}},"ProfileParcel":{"required":["name","type"],"type":"object","properties":{"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Profile Parcel.","example":"Wifi 7 profile Parcel"},"id":{"type":"string","description":"System generated unique identifier of the Profile Parcel in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Profile Parcel. Must be unique.","example":"Wifi profile Parcel"},"type":{"type":"string","description":"type","example":"wifi","enum":["cellular","wifi","ethernet","globalSettings","networkProtocol","securityPolicy"]},"variables":{"type":"array","items":{"$ref":"#/components/schemas/Variable"}}},"discriminator":{"propertyName":"type"}},"ProtocolPackUpgradeRequest":{"type":"object","properties":{"deviceSelectionType":{"type":"string","enum":["entire-network","selected-devices"]},"devices":{"type":"array","items":{"type":"string"}},"executionType":{"type":"string","enum":["now","later"]},"protocolPackType":{"type":"string","enum":["selected-protocol-pack","default-protocol-pack","built-in-protocol-pack"]},"protocolPacks":{"type":"array","items":{"type":"string"}},"scheduleTime":{"type":"integer","format":"int64"}}},"ProtocolPackUploadRequest":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}},"ProviderAccountDetails":{"required":["accountId","accountUserName","apiKey","carrierName","isDefault"],"type":"object","properties":{"acceptTermsAndConditions":{"type":"boolean","description":"Boolean value which indicates if the account user accepts account provider's terms and conditions if they exist."},"accountData":{"$ref":"#/components/schemas/AccountData"},"accountId":{"type":"string","description":" ID of the account associated with user using provider service.","example":"100025578"},"accountUserName":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the user registered to the service.","example":"JaneDoe"},"apiKey":{"maxLength":2147483647,"minLength":1,"type":"string","description":"API key for the provider service.","example":"1d6fa2f9-5a7d-4af8-8ab5-4056f631"},"carrierName":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Name of the service provider.","example":"Singtel"},"isDefault":{"type":"boolean","description":"Boolean value which indicates whether the provider is the default provider ."}}},"ProviderAccountDetailsList":{"type":"object","properties":{"providerAccountDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/ProviderAccountDetails"}}}},"ProviderInfo":{"type":"object","properties":{"cmpType":{"type":"string"},"cmpUrl":{"type":"string"},"contactInfoLine1":{"type":"string"},"contactInfoLine2":{"type":"string"},"contactInfoLine3":{"type":"string"},"countryCode":{"type":"string"},"operatorLogoUrl":{"type":"string"},"operatorName":{"type":"string"},"termsAndConditions":{"type":"string"}}},"PublicInternetTimer":{"type":"object","properties":{"dscp":{"type":"integer","format":"int32"},"helloInterval":{"type":"integer","format":"int32"},"multiplier":{"type":"integer","format":"int32"},"pathMtu":{"type":"string"}}},"PurgeFrequency":{"type":"object","properties":{"activeTime":{"type":"string","example":"60000"},"interval":{"type":"string","example":"60000"}}},"PushCgwConfig":{"required":["cloudGatewayName","cloudType"],"type":"object","properties":{"cloudGatewayName":{"pattern":"^[\\w.-]{1,128}$","type":"string","example":"cgw-test"},"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string","example":"GCP"}}},"PutAccounts":{"required":["accountId","accountName","cloudType"],"type":"object","properties":{"accountId":{"type":"string"},"accountName":{"maxLength":255,"minLength":1,"type":"string"},"cloudGatewayEnabled":{"pattern":"^(true|false)$","type":"string"},"cloudType":{"type":"string"},"description":{"maxLength":1024,"minLength":0,"pattern":"^[a-zA-Z0-9_./\\-\\s]*$","type":"string"},"gcpBillingId":{"type":"string"},"kubernetesDiscoveryEnabled":{"pattern":"^(true|false)$","type":"string"},"serviceDiscoveryEnabled":{"pattern":"^(true|false)$","type":"string"}}},"PutProperties":{"type":"object","properties":{"discoveryStatus":{"type":"boolean","example":true}}},"PxGridInfo":{"required":["pxGridPassword","pxGridServerIp","pxGridUserName","status"],"type":"object","properties":{"AccessSecret":{"type":"string","example":"aB8rj1m1lp"},"description":{"type":"string","example":"pxgrid infor"},"deviceType":{"type":"string","example":"vsmart"},"nodeName":{"type":"string","example":"~ise-admin-ise-1"},"pxGridHostName":{"type":"string","example":"ISE-1.rtpaaa.net"},"pxGridPassword":{"type":"string","example":"NJkl00jklkJk"},"pxGridServerIp":{"type":"string","example":"172.27.16.141"},"pxGridUserName":{"type":"string","example":"testName"},"restBaseURL":{"type":"string","example":"https://ISE-1.rtpaaa.net:8910/pxgrid/ise/config/trustsec"},"status":{"type":"string","example":"created"}},"description":"pxgrid information for making pxgrid api calls"},"QoSAggResp":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":5},"entry_time":{"type":"string","example":"1674813600000"},"jitter":{"type":"integer","format":"int32","example":0},"latency":{"type":"integer","format":"int32","example":0},"local_color":{"type":"string","example":"3g"},"loss_percentage":{"type":"integer","format":"int32","example":0}}},"QoSQueryFieldsResp":{"type":"object","properties":{"dataType":{"type":"string","example":"date"},"fieldData":{"$ref":"#/components/schemas/QoSQueryFieldsRespFieldData"},"isRequired":{"type":"boolean","example":true},"name":{"type":"string","example":"Event Time"},"options":{"type":"array","items":{"$ref":"#/components/schemas/QueryFieldsOption"}},"property":{"type":"string","example":"entry_time"}}},"QoSQueryFieldsRespFieldData":{"type":"object","properties":{"type":{"type":"string","example":"dateList"}}},"QoSResp":{"type":"object","properties":{"device_model":{"type":"string"},"drop_in_bytes":{"type":"number"},"drop_in_kbps":{"type":"integer","format":"int32"},"drop_in_pkts":{"type":"integer","format":"int32"},"drop_in_pps":{"type":"integer","format":"int64"},"entry_time":{"type":"string"},"host_name":{"type":"string"},"id":{"type":"string"},"interface":{"type":"string"},"queue_name":{"type":"string"},"queued_bytes":{"type":"number"},"queued_bytes_in_kbps":{"type":"number"},"queued_pkts":{"type":"number"},"red_drop_bytes":{"type":"number"},"red_drop_pkts":{"type":"number"},"statcycletime":{"type":"string"},"tail_drop_bytes":{"type":"integer","format":"int64"},"tail_drop_pkts":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"time_interval":{"type":"integer","format":"int32"},"tx_bytes":{"type":"number"},"tx_bytes_in_kbps":{"type":"integer","format":"int64"},"tx_bytes_in_pps":{"type":"integer","format":"int64"},"tx_pkts":{"type":"number"},"vdevice_name":{"type":"string"},"vip_idx":{"type":"string"},"vip_time":{"type":"string"},"vmanage_system_ip":{"type":"string"}},"description":"QOS specific response"},"QoSRespWithPageInfo":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QoSResp"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}},"description":"QoS response with page info"},"QueryFieldsOption":{"type":"object","properties":{"enabledDateFields":{"type":"boolean","example":false},"key":{"type":"string","example":"last_3_hours"},"number":{"type":"string","example":"1"},"value":{"type":"string","example":"last 1 hour"}}},"QueryFieldsResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Nwpi Query fields","items":{"$ref":"#/components/schemas/QueryFieldsResponsePayloadInner"}},"QueryFieldsResponsePayloadInner":{"type":"object","properties":{"dataType":{"type":"string"},"isRequired":{"type":"boolean"},"multiSelect":{"type":"boolean"},"name":{"type":"string"},"property":{"type":"string"},"validation":{"type":"object"}},"description":"Nwpi Query fields"},"QueryWithRule":{"type":"object","properties":{"condition":{"type":"string","example":"AND"},"rules":{"$ref":"#/components/schemas/RuleTypes"}}},"QueueEntries":{"type":"object","properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/OnDemandQueueEntry"}}}},"QueueProperties":{"type":"object","properties":{"current_size":{"type":"integer","format":"int32"},"max_size":{"type":"integer","format":"int32"},"tenant_current_size":{"type":"integer","format":"int32"},"tenant_max_size":{"type":"integer","format":"int32"}}},"RadioBandSetting_2_4G":{"type":"object","properties":{"band":{"pattern":"(RADIO_2_DOT_4_GHZ)","type":"string"},"channel":{"pattern":"(auto|1|2|3|4|5|6|7|8|9|10|11)","type":"string"},"channelWidth":{"pattern":"(RADIO_CHANNEL_WIDTH_20_MHZ)","type":"string"},"transmitPower":{"pattern":"(auto|1|2|3|4|5|6|7)","type":"string"}}},"RadioBandSetting_5G":{"type":"object","properties":{"band":{"pattern":"(RADIO_5_GHZ)","type":"string"},"channel":{"pattern":"(auto|36|40|44|48|52|56|60|64|100|104|108|112|116|120|124|128|132|136|140|144|149|153|157|161|165)","type":"string"},"channelWidth":{"pattern":"(RADIO_CHANNEL_WIDTH_20_MHZ|RADIO_CHANNEL_WIDTH_40_MHZ|RADIO_CHANNEL_WIDTH_80_MHZ)","type":"string"},"transmitPower":{"pattern":"(auto|1|2|3|4|5|6|7)","type":"string"}}},"Radius":{"type":"object","properties":{"retransmit":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"},"server":{"type":"array","items":{"$ref":"#/components/schemas/RadiusServer"}},"timeout":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}}},"RadiusServer":{"required":["host","port","secret"],"type":"object","properties":{"host":{"pattern":"(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?","type":"string"},"port":{"minimum":0,"type":"integer","format":"int32"},"secret":{"type":"string"}}},"RatePlan":{"required":["name","type"],"type":"object","properties":{"dataUsage":{"$ref":"#/components/schemas/DataUsage"},"name":{"type":"string","description":"Name of the rate plan.","example":"vm fixed pool rp"},"type":{"type":"string","description":"Rate plan type.","example":"Monthly - Pooled Subscriber"}},"description":"List of rate plans.","example":"Refer to RatePlan"},"RatePlansResponse":{"required":["lastPage","pageNumber","ratePlans"],"type":"object","properties":{"lastPage":{"type":"boolean","description":"Indicator whether the payload is the last payload.","example":true},"pageNumber":{"type":"integer","description":"Page Number.","format":"int32","example":1},"ratePlans":{"type":"array","description":"List of rate plans.","example":"Refer to RatePlan","items":{"$ref":"#/components/schemas/RatePlan"}}}},"RecommendationsResponse":{"required":["recommendations"],"type":"object","properties":{"recommendations":{"type":"array","example":[{"siteName":"SITE_400","siteId":"400","count":2},{"siteName":"SITE_500","siteId":"500","count":6}],"items":{"$ref":"#/components/schemas/RecommendationsResponseRecommendations"}},"totalRecommendationCount":{"type":"integer","format":"int32","example":8}}},"RecommendationsResponseRecommendations":{"type":"object","properties":{"count":{"type":"integer","format":"int32","example":6},"siteId":{"type":"string","example":"500"},"siteName":{"type":"string","example":"SITE_500"}},"example":[{"siteName":"SITE_400","siteId":"400","count":2},{"siteName":"SITE_500","siteId":"500","count":6}]},"RedirectCodeResponse":{"type":"object","properties":{"message":{"type":"string","example":"Redirect success! Please close this window"},"type":{"type":"string","example":"ok"}}},"Reference":{"type":"object","properties":{"id":{"type":"string","example":"0836d356-b89a-4fb9-abbc-1bb14d270ac8"},"type":{"type":"string","example":"zoneBasedFW"}},"description":"single policy where list is referenced"},"ReferencedList":{"type":"object","properties":{"description":{"type":"string","example":"test"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/Entry"}},"infoTag":{"type":"string"},"isActivatedByVsmart":{"type":"boolean","example":false},"lastUpdated":{"type":"integer","format":"int32","example":1644359006986},"listId":{"type":"string","format":"uuid","example":"851cb243-d0da-4d7f-bdf9-124d979eadb9"},"name":{"type":"string","example":"universal"},"owner":{"type":"string","example":"admin"},"readOnly":{"type":"boolean","example":false},"referenceCount":{"type":"integer","format":"int32","example":1},"references":{"type":"array","items":{"$ref":"#/components/schemas/Reference"}},"type":{"type":"string","example":"identity"},"version":{"type":"string","example":"0"}},"description":"A single list and where it is referenced"},"RegionListReadOnly":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"List of regions","items":{"type":"string","description":"List of regions"}},"RegionPrefixinfo":{"type":"object","properties":{"prefixes":{"$ref":"#/components/schemas/Prefixinfo"},"region":{"$ref":"#/components/schemas/Regioninfo"}}},"Regioninfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1},"name":{"type":"string","example":"us-west-1"},"responder_fqdn":{"type":"string","example":"pinger.us-west-1.infnet.webex.com"}}},"RegisterPartnerRequest":{"type":"object","properties":{"description":{"type":"string","example":"dnac-test"},"name":{"type":"string","example":"DNAC-test"},"partnerId":{"type":"string","example":"dnac-test"}}},"RegisterPartnerRes":{"type":"object","properties":{"id":{"type":"string","example":"f54a0f0e-734b-4c31-a539-9dc5e0fd67a5"}}},"ReleaseLicenses":{"type":"object","properties":{"uuids":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"ReleaseLicensesRequest":{"type":"object","properties":{"devices":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"ReoccurDailySchedule":{"required":["scheduleType","startTime"],"type":"object","description":"Daily schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is HH:mm:ss"}}}]},"ReoccurMonthlySchedule":{"required":["scheduleType","startTime"],"type":"object","description":"Monthly schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is (yyyy-MM-dd HH:mm:ss), time zone is UTC","example":"2022-07-01 20:30:10"}}}]},"ReoccurWeeklySchedule":{"required":["dayOfWeek","scheduleType","startTime"],"type":"object","description":"Weekly schedule time config","allOf":[{"$ref":"#/components/schemas/ScheduleConfig"},{"type":"object","properties":{"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is HH:mm:ss","example":"20:30:10"},"dayOfWeek":{"maximum":7,"minimum":1,"type":"integer","description":"The day number of a week, mapping is as 1 - Sun, 2 - Mon, 3 - Tus, 4 - Wed, 5 - Thu, 6 - Fri, 7 - Sat","format":"int32","example":1}}}]},"ReportBusinessHours":{"required":["endTime","startTime"],"type":"object","properties":{"endTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string"},"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string"}},"description":"Report business hours for data generating"},"ReportInfo":{"required":["activeStatus","createdBy","hasTask","lastUpdateTime","nextRunTime","onVmanage","reportConfig","reportId","reportStatus"],"type":"object","properties":{"activeStatus":{"type":"string","description":"Report active status(active,cancelled)","example":"active","enum":["active","cancelled"]},"createdBy":{"maxLength":64,"minLength":0,"type":"string","description":"user name for who created the report template.","example":"admin"},"debugInfo":{"type":"string"},"fileType":{"type":"string","enum":["pdf","csv"]},"hasTask":{"type":"boolean","description":"If the report template has running task records or not","example":true},"lastUpdateTime":{"type":"integer","description":"Report template last update timestamp","format":"int64","example":1655968207288},"needRunImmediately":{"type":"boolean"},"nextRunTime":{"type":"integer","description":"Report next running timestamp","format":"int64","example":1655991420000},"onVmanage":{"type":"string","description":"vManage which scheduled report generating tasks","example":"10.1.1.100"},"reportConfig":{"$ref":"#/components/schemas/ExecutiveSummaryReport"},"reportId":{"type":"string","description":"The report UUID for report template","format":"uuid","example":"50671437-c88e-4514-aafa-103e58c4d9cc"},"reportStatus":{"type":"string","description":"Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))","example":"in_progress","enum":["not_scheduled","scheduled","in_progress","completed","failed"]},"taskNum":{"type":"integer","format":"int64"},"templateType":{"type":"string","enum":["executive_summary","site_availability","link_availability","link_utilization","link_sla","app_usage","ips_events_collected","firewall_enforcement","malware_files_collected","internet_browsing"]}},"description":"Report Template detail info"},"ReportSummaryInfo":{"required":["businessHours","fileType","hasTask","nextRunTime","onVmanage","reportId","reportName","reportStatus","schedule","taskNum","templateType","timeFrame"],"type":"object","properties":{"businessHours":{"type":"string"},"emailRecipient":{"type":"array","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"],"items":{"type":"string","description":"Email address list to receive the report files","example":"[\"alice@cisco.com\",\"bob@google.com\"]"}},"fileType":{"type":"string"},"hasTask":{"type":"boolean","description":"If the report template has running task records or not","example":true},"nextRunTime":{"type":"integer","description":"Report next running timestamp","format":"int64","example":1655991420000},"onVmanage":{"type":"string","description":"vManage which scheduled report generating tasks","example":"10.1.1.100"},"reportId":{"type":"string","description":"The report UUID for report template","format":"uuid","example":"50671437-c88e-4514-aafa-103e58c4d9cc"},"reportName":{"type":"string","description":"The report template name","example":"Daily-report"},"reportStatus":{"type":"string","description":"Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))","example":"in_progress","enum":["not_scheduled","scheduled","in_progress","completed","failed"]},"schedule":{"type":"string","description":"Report schedule information","example":"Daily"},"taskNum":{"type":"integer","description":"The number of scheduled tasks for report template","format":"int64","example":10},"templateType":{"type":"string"},"timeFrame":{"type":"string","description":"Report time frame(7 Days/30 Days)","example":"7"}},"description":"Report summary information"},"ReportSummaryResponse":{"required":["reports"],"type":"object","properties":{"header":{"type":"object","additionalProperties":{"type":"object"}},"reports":{"type":"array","description":"Report List","items":{"$ref":"#/components/schemas/ReportSummaryInfo"}}},"description":"Query all reports summary information response"},"ReportTaskProcessStepInfo":{"required":["fileGenerated","reportDataQuery"],"type":"object","properties":{"emailSent":{"type":"boolean","description":"Email sent or not, if sending report via email is enabled","example":true},"fileGenerated":{"type":"boolean","description":"Report file is generated or not","example":true},"fileReplicated":{"type":"boolean","description":"Report file is all replicated or not when vManage is a cluster deployment","example":true},"reportDataQuery":{"type":"boolean","description":"Report data query success or not","example":true}},"description":"The detail status for each step of report generating task"},"ReportTaskQueryResponse":{"required":["taskList"],"type":"object","properties":{"header":{"type":"object","additionalProperties":{"type":"object"}},"taskList":{"type":"array","description":"Report Task list for specific report ID","items":{"$ref":"#/components/schemas/ReportTaskUIInfo"}}},"description":"Report task query response"},"ReportTaskUIInfo":{"required":["reportId","reportName","schedule","startTime","taskId","taskStatus","taskStepDetail","timeFrame"],"type":"object","properties":{"emailRecipient":{"type":"array","description":"Email address to receive the report files","example":["alice@cisco.com"],"items":{"type":"string","description":"Email address to receive the report files","example":"[\"alice@cisco.com\"]"}},"endTime":{"type":"integer","description":"Report task end timestamp","format":"int64","example":1656677563859},"fileType":{"type":"string","description":"Report file type","example":"pdf"},"followerVmanages":{"type":"array","description":"In Cluster deployment, the follower vManage IP address which needs to replicate the report file from source vManage which generated the report file.","example":["10.0.105.38","10.0.105.39"],"items":{"type":"string","description":"In Cluster deployment, the follower vManage IP address which needs to replicate the report file from source vManage which generated the report file.","example":"[\"10.0.105.38\",\"10.0.105.39\"]"}},"onVmanage":{"type":"string","description":"IP address of the source vManage which is scheduled to generate report file. Default value is \"localhost\" for single node vManage deployment.","example":"10.0.105.32"},"reportDownloadUrl":{"type":"string","description":"Report file download URL","example":"/reports/6f4464a5-f656-4407-acac-4c273e143a0a/tasks/c3855560-462b-46d6-8c2e-82cc9cfc105a/download"},"reportId":{"type":"string","description":"Report Template UUID","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66af26"},"reportName":{"type":"string","description":"Report name for task","example":"SJC site summary report-20220916-123123"},"schedule":{"type":"string","description":"Report schedule information","example":"Daily"},"startTime":{"type":"integer","description":"Report task start timestamp","format":"int64","example":1656677463859},"taskId":{"type":"string","description":"Task UUID","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"taskStatus":{"type":"string","description":"Report Task status","example":"in_progress","enum":["failure","in_progress","success"]},"taskStepDetail":{"$ref":"#/components/schemas/ReportTaskProcessStepInfo"},"timeFrame":{"type":"string","description":"Report time frame (7 Days or 30 Days)","example":"7"}},"description":"Report Task list for specific report ID"},"ResetInterfaceReq":{"type":"object","properties":{"ifname":{"type":"string","example":"GigabitEthernet1"},"vpnId":{"type":"string","example":"512"}}},"ResetVedgeCloud":{"type":"object","properties":{"id":{"type":"string","example":"36023ff2-42e9-4074-88d9-75bb995b1411"}}},"ResourceGroupsResponse":{"type":"object","properties":{"resourceGroupId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group"},"source":{"type":"string","example":"azureStored"}}},"RoutingDetailResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Routing details info schema for GET response","items":{"$ref":"#/components/schemas/RoutingDetailResponsePayloadInner"}},"RoutingDetailResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"entry_time":{"type":"integer","format":"int64"},"flow_key":{"type":"string"},"trace-id":{"type":"integer","format":"int32"}},"description":"Routing details info schema for GET response"},"RuleTypes":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"type":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}}},"SGTResponse":{"type":"object","properties":{"securityGroups":{"type":"array","items":{"$ref":"#/components/schemas/SecurityGroup"}}},"description":"Security Groups Returned from ISE"},"SSIDConfig":{"type":"object","properties":{"qosSettings":{"pattern":"(WLAN_QOS_BEST_EFFORT|WLAN_QOS_VIDEO|WLAN_QOS_VOICE|WLAN_QOS_BACKGROUND|WLAN_QOS_RESERVED)","type":"string"},"securityAuthType":{"pattern":"(OPEN|WPA2-PSK_AES)","type":"string"},"ssid":{"maxLength":32,"minLength":1,"type":"string"},"visibility":{"type":"boolean"},"wpaPskKey":{"type":"string"}}},"SaVaDistributionRequest":{"type":"object","properties":{"appliedFilters":{"$ref":"#/components/schemas/AppliedFilters"},"baseLicenses":{"type":"array","items":{"$ref":"#/components/schemas/SaVaDistributionRequestBaseLicenses"}},"tenantLicenses":{"$ref":"#/components/schemas/SaVaDistributionRequestTenantLicense"}}},"SaVaDistributionRequestBaseLicenses":{"type":"object","properties":{"displayName":{"type":"string","example":"Advantage Large"},"platformClass":{"type":"string","example":"C8530-12X4QC"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"},"uuids":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"SaVaDistributionRequestTenantLicense":{"type":"object","properties":{"displayName":{"type":"string","example":"Advantage Large"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"},"totalTenantLicRequired":{"type":"integer","format":"int32","example":10}}},"SaVaDistributionResponse":{"type":"object","properties":{"baseLicenses":{"type":"array","items":{"$ref":"#/components/schemas/SaVaDistributionResponseBaseLicenses"}},"tenantLicenses":{"$ref":"#/components/schemas/SaVaDistributionResponseTenantLicenses"}}},"SaVaDistributionResponseBaseLicenses":{"type":"object","properties":{"displayName":{"type":"string","example":"Advantage Large"},"platformClass":{"type":"string","example":"C8530-12X4QC"},"savaMap":{"type":"array","items":{"$ref":"#/components/schemas/SaVaDistributionResponseSaVaMap"}},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"},"uuids":{"type":"array","description":"List of device UUIDs","items":{"type":"string","description":"List of device UUIDs"}}}},"SaVaDistributionResponseSaVaMap":{"type":"object","properties":{"allocated":{"type":"integer","format":"int32","example":5},"available":{"type":"integer","format":"int32","example":20},"inUse":{"type":"integer","format":"int32","example":5},"saName":{"type":"string","example":"testaccount1.viptela.com"},"subscriptionId":{"type":"string","example":"sub00235"},"vaName":{"type":"string","example":"vManage_SDWAN_01"}}},"SaVaDistributionResponseTenantLicenses":{"type":"object","properties":{"displayName":{"type":"string","example":"Advantage Large"},"savaMap":{"type":"array","items":{"$ref":"#/components/schemas/SaVaDistributionResponseSaVaMap"}},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T0_P"}}},"SaveTemplateRequest":{"type":"object","properties":{"licenseTemplate":{"$ref":"#/components/schemas/SaveTemplateRequestLicenseTemplate"}}},"SaveTemplateRequestLicenseTemplate":{"type":"object","properties":{"licenseType":{"type":"string","example":"postpaid"},"licenses":{"type":"array","items":{"$ref":"#/components/schemas/SaveTemplateRequestLicenseTemplateLicenses"}},"saAccount":{"type":"string","example":"316448"},"saName":{"type":"string","example":"testaccount1.viptela.com"},"subscriptionsUsed":{"type":"array","items":{"$ref":"#/components/schemas/SaveTemplateRequestLicenseTemplateSubscriptionsUsed"}},"templateName":{"type":"string","example":"TestTemplate"},"useExistingTemplate":{"type":"boolean","example":false},"uuid":{"type":"array","items":{"type":"string"}},"vaAccount":{"type":"string","example":"702546"},"vaName":{"type":"string","example":"vManage_Test_Postpaid"}}},"SaveTemplateRequestLicenseTemplateLicenses":{"type":"object","properties":{"display_name":{"type":"string","example":"Routing DNA Premier: Tier 3"},"tag":{"type":"string","example":"regid.2020-10.com.cisco.DSTACK_T3_P,1.0_4fbf7891-fdee-4b78-9d70-696b260ef347"}}},"SaveTemplateRequestLicenseTemplateSubscriptionsUsed":{"type":"object","properties":{"subscription_id":{"type":"string","example":"3432DFGDGFD"}}},"ScheduleConfig":{"required":["scheduleType"],"type":"object","properties":{"scheduleType":{"type":"string","description":"Schedule type","example":"on_demand","enum":["on_demand","reoccur_onetime","reoccur_daily","reoccur_weekly","reoccur_monthly"]}},"description":"schedule config","discriminator":{"propertyName":"scheduleType"},"oneOf":[{"$ref":"#/components/schemas/OnDemandSchedule"},{"$ref":"#/components/schemas/OneTimeSchedule"},{"$ref":"#/components/schemas/ReoccurDailySchedule"},{"$ref":"#/components/schemas/ReoccurWeeklySchedule"},{"$ref":"#/components/schemas/ReoccurMonthlySchedule"}]},"SdaConfigRequest":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceConfig"}},"header":{"$ref":"#/components/schemas/VpnListResHeader"}}},"SdaDeviceConfigRes":{"type":"object","properties":{"id":{"type":"string","example":"push_template_configuration-640b1326-b96e-11ec-8422-0242ac120002"}}},"SdaDevicesRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Device"}},"header":{"$ref":"#/components/schemas/VpnListResHeader"}}},"SdaSitesRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PartnerSite"}},"header":{"$ref":"#/components/schemas/VpnListResHeader"}}},"SdraDeviceStatsShort":{"type":"object","properties":{"host_name":{"type":"string"},"ipsec_anyconnect":{"type":"integer","format":"int64"},"ipsec_soho":{"type":"integer","format":"int64"},"ipsec_unknown":{"type":"integer","format":"int64"},"site_id":{"type":"integer","format":"int64"},"sslvpn_anyconnect":{"type":"integer","format":"int64"},"system_ip":{"type":"string"}}},"SdraHeadendSummary":{"type":"object","properties":{"ipsec_enabled":{"type":"integer","format":"int64"},"sslvpn_enabled":{"type":"integer","format":"int64"}}},"SdraSessionCount":{"type":"object","properties":{"ipsec_anyconnect":{"type":"integer","format":"int64"},"ipsec_soho":{"type":"integer","format":"int64"},"ipsec_unknown":{"type":"integer","format":"int64"},"sslvpn_anyconnect":{"type":"integer","format":"int64"}}},"SdraSessionSummary":{"type":"object","properties":{"top":{"type":"array","items":{"$ref":"#/components/schemas/SdraDeviceStatsShort"}},"total":{"$ref":"#/components/schemas/SdraSessionCount"}}},"SecurityDeviceHealth":{"required":["amp_cloud_reachability","ips_cloud_reachability","ips_last_upload","ips_package_version","utd_container_health"],"type":"object","properties":{"amp_cloud_reachability":{"type":"string","example":"utd-file-repu-stat-connected"},"ips_cloud_reachability":{"type":"string","example":"utd-update-status-success"},"ips_last_upload":{"type":"integer","format":"int64","example":1692065659984},"ips_package_version":{"type":"string","example":"31550.15.s"},"utd_container_health":{"type":"string","example":"utd-oper-status-green"}}},"SecurityGroup":{"type":"object","properties":{"description":{"type":"string","example":"Any Security Group"},"id":{"type":"string","example":"92bb1950-8c01-11e6-996c-525400b48521"},"name":{"type":"string","example":"ANY"},"tag":{"type":"integer","format":"int32","example":65535}}},"SecurityPolicy":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"policyName":{"type":"string"},"defaultAction":{"pattern":"(drop|pass)","type":"string"},"policyRules":{"type":"array","items":{"$ref":"#/components/schemas/PolicyRule"}}}}]},"SecurityPolicyDeviceList":{"required":["amp_down","amp_up","ips_down","ips_up","urlf_down","urlf_up","zbfw_down","zbfw_up"],"type":"object","properties":{"amp_down":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"amp_up":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"ips_down":{"type":"array","example":["2.2.2.2"],"items":{"type":"string","example":"[\"2.2.2.2\"]"}},"ips_up":{"type":"array","example":["1.1.1.1"],"items":{"type":"string","example":"[\"1.1.1.1\"]"}},"urlf_down":{"type":"array","example":["3.3.3.3"],"items":{"type":"string","example":"[\"3.3.3.3\"]"}},"urlf_up":{"type":"array","example":["1.1.1.1"],"items":{"type":"string","example":"[\"1.1.1.1\"]"}},"zbfw_down":{"type":"array","example":[],"items":{"type":"string","example":"[]"}},"zbfw_up":{"type":"array","example":["1.1.1.1","2.2.2.2","3.3.3.3"],"items":{"type":"string","example":"[\"1.1.1.1\",\"2.2.2.2\",\"3.3.3.3\"]"}}}},"ServerList":{"type":"object","properties":{"server-name":{"type":"string"},"server-ports":{"type":"string"}}},"SetLifeCycle":{"type":"object","properties":{"DeviceLifeCycleNeeded":{"type":"boolean","example":false}}},"SeveritySummary":{"type":"object"},"SimSlotConfig":{"required":["attachProfileId","profileList","slotNumber"],"type":"object","properties":{"attachProfileId":{"maximum":16,"minimum":1,"type":"integer","format":"int32"},"carrierName":{"type":"string"},"dataProfileIdList":{"maxItems":1,"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}},"profileList":{"maxItems":16,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CellularProfile"}},"slotNumber":{"maximum":1,"minimum":0,"type":"integer","format":"int32"}}},"SimpleKeyValueMapping":{"type":"object","properties":{"key":{"type":"string","example":"system"},"value":{"type":"string","example":"System"}}},"SimpleMessageResponse":{"type":"object","properties":{"Message":{"type":"string","example":"Successfully dump data in log file"}}},"SiteHealth":{"type":"object","properties":{"fullConnectivity":{"type":"integer","format":"int32"},"noConnectivity":{"type":"integer","format":"int32"},"partialConnectivity":{"type":"integer","format":"int32"}}},"SiteHealthItem":{"required":["apps_health","apps_usage","devices_health","site_health","site_id","tunnels_health"],"type":"object","properties":{"apps_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"apps_usage":{"type":"number","example":1000},"devices_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"site_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"site_id":{"type":"string","example":"600"},"tunnels_health":{"type":"string","example":"good","enum":["good","fair","poor"]}}},"SiteHealthTopologyItem":{"required":["fair_site_count","good_site_count","poor_site_count"],"type":"object","properties":{"fair_site_count":{"type":"number","example":20},"good_site_count":{"type":"number","example":30},"poor_site_count":{"type":"number","example":10}}},"SmartAccountAuthenticateResponse":{"type":"object","properties":{"accessToken":{"type":"string","example":"V6tBFRhpCQkng5Ng7nTxn8WBiJRj"}}},"SmartAccountModel":{"type":"object","properties":{"clientCredentials":{"type":"boolean"},"env":{"type":"string"},"organization_name":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"},"validity_string":{"type":"string"}}},"SmartLicensingfetchAccountsResp":{"type":"object","properties":{"account_id":{"type":"string","example":"276200"},"name":{"type":"string","example":"testaccount3.viptela.com"},"virtual_accounts":{"type":"array","items":{"$ref":"#/components/schemas/SmartLicensingfetchAccountsRespVirtualAccounts"}}}},"SmartLicensingfetchAccountsRespVirtualAccounts":{"type":"object","properties":{"default":{"type":"boolean","example":false},"name":{"type":"string","example":"703805"},"virtual_account_id":{"type":"string","example":"713850"}}},"SoftwareVersion":{"required":["activeVersion","lastupdated","vdevice-dataKey","vdevice-host-name","vdevice-name"],"type":"object","properties":{"activeVersion":{"type":"string","example":"17.12.01.0.169449"},"lastupdated":{"type":"number","example":1674025491478},"vdevice-dataKey":{"type":"string","example":"172.16.255.11-"},"vdevice-host-name":{"type":"string","example":"vm1"},"vdevice-name":{"type":"string","example":"172.16.255.11"}}},"SpeedTestData":{"type":"object","properties":{"destination_circuit":{"type":"string","example":"lte"},"destination_ip":{"type":"string","example":"172.16.255.21"},"destination_local_ip":{"type":"string","example":"172.16.255.21"},"device_uuid":{"type":"string","example":"C8K-63eadff3-fa6d-4779-add0-d712a36c6f73"},"down_bw":{"type":"string","example":"NA"},"down_speed":{"type":"integer","format":"int64","example":0},"entry_time":{"type":"integer","format":"int64","example":1692757301266},"error":{"type":"string","example":"None"},"logid":{"type":"integer","format":"int64","example":0},"port":{"type":"string","example":"80"},"session_id":{"type":"string","example":"de26406d-21f2-4d3d-bc82-6f36553c45bf"},"source_circuit":{"type":"string","example":"lte"},"source_ip":{"type":"string","example":"172.16.255.15"},"source_local_ip":{"type":"string","example":"172.16.255.15"},"status":{"type":"string","example":"progress"},"tenant":{"type":"string","example":"default"},"up_bw":{"type":"string","example":"NA"},"up_speed":{"type":"integer","format":"int64","example":0}},"description":"This is valid speedTestData"},"SpeedTestInterfaceResponse":{"type":"object","properties":{"down_bw":{"type":"string","example":"NA"},"up_bw":{"type":"string","example":"NA"}},"description":"This is valid speedTestInterfaceResponse"},"SpeedTestResponse":{"type":"object","properties":{"isNewSession":{"type":"boolean","example":true},"isOwner":{"type":"boolean","example":true},"renewalTime":{"type":"integer","format":"int64","example":1692757301266},"sessionId":{"type":"string","example":"de26406d-21f2-4d3d-bc82-6f36553c45bf"},"startTime":{"type":"integer","format":"int64","example":1692757301266},"type":{"type":"string","example":"speedTest"},"userIp":{"type":"string","example":"172.16.255.15"},"uuid":{"type":"string","example":"C8K-63eadff3-fa6d-4779-add0-d712a36c6f73"}},"description":"This is valid speedTestResponse"},"SpeedTestResult":{"type":"object","properties":{"down-speed":{"type":"number","format":"double","example":9},"error":{"type":"string","example":"NA"},"location":{"type":"string","example":"NA"},"server":{"type":"string","example":"NA"},"status":{"type":"string","example":"NA"},"up-speed":{"type":"number","format":"double","example":9}},"description":"This is valid SpeedTestResult"},"SpeedTestResultResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SpeedTestData"}},"description":"This is valid speedTestResultResponse"},"SpeedTestSession":{"type":"object","properties":{"destinationColor":{"type":"string","example":"lte"},"destinationIp":{"type":"string","example":"10.1.15.13"},"deviceUUID":{"type":"string"},"port":{"type":"string","example":"9999"},"server-list":{"type":"array","items":{"$ref":"#/components/schemas/ServerList"}},"sourceColor":{"type":"string","example":"lte"},"sourceInterface":{"type":"string","example":"GigabitEthernet4"},"sourceIp":{"type":"string","example":"10.1.15.13"}},"description":"This is valid SpeedTestSession"},"SpeedTestStatusResponse":{"type":"object","properties":{"status":{"type":"string","example":"success"}},"description":"This is valid speedTestStatusResponse"},"SshKeyList":{"type":"object","properties":{"sshKeyName":{"type":"string"}}},"StatisticsDBQueryParam":{"type":"object","properties":{"aggregation":{"$ref":"#/components/schemas/DBQueryAggregationObject"},"category":{"type":"string"},"fields":{"type":"array","items":{"type":"object"}},"plot_data":{"type":"array","items":{"type":"string"}},"query":{"$ref":"#/components/schemas/DBQuerySpecObject"},"size":{"type":"integer","format":"int32"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/DBQuerySortObject"}}},"description":"Statistics search DB Query JSON object"},"StatisticsProcessingCounters":{"type":"object","properties":{"counters":{"type":"array","items":{"$ref":"#/components/schemas/StatsTypeProcessingCounters"}}}},"StatsTypeProcessingCounters":{"type":"object","properties":{"compressed_size":{"type":"integer","format":"int64"},"files_number":{"type":"integer","format":"int64"},"processing_time":{"type":"integer","format":"int64"},"records_number":{"type":"integer","format":"int64"},"stats_type":{"type":"string"},"uncompressed_size":{"type":"integer","format":"int64"}}},"StatusList":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/StatusObject"}},"StatusObject":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"message":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}}},"StatusResponse":{"type":"object","properties":{"status":{"type":"string","example":"success"}}},"SupportedResponse":{"type":"object","properties":{"uuid":{"$ref":"#/components/schemas/SupportedResponseUuid"}}},"SupportedResponseUuid":{"type":"object","properties":{"deviceM\u00f8del":{"type":"string","example":"c800v"},"isAutonomousSupported":{"type":"boolean","example":true},"isSoftwareDevice":{"type":"boolean","example":true},"isSystemIpPoolNeeded":{"type":"boolean","example":true}}},"SwImagesResponse":{"type":"object","properties":{"deviceModel":{"type":"string","example":"vedge-C8000V"},"displayName":{"type":"string","example":"C8000v 17.04.01b"},"isPaygImage":{"type":"boolean","example":false},"softwareImageId":{"type":"string","example":"Cisco-C8k-17.04.01b-42cb6e93-8d9d-490b-a73c-e3e56077ffd1"},"version":{"type":"string","example":"17.04.01b"}}},"SyncDevicesResp":{"type":"object","properties":{"processId":{"type":"string","example":"c82d4877-dc04-4580-aedc-3a10166dab4d"}}},"SyncRequest":{"type":"object","properties":{"data":{"type":"string","example":"{\"mode\":\"onprem\",\"multipleEntitlement\":false,\"smartAccounts\":[{\"account_id\":\"1\",\"name\":\"sjc24_onprem_sle\",\"virtual_accounts\":[{\"virtual_account_id\":\"1\"}]}]}"},"name":{"type":"string","format":"binary"}}},"SyncRootCertChain":{"type":"object","properties":{"syncRootCertChain":{"type":"string","example":"done"}}},"SyncStatusResponse":{"type":"object","properties":{"Last Synced":{"type":"string","example":"04 Dec 2020 19:23:54 UTC"},"webexSyncNeeded":{"type":"boolean","example":true}}},"Systems":{"type":"object","properties":{"consoleBaudRate":{"type":"string"},"description":{"type":"string"},"deviceGroup":{"type":"string"},"gpsLatitude":{"type":"string"},"gpsLongitude":{"type":"string"},"hostName":{"type":"string"},"location":{"type":"string"},"onDemandTunnel":{"type":"string"},"onDemandTunnelIdleTimeout":{"type":"integer","format":"int32"},"portHopping":{"type":"string"},"portOffset":{"type":"integer","format":"int32"},"siteId":{"type":"string"},"systemIp":{"type":"string"},"timeZone":{"type":"string"}}},"Tacacs":{"type":"object","properties":{"authentication":{"type":"string","enum":["ASCII","PAP"]},"server":{"type":"array","items":{"$ref":"#/components/schemas/TacacsServer"}},"timeout":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"}}},"TacacsServer":{"type":"object","properties":{"address":{"type":"string"},"authPort":{"type":"integer","format":"int32"},"key":{"type":"string"},"priority":{"maximum":7,"minimum":1,"type":"integer","format":"int32"},"secretKey":{"type":"string"},"vpn":{"maximum":65535,"minimum":1,"type":"integer","format":"int32"},"vpnIpSubnet":{"type":"string"}}},"TagsResponse":{"type":"object","properties":{"tag":{"type":"string","example":"test-tag"}}},"TaskHistoryResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskHistoryResponsePayloadData"}}},"description":"Auto on task schema for GET response"},"TaskHistoryResponsePayloadData":{"type":"object","properties":{"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"events":{"type":"array","items":{"type":"string"}},"expire-time":{"type":"integer","format":"int32"},"sites":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"},"traces":{"type":"boolean"},"type":{"type":"string"}}},"TaskId":{"type":"object","properties":{"id":{"type":"string","example":"reboot-01232017T154359940"}}},"TaskIdResponse":{"required":["taskId"],"type":"object","properties":{"taskId":{"type":"string","description":"Task ID","format":"uuid","example":"e2e28c40-cb1e-45d7-9637-98e145a70174"}}},"TaskTracesResponsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskTracesResponsePayloadInner"}}},"description":"Auto on task schema for GET response"},"TaskTracesResponsePayloadInner":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NwpiTraceHistoryRespPayloadData"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}}},"Taskid":{"type":"object","properties":{"id":{"type":"string","example":"6c723f65-9106-4f43-9d2b-a033a39353b3"}},"description":"Task id for polling status"},"TasksCreatePostRequestPayload":{"required":["events","sites","taskName"],"type":"object","properties":{"duration":{"pattern":"^[1-9][0-9]{0,4}$","type":"string","description":"Task duration"},"events":{"type":"array","description":"Event list","items":{"type":"string","description":"Event list"}},"sites":{"type":"array","description":"Site list","items":{"type":"string","description":"Site list"}},"taskName":{"maxLength":128,"minLength":1,"type":"string","description":"Task name"}},"description":"Auto on task create schema for POST request"},"TasksCreateResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"expire-time":{"type":"integer","format":"int32"},"sites":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"}},"description":"Auto on task create schema for POST response"},"TasksDeleteResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"message":{"$ref":"#/components/schemas/TasksDeleteResponsePayloadMessage"},"taskId":{"type":"string"}},"description":"Auto on task schema for DELETE response"},"TasksDeleteResponsePayloadMessage":{"type":"object","properties":{"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"events":{"type":"string"},"expire-time":{"type":"integer","format":"int64"},"message":{"type":"string"},"sites":{"type":"string"},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"},"traces":{"type":"boolean"}}},"TasksStopResponsePayload":{"type":"object","properties":{"action":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"message":{"type":"string"},"state":{"type":"string"},"taskId":{"type":"string"},"taskName":{"type":"string"}},"description":"Auto on task stop schema for POST response"},"TelemetryRequests":{"required":["cloudType"],"type":"object","properties":{"cgwList":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"type":"string"}},"cloudType":{"pattern":"[aA][zZ][uU][rR][eE]$","type":"string","example":"AZURE"}}},"TenantStatus":{"type":"object","properties":{"controlStatus":{"$ref":"#/components/schemas/ControlStatus"},"getvEdgeHealth":{"$ref":"#/components/schemas/VEdgeHealth"},"getvSmartStatus":{"$ref":"#/components/schemas/VSmartStatus"},"siteHealth":{"$ref":"#/components/schemas/SiteHealth"},"tenantId":{"type":"string"},"tenantName":{"type":"string"}}},"TenantStatusListModel":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TenantStatus"}},"header":{"$ref":"#/components/schemas/Header"}}},"TestbedMode":{"type":"object","properties":{"isStaging":{"type":"boolean","example":false}}},"TimeOptions":{"type":"object","properties":{"enableDateFields":{"type":"boolean","example":false},"key":{"type":"string","example":"last_24_hours"},"value":{"type":"string","example":"Last 24 hours"}}},"TlocControl":{"type":"object","properties":{"host-name":{"type":"string","example":"vm9"},"is-preferred":{"type":"boolean","example":true},"local-status":{"type":"string","enum":["green","red"]},"local-status-info":{"type":"string"},"peer-type":{"type":"string","example":"vsmart","enum":["vbond","vedge","vsmart","vmanage","vedge-vbond","nonSDWAN"]},"remote-status":{"type":"string","enum":["green","red"]},"remote-status-info":{"type":"string"},"state":{"type":"string","example":"up","enum":["up","down"]},"system-ip":{"type":"string","example":"172.16.255.19"}}},"Tokens":{"type":"object","properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer","format":"int32"},"refresh_token":{"type":"string"},"scope":{"type":"string"},"token_type":{"type":"string"}},"description":"Response from Cisco SecureX token API"},"Topology":{"type":"object","properties":{"devices":{"type":"array","items":{"$ref":"#/components/schemas/ConfigGroupDevice"}},"siteDevices":{"type":"integer","format":"int32"}}},"TopologyGroup":{"required":["name","solution","state","version"],"type":"object","properties":{"activeStatus":{"type":"boolean"},"copyInfo":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"description":{"type":"string","description":"Description of the Group.","example":" group for west coast retail stores"},"devices":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"System generated unique identifier of the Group in UUID format.","example":"6fa14197-c25f-4a14-b81b-299de32ed2ca"},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"name":{"type":"string","description":"Name of the Group. Must be unique.","example":"West coast retail stores"},"numberOfDevices":{"type":"integer","format":"int64"},"numberOfDevicesUpToDate":{"type":"integer","format":"int64"},"origin":{"type":"string"},"originInfo":{"type":"object","additionalProperties":{"type":"string"}},"profiles":{"type":"array","description":"List of devices UUIDs associated with this group","example":"West coast retail store devices","items":{"$ref":"#/components/schemas/FeatureProfile"}},"solution":{"type":"string","description":"Specify one of the device platform solution","example":"sdwan","enum":["mobility","sdwan","sd-routing","common","nfvirtual","service-insertion","cellulargateway"]},"source":{"type":"string","description":"Source of group","example":"retail_workflow"},"state":{"type":"string","description":" Group Deployment state","example":" Group Deployment state.Initial state Deployed "},"version":{"type":"integer","description":" Group Version Flag","format":"int64"}}},"TraceCftRecordResponsePayload":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TraceCftRecordResponsePayloadData"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Get cft record for GET response"},"TraceCftRecordResponsePayloadData":{"type":"object","properties":{"agg_total_bytes":{"type":"integer","format":"int32"},"agg_total_fif_bytes":{"type":"integer","format":"int32"},"agg_total_fif_packets":{"type":"integer","format":"int32"},"agg_total_fin_flows":{"type":"integer","format":"int32"},"agg_total_flows":{"type":"integer","format":"int32"},"agg_total_packets":{"type":"integer","format":"int32"},"agg_total_ttl_ms":{"type":"integer","format":"int32"},"app_group":{"type":"string"},"app_name":{"type":"string"},"avg_bps":{"type":"integer","format":"int32"},"avg_concurrent_flows":{"type":"integer","format":"int32"},"avg_cps":{"type":"number"},"avg_pps":{"type":"number"},"avg_ttl_ms":{"type":"number"},"bps":{"type":"integer","format":"int32"},"concurrent_flows":{"type":"integer","format":"int32"},"cps":{"type":"number"},"device_name":{"type":"string"},"device_trace_id":{"type":"integer","format":"int32"},"device_uuid":{"type":"string"},"if_name":{"type":"string"},"last_report_ts":{"type":"integer","format":"int32"},"local_color":{"type":"string"},"max_bps":{"type":"integer","format":"int32"},"max_concurrent_flows":{"type":"integer","format":"int32"},"max_cps":{"type":"number"},"max_pps":{"type":"number"},"max_ttl_ms":{"type":"integer","format":"int32"},"min_bps":{"type":"integer","format":"int32"},"min_concurrent_flows":{"type":"integer","format":"int32"},"min_cps":{"type":"number"},"min_pps":{"type":"number"},"min_ttl_ms":{"type":"integer","format":"int32"},"model":{"type":"string"},"pps":{"type":"number"},"received_timestamp":{"type":"integer","format":"int64"},"system_ip":{"type":"string"},"vpn_id":{"type":"string"}}},"TraceFinFlowTimeRangeResponsePayload":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"Fin Flow schema for GET response","items":{"$ref":"#/components/schemas/TraceFinFlowTimeRangeResponsePayloadInner"}},"TraceFinFlowTimeRangeResponsePayloadInner":{"type":"object","properties":{"data":{"type":"object"},"data.received_timestamp":{"type":"integer","format":"int64"},"entry_time":{"type":"integer","format":"int64"},"tenant":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Fin Flow schema for GET response"},"TraceInfoResponsePayload":{"type":"object","properties":{"entry_time":{"type":"integer","format":"int64"},"summary":{"$ref":"#/components/schemas/TraceInfoResponsePayloadSummary"},"trace-id":{"type":"integer","format":"int32"}},"description":"Trace base info Data Response schema"},"TraceInfoResponsePayloadSummary":{"type":"object","properties":{"agg-client-prefix":{"type":"string"},"agg-src-sgt":{"type":"string"},"agg-svr-prefix":{"type":"string"},"app":{"type":"string"},"app-grp":{"type":"string"},"app-vis":{"type":"string"},"art-vis":{"type":"string"},"common_app":{"type":"string"},"device-ip":{"type":"string"},"dia-vis":{"type":"string"},"domain-mon":{"type":"string"},"dscp":{"type":"string"},"dst-ip":{"type":"string"},"dst-pfx":{"type":"string"},"dst-pfx-len":{"type":"string"},"dst-port":{"type":"string"},"duration":{"type":"string"},"hub-wan-vis":{"type":"string"},"local-drop-rate-threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos-mon":{"type":"string"},"sampling":{"type":"string"},"source-site":{"type":"string"},"source-site-vmanage-version":{"type":"string"},"spl-intvl":{"type":"string"},"src-if":{"type":"string"},"src-ip":{"type":"string"},"src-pfx":{"type":"string"},"src-pfx-len":{"type":"string"},"src-port":{"type":"string"},"state":{"type":"string"},"stop-time":{"type":"integer","format":"int64"},"taskId":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"trace-trigger-event":{"type":"string"},"vpn-id":{"type":"string"},"vpn-list":{"type":"string"},"wan-drop-rate-threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}}},"TracerouteRequest":{"type":"object","properties":{"deviceIp":{"type":"string","example":"172.16.255.15"},"host":{"type":"string","example":"3::2"},"interface":{"type":"string","example":"3::1"},"interfaceIP":{"type":"string","example":"3::1"},"size":{"type":"string","example":"128"},"vpn":{"type":"string","example":"0"}}},"TracerouteResponse":{"type":"object","properties":{"nexthops":{"type":"array","items":{"$ref":"#/components/schemas/Hops"}},"rawOutput":{"type":"array","items":{"type":"string"}}}},"TunnelHealthData":{"type":"object","properties":{"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"loss_percentage":{"type":"number","format":"double"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}}},"TunnelHealthHistoryItem":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"history":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthEntryItem"}},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"summary":{"$ref":"#/components/schemas/TunnelHealthData"}}},"TunnelHealthOverview":{"type":"object","properties":{"detail":{"$ref":"#/components/schemas/TunnelHealthOverviewDetail"},"total":{"$ref":"#/components/schemas/TunnelHealthOverviewTotal"}}},"TunnelHealthOverviewDetail":{"type":"object","properties":{"fair":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthOverviewEntry"}},"good":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthOverviewEntry"}},"poor":{"type":"array","items":{"$ref":"#/components/schemas/TunnelHealthOverviewEntry"}}}},"TunnelHealthOverviewEntry":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"loss_percentage":{"type":"number","format":"double"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}}},"TunnelHealthOverviewTotal":{"type":"object","properties":{"fair":{"type":"number","example":100},"good":{"type":"number","example":100},"poor":{"type":"number","example":100}}},"TunnelScalingRequestPayload":{"required":["cloudType"],"type":"object","properties":{"branchEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/TunnelScalingRequestPayloadBranchEndpoints"}},"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string","example":"AWS"}}},"TunnelScalingRequestPayloadBranchEndpoints":{"required":["acceleratedVpn","cloudType","color","siteId","systemIp","tunnelCount"],"type":"object","properties":{"acceleratedVpn":{"pattern":"^(true|false)$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string","example":"AWS"},"color":{"pattern":"^(default|mpls|metro-ethernet|biz-internet|public-internet|lte|3g|red|green|blue|gold|silver|bronze|custom1|custom2|custom3|private1|private2|private3|private4|private5|private6)$","type":"string","example":"red"},"hostName":{"type":"string","example":"test_device"},"interface":{"type":"string","example":"GigabitEthernet1"},"preferredInterface":{"pattern":"^[a-zA-Z0-9]*$","type":"string","example":"true"},"publicIp":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string","example":"3.129.232.5"},"siteId":{"pattern":"^\\d+$","type":"string","example":"578"},"solution":{"pattern":"^(sdwan|sd-routing)$","type":"string","example":"sd-routing"},"status":{"type":"string","example":"unavailable"},"systemIp":{"pattern":"^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$","type":"string","example":"1.1.1.178"},"tunnelCount":{"pattern":"^[1-8]$","type":"string","example":"4"},"uuid":{"type":"string","example":"C8K-b78a317a-0d6c-4023-9690-8559d6ac803d"}}},"Tunnels":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD","items":{"$ref":"#/components/schemas/TunnelsInner"}},"TunnelsInner":{"type":"object","properties":{"acceptedRouteCount":{"type":"integer","format":"int32"},"lastStatusChangeTimestamp":{"type":"string"},"outerIpAddr":{"type":"string"},"status":{"type":"string"},"statusMessage":{"type":"string"},"tunnelId":{"type":"string"},"tunnelInnerIp":{"type":"array","items":{"type":"string"}}},"description":"CGW details relevant to AWS/AWS_GOVCLOUD"},"UMTSInput":{"type":"object","properties":{"deviceUUID":{"type":"string","example":"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f"},"localColor":{"type":"string","example":"lte"},"remoteColor":{"type":"string","example":"remote-color-all"},"remoteSystem":{"type":"string","example":"172.16.255.16,172.16.255.14"}}},"UMTSRecord":{"type":"object","properties":{"event_subtype":{"type":"string","example":"NONE"},"event_type":{"type":"string","example":"PERIODIC"},"hops":{"$ref":"#/components/schemas/UMTSRecordHop"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.15"},"proto":{"type":"string","example":"ipsec"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.202"},"sent_qos":{"type":"number","example":72},"state":{"type":"string","example":"up"},"vip_idx":{"type":"number","example":99},"vip_time":{"type":"number","example":1643400901399}}},"UMTSRecordHop":{"type":"object","properties":{"hop":{"type":"array","items":{"$ref":"#/components/schemas/UMTSRecordHopsHop"}}}},"UMTSRecordHopsHop":{"type":"object","properties":{"hostname":{"type":"string","example":"vm5"},"idx":{"type":"number","example":99},"ip":{"type":"string","example":"10.1.15.13"},"jitter":{"type":"number","example":0},"lbl_info":{"type":"number","example":0},"loss":{"type":"number","example":0},"recv_qos":{"type":"number","example":0},"reply_qos":{"type":"number","example":0},"rtt":{"type":"number","example":0},"rtt_max":{"type":"number","example":0},"rtt_min":{"type":"number","example":0}}},"UMTSSaveInput":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/UMTSRecord"}}}},"UMTSSession":{"type":"object","properties":{"download_status":{"type":"string","example":"success"},"payload":{"type":"string","example":"{\"deviceUUID\":\"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f\",\"localColor\":\"lte\",\"remoteSystem\":\"172.16.255.16\",\"remoteColor\":\"lte\",\"actionType\":\"ON_DEMANDING\",\"sessionId\":\"5596803a-e594-413b-89f2-2acecd1d5f92\"}"},"renewalTime":{"type":"number","example":1654566270967},"requestStatus":{"type":"string","example":"stop"},"sessionId":{"type":"string","example":"5596803a-e594-413b-89f2-2acecd1d5f92"},"startTime":{"type":"number","example":1654566270968},"status":{"type":"string","example":"success"},"statusMessage":{"type":"string","example":"device error"},"type":{"type":"string","example":"ON_DEMANDING"},"user":{"type":"string","example":"admin"},"userIp":{"type":"string","example":"100.1.2.3"},"uuid":{"type":"string","example":"C8K-21a355e3-fd5b-4d03-9d48-f2845388c07f"}}},"Umbrella":{"type":"object","properties":{"api-key":{"$ref":"#/components/schemas/APIKey"},"api-key-v2":{"$ref":"#/components/schemas/APIKey"},"api-secret":{"$ref":"#/components/schemas/APISecret"},"api-secret-v2":{"$ref":"#/components/schemas/APISecret"},"org-id":{"$ref":"#/components/schemas/OrgID"}},"description":"Umbrella object"},"UnsupportedFeature":{"type":"object","properties":{"parcelId":{"type":"string","format":"uuid"},"parcelType":{"type":"string","enum":["wan/vpn/interface/gre","wan/vpn/interface/ethernet","wan/vpn/interface/cellular","wan/vpn/interface/ipsec","wan/vpn/interface/serial","wan/vpn/interface/dsl-pppoe","wan/vpn/interface/dsl-pppoa","wan/vpn/interface/dsl-ipoe","routing/ospf","lan/vpn/interface/ethernet","lan/vpn/interface/gre","lan/vpn/interface/svi","lan/vpn/interface/ipsec","lan/vpn","global-vrf","vrf/wan/interface/gre","vrf/wan/interface/ethernet","vrf/wan/interface/ipsec","vrf/lan/interface/gre","vrf/lan/interface/ethernet","vrf/lan/interface/ipsec","vrf","vrf/routing/bgp","global-vrf/routing/bgp","wan/multicloud-connection","lan/multicloud-connection","vrf/wan/multicloud-connection","vrf/lan/multicloud-connection","global-vrf/wan/interface/ipsec","routing/bgp","route-policy","service-insertion-attachment"]}}},"UpdateCgw":{"required":["accountId","cloudGatewayName","cloudType","region","resourceGroupName","vhubId"],"type":"object","properties":{"accountId":{"type":"string"},"cloudGatewayName":{"pattern":"^[\\w.-]{1,128}$","type":"string"},"cloudType":{"pattern":"^[a-zA-Z_]+$","type":"string"},"description":{"type":"string"},"deviceChanges":{"$ref":"#/components/schemas/UpdateCgwDeviceChanges"},"devices":{"type":"array","description":"Used for AZURE updateCgw","items":{"type":"string","description":"Used for AZURE updateCgw"}},"mrfRouterRole":{"pattern":"^(border|edge)$","type":"string"},"region":{"pattern":"^[a-zA-Z0-9_./\\-]+$","type":"string"},"resourceGroupName":{"pattern":"^[\\w.-]{1,128}$","type":"string","description":"Used for AZURE updateCgw"},"s2sPermitted":{"pattern":"^(true|false)$","type":"string","description":"Used for GCP updateCgw"},"settings":{"$ref":"#/components/schemas/AllOfupdateCgwSettings"},"vhubId":{"type":"string","description":"Used for AZURE updateCgw"}}},"UpdateCgwDeviceChanges":{"type":"object","properties":{"devicesAdded":{"type":"array","items":{"type":"string"}},"devicesDeleted":{"type":"array","items":{"type":"string"}}},"description":"Used for GCP updateCgw"},"UpdatePartnerRequest":{"type":"object","properties":{"description":{"type":"string","example":"dnac-test-new"},"name":{"type":"string","example":"DNAC-test-new"}}},"UpdateReportTemplateResponse":{"required":["reportId"],"type":"object","properties":{"reportId":{"type":"string","description":"Report ID","format":"uuid","example":"e2e28c40-cb1e-45d7-9637-98e145a70174"}}},"UpdateTenantModel":{"type":"object","properties":{"desc":{"type":"string"},"edgeConnectorEnable":{"type":"boolean"},"edgeConnectorSystemIp":{"type":"string"},"edgeConnectorTunnelInterfaceName":{"type":"string"},"getvBondAddress":{"type":"string"},"getvSmarts":{"type":"array","items":{"type":"string"}},"idpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"name":{"type":"string"},"oldIdpMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IDPInfo"}},"spMetadata":{"type":"string"},"subDomain":{"type":"string"},"wanEdgeForecast":{"type":"string"}}},"UpdateTenantvSmartModel":{"type":"object","properties":{"destvSmartUuid":{"type":"string"},"srcvSmartUuid":{"type":"string"}}},"UrlMonitoringInfo":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/UrlMonitoringInfoInner"}},"UrlMonitoringInfoInner":{"type":"object","properties":{"alarmRaised":{"type":"boolean","example":true},"threshold":{"type":"integer","description":"VManage alarm is raised after reaching the threshold.","format":"int32","example":20},"url":{"type":"string","description":"url registered for monitoring requests.","example":"/client/server/ready"}}},"UserGroupsBody":{"type":"object","properties":{"filter":{"type":"string","example":"Cert Publishers"}}},"UserGroupsDataObject":{"type":"object","properties":{"ERSActiveDirectoryGroups":{"$ref":"#/components/schemas/ERSActiveDirectoryGroups"}},"description":"Data Object for Users Groups call"},"UserGroupsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserGroupsDataObject"},"header":{"$ref":"#/components/schemas/HeaderObject"}},"description":"User Groups Data from ISE active directory domain"},"UserObject":{"type":"object","properties":{"adUserSamAccountName":{"type":"string","example":"guests"}},"description":"Object containing the users name"},"UserSettingsResponse":{"type":"object","properties":{"isPresentCredentials":{"type":"boolean","example":true},"mode":{"type":"string","description":"Smart Licensing mode can be 'online', 'offline' or 'onPrem'","example":"online"},"multipleEntitlement":{"type":"boolean","example":false},"uname":{"type":"string","description":"Smart Licensing user name","example":"TestUser"}}},"UsergroupObject":{"type":"object","properties":{"name":{"type":"string","example":"b1.com/Builtin/Administrators"},"sid":{"type":"string","example":"b1.com/S-1-5-32-544"},"type":{"type":"string","example":"BUILTIN, DOMAIN LOCAL"}}},"UsersBody":{"type":"object","properties":{"filter":{"type":"string"}},"description":"Users body with regex filter for which users to retrieve from ISE"},"UsersDataObject":{"type":"object","properties":{"ERSActiveDirectoryUsers":{"$ref":"#/components/schemas/ERSActiveDirectoryUsers"}},"description":"Data Object for Users get call"},"UsersResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UsersDataObject"},"header":{"$ref":"#/components/schemas/HeaderObject"}},"description":"Users returned from ISE active directory domain"},"Uuid":{"type":"object","properties":{"uuid":{"type":"string"}},"description":"This is valid uuid"},"UuidToDomainId":{"type":"object","properties":{"domain":{"maxLength":200,"minLength":1,"type":"string"},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/UuidToDomainIdMapping"}}}},"UuidToDomainIdMapping":{"type":"object","properties":{"domainId":{"type":"integer","format":"int32"},"uuid":{"type":"string"}}},"VEdgeBootstrapConfig":{"type":"object","properties":{"bootstrapConfigType":{"type":"string"},"uuid":{"type":"array","items":{"type":"string"}}}},"VEdgeHealth":{"type":"object","properties":{"error":{"type":"integer","format":"int32"},"normal":{"type":"integer","format":"int32"},"warning":{"type":"integer","format":"int32"}}},"VPNID":{"type":"object","properties":{"vpn":{"type":"string"}},"description":"This is the valid list of VPN-IDs"},"VSmartStatus":{"type":"object","properties":{"down":{"type":"integer","format":"int32"},"up":{"type":"integer","format":"int32"}}},"ValidateUser1Response":{"type":"object","properties":{"activityList":{"type":"string","example":"[Number of PAYG vEdges added successfully: 2, Added PAYG vEdges (chassis Id, serial number): , - C8K-PAYG-b44-e6aa-4d42-a637-82fd74ec523b, 6573ef62902e447db063dab76613b2c3, - C8K-PAYG-083-f30e-40b5-80fe-55f401a4839b, aa82b3bb8cda48b7b3693bc70fd1a0bb]"},"id":{"type":"string","example":"42ce4e4e-aaea-4dcd-9507-037ee42a06e5"},"vedgeListAddMsg":{"type":"string","example":"Number of PAYG vEdges added successfully: 2"},"vedgeListAddStatus":{"type":"string","example":"PAYG vEdge list added successfully"}}},"Variable":{"required":["jsonPath","varName"],"type":"object","properties":{"jsonPath":{"type":"string"},"varName":{"type":"string"}}},"VedgeCheckResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VedgeCheckResponseData"},"header":{"$ref":"#/components/schemas/VedgeCheckResponseHeader"}}},"VedgeCheckResponseData":{"type":"object","properties":{"vEdgeDevicePresent":{"type":"boolean"}},"description":"data field"},"VedgeCheckResponseHeader":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumns"}},"fields":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderFields"}},"generatedOn":{"type":"integer","format":"int64"},"viewKeys":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderViewKeys"}},"description":"header field"},"VedgeCheckResponseHeaderColumns":{"type":"object","properties":{"actionColumn":{"type":"boolean"},"arrayDataType":{"type":"string"},"color":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsColor"},"colorProperty":{"type":"string"},"dataType":{"type":"string"},"defaultPropertyKey":{"type":"string"},"defaultPropertyValue":{"type":"string"},"display":{"type":"string"},"displayFormat":{"type":"string"},"editable":{"type":"boolean"},"hideable":{"type":"boolean"},"hostValueType":{"type":"string"},"icon":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsKeyvalue"}},"iconProperty":{"type":"string"},"inputFormat":{"type":"string"},"isLeftPinned":{"type":"boolean"},"isPinned":{"type":"boolean"},"keyvalue":{"type":"array","items":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsKeyvalue"}},"keyvalueProperty":{"type":"string"},"maxWidth":{"type":"integer","format":"int32"},"minWidth":{"type":"integer","format":"int32"},"prependedString":{"type":"boolean"},"property":{"type":"string"},"sort":{"$ref":"#/components/schemas/VedgeCheckResponseHeaderColumnsSort"},"title":{"type":"string"},"toolTipProperty":{"type":"string"},"visible":{"type":"boolean"},"width":{"type":"integer","format":"int32"}}},"VedgeCheckResponseHeaderColumnsColor":{"type":"object","properties":{"key":{"type":"string"},"property":{"type":"string"},"value":{"type":"string"}}},"VedgeCheckResponseHeaderColumnsKeyvalue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"VedgeCheckResponseHeaderColumnsSort":{"type":"object","properties":{"direction":{"type":"string"},"priority":{"type":"integer","format":"int32"}}},"VedgeCheckResponseHeaderFields":{"type":"object","properties":{"dataType":{"type":"string","description":"dataType field"},"display":{"type":"string","description":"display field"},"property":{"type":"string","description":"property field"}}},"VedgeCheckResponseHeaderViewKeys":{"type":"object","properties":{"uniqueKey":{"type":"array","items":{"type":"string"}}}},"VedgeInventoryData":{"type":"object","properties":{"chasisNumber":{"type":"string","example":"0a452cf0-5db7-47c2-80bf-7e619e294a6b"},"deviceType":{"type":"string","example":"vedge"},"local-system-ip":{"type":"string","example":"172.16.255.14"},"serialNumber":{"type":"string","example":"12345707"},"site-id":{"type":"string","example":"400"},"system-ip":{"type":"string","example":"0.0.0.0"},"validity":{"type":"string","example":"valid"}}},"VersionInformation":{"type":"object","properties":{"currentServerVersion":{"type":"string","example":"1.2"},"link":{"$ref":"#/components/schemas/LinkObject"},"supportedVersions":{"type":"string","example":"1.0,1.1,1.2"}}},"VhubsListResponse":{"type":"object","properties":{"source":{"type":"string","example":"vManage"},"vhubId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualHubs/cgw-test"},"vhubName":{"type":"string","example":"cgw-test"}}},"VnicInfo":{"type":"object","properties":{"deploymentName":{"type":"string"},"network":{"type":"string"},"nicId":{"type":"string"},"vmGroupName":{"type":"string"}}},"Vpn":{"type":"object","properties":{"vpnId":{"type":"string","example":"33"},"vpnType":{"type":"string","example":"configuredVPN"}}},"VpnGatewayResponse":{"type":"object","properties":{"source":{"type":"string","example":"vManage"},"vpnGatewayId":{"type":"string","example":"/subscriptions/9b188cb9-f358-4db6-a44f-8406854789a0/resourceGroups/azureTestRGP8/providers/Microsoft.Network/virtualHubs/azureTestVhub2"},"vpnGatewayName":{"type":"string","example":"vpn-gateway-azure-east-2"}}},"VpnListRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Vpn"}},"header":{"$ref":"#/components/schemas/VpnListResHeader"}}},"VpnListResHeader":{"type":"object","properties":{"generatedOn":{"type":"integer","format":"int64","example":1649645769219}}},"VsmartSyncResponse":{"type":"object","properties":{"id":{"type":"string","example":"push_file_template_configuration-9101ae23-c48b-4c33-af3a-4444e4a63b02"}},"description":"Response for a vsmart sync with the task id for the push from vManage to vSmarts"},"VwanListResponse":{"type":"object","properties":{"source":{"type":"string","example":"vmanage"},"vwanId":{"type":"string","example":"/subscriptions/8b188c39-f358-4db6-a44f-84068541233a0/resourceGroups/test-resource-group/providers/Microsoft.Network/virtualWans/test-vwan"},"vwanName":{"type":"string","example":"test-vwan"}}},"WanEdgeDevicesResponse":{"type":"object","properties":{"configuredHostName":{"type":"string","example":"aws-test2"},"configuredSystemIp":{"type":"string","example":"9.1.1.2"},"deviceModel":{"type":"string","example":"vedge-C8000V"},"isPaygUuid":{"type":"boolean","example":false},"uuid":{"type":"string","example":"C8K-4B68E23F-B24F-EDE8-05DD-B36EAA14C9C1"}}},"WanSpec":{"required":["accountId","cloudRegion","mappedBranches","resourceGroup","vpn"],"type":"object","properties":{"accountId":{"type":"string","format":"uuid"},"cloudRegion":{"type":"string"},"mappedBranches":{"type":"string"},"resourceGroup":{"type":"string"},"vpn":{"type":"string"},"wanId":{"type":"string","format":"uuid"}}},"WcmNetconfConfigRequest":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NetconfConfig"}},"header":{"$ref":"#/components/schemas/NetconfConfigHeader"}}},"WcmNetconfConfigRes":{"type":"object","properties":{"id":{"type":"string","example":"push_template_configuration-40649f49-787a-4481-9b55-c13eabbde7f2"}}},"WebexDataCenter":{"type":"object","properties":{"ETag":{"type":"string","example":"vmanagemockwebexetag"},"config":{"$ref":"#/components/schemas/Configinfo"}}},"WidgetStatus":{"type":"object","properties":{"count":{"type":"number"},"name":{"type":"string"},"statusList":{"type":"array","items":{"$ref":"#/components/schemas/WidgetStatusStatusList"}}}},"WidgetStatusStatusList":{"type":"object","properties":{"count":{"type":"number"},"message":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"}}},"Widgets":{"type":"array","properties":{"empty":{"type":"boolean"}},"items":{"$ref":"#/components/schemas/CloudWidget"}},"Wifi":{"required":["name","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileParcel"},{"type":"object","properties":{"ssidConfigList":{"maxItems":4,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SSIDConfig"}},"guestWifi":{"$ref":"#/components/schemas/GuestWifi"},"corporateWifi":{"$ref":"#/components/schemas/CorporateWifi"},"advancedRadioSetting":{"$ref":"#/components/schemas/AdvancedRadioSetting"}}}]},"Schema2HubGeneratedSecurityprofileparceltypePost":{"oneOf":[{"$ref":"#/components/schemas/request_schema-114"},{"$ref":"#/components/schemas/request_schema-115"},{"$ref":"#/components/schemas/request_schema-116"},{"$ref":"#/components/schemas/request_schema-117"},{"$ref":"#/components/schemas/request_schema-118"},{"$ref":"#/components/schemas/request_schema-119"}]},"Schema2HubGeneratedSecurityprofileparceltypePut":{"oneOf":[{"$ref":"#/components/schemas/request_schema-120"},{"$ref":"#/components/schemas/request_schema-121"},{"$ref":"#/components/schemas/request_schema-122"},{"$ref":"#/components/schemas/request_schema-123"},{"$ref":"#/components/schemas/request_schema-124"},{"$ref":"#/components/schemas/request_schema-125"}]},"Schema2HubGeneratedPolicyobjectlisttypePost":{"oneOf":[{"$ref":"#/components/schemas/request_schema-126"},{"$ref":"#/components/schemas/request_schema-127"},{"$ref":"#/components/schemas/request_schema-128"},{"$ref":"#/components/schemas/request_schema-129"},{"$ref":"#/components/schemas/request_schema-130"},{"$ref":"#/components/schemas/request_schema-131"},{"$ref":"#/components/schemas/request_schema-132"},{"$ref":"#/components/schemas/request_schema-133"},{"$ref":"#/components/schemas/request_schema-134"},{"$ref":"#/components/schemas/request_schema-135"},{"$ref":"#/components/schemas/request_schema-136"},{"$ref":"#/components/schemas/request_schema-137"},{"$ref":"#/components/schemas/request_schema-138"},{"$ref":"#/components/schemas/request_schema-139"},{"$ref":"#/components/schemas/request_schema-140"},{"$ref":"#/components/schemas/request_schema-141"},{"$ref":"#/components/schemas/request_schema-142"},{"$ref":"#/components/schemas/request_schema-143"},{"$ref":"#/components/schemas/request_schema-144"},{"$ref":"#/components/schemas/request_schema-145"},{"$ref":"#/components/schemas/request_schema-146"},{"$ref":"#/components/schemas/request_schema-147"},{"$ref":"#/components/schemas/request_schema-148"},{"$ref":"#/components/schemas/request_schema-149"},{"$ref":"#/components/schemas/request_schema-150"},{"$ref":"#/components/schemas/request_schema-151"},{"$ref":"#/components/schemas/request_schema-152"},{"$ref":"#/components/schemas/request_schema-153"},{"$ref":"#/components/schemas/request_schema-154"},{"$ref":"#/components/schemas/request_schema-155"}]},"Schema2HubGeneratedPolicyobjectlisttypePut":{"oneOf":[{"$ref":"#/components/schemas/request_schema-156"},{"$ref":"#/components/schemas/request_schema-157"},{"$ref":"#/components/schemas/request_schema-158"},{"$ref":"#/components/schemas/request_schema-159"},{"$ref":"#/components/schemas/request_schema-160"},{"$ref":"#/components/schemas/request_schema-161"},{"$ref":"#/components/schemas/request_schema-162"},{"$ref":"#/components/schemas/request_schema-163"},{"$ref":"#/components/schemas/request_schema-164"},{"$ref":"#/components/schemas/request_schema-165"},{"$ref":"#/components/schemas/request_schema-166"},{"$ref":"#/components/schemas/request_schema-167"},{"$ref":"#/components/schemas/request_schema-168"},{"$ref":"#/components/schemas/request_schema-169"},{"$ref":"#/components/schemas/request_schema-140"},{"$ref":"#/components/schemas/request_schema-170"},{"$ref":"#/components/schemas/request_schema-171"},{"$ref":"#/components/schemas/request_schema-172"},{"$ref":"#/components/schemas/request_schema-144"},{"$ref":"#/components/schemas/request_schema-145"},{"$ref":"#/components/schemas/request_schema-146"},{"$ref":"#/components/schemas/request_schema-173"},{"$ref":"#/components/schemas/request_schema-174"},{"$ref":"#/components/schemas/request_schema-149"},{"$ref":"#/components/schemas/request_schema-150"},{"$ref":"#/components/schemas/request_schema-151"},{"$ref":"#/components/schemas/request_schema-175"},{"$ref":"#/components/schemas/request_schema-176"},{"$ref":"#/components/schemas/request_schema-177"},{"$ref":"#/components/schemas/request_schema-178"}]},"getListMobilityCliPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["cli"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["mobility"]}}}},"getSingleMobilityCliPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["cli"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["mobility"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListMobilityCliConfigPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-9"}}}}}},"getSingleMobilityCliConfigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-10"}}},"getListMobilityGlobalPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["global"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["mobility"]}}}},"getSingleMobilityGlobalPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["global"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["mobility"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListMobilityGlobalBasicPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-14"}}}}}},"getSingleMobilityGlobalBasicPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-15"}}},"getListMobilityGlobalQosPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-11"}}}}}},"getSingleMobilityGlobalQosPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-11"}}},"getListMobilityGlobalAaaserversPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-12"}}}}}},"getSingleMobilityGlobalAaaserversPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-13"}}},"getListMobilityGlobalCellularPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/CellularProfile"}}}}}},"getSingleMobilityGlobalCellularPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Cellular"}}},"getListMobilityGlobalEsimcellularPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-16"}}}}}},"getSingleMobilityGlobalEsimcellularPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-17"}}},"getListMobilityGlobalEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Ethernet"}}}}}},"getListMobilityGlobalLoggingPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-18"}}}}}},"getSingleMobilityGlobalLoggingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-19"}}},"getListMobilityGlobalNetworkprotocolPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/NetworkProtocol"}}}}}},"getSingleMobilityGlobalNetworkprotocolPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/NetworkProtocol"}}},"getListMobilityGlobalSecuritypolicyPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/SecurityPolicy"}}}}}},"getSingleMobilityGlobalSecuritypolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/SecurityPolicy"}}},"getListMobilityGlobalVpnPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-20"}}}}}},"getSingleMobilityGlobalVpnPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-21"}}},"getListMobilityGlobalWifiPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Wifi"}}}}}},"getSingleMobilityGlobalWifiPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Wifi"}}},"getListNfvirtualCliPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["cli"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["nfvirtual"]}}}},"getSingleNfvirtualCliPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["cli"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["nfvirtual"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getSingleNfvirtualCliConfigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-24"}}},"getListNfvirtualNetworksPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["networks"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["nfvirtual"]}}}},"getSingleNfvirtualNetworksPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["networks"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["nfvirtual"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getSingleNfvirtualNetworksOvsnetworkPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-25"}}},"getSingleNfvirtualNetworksLanPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-27"}}},"getSingleNfvirtualNetworksRoutesPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-30"}}},"getSingleNfvirtualNetworksSwitchPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-32"}}},"getSingleNfvirtualNetworksVnfAttributesPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-34"}}},"getSingleNfvirtualNetworksVnfAttributesVnfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-36"}}},"getSingleNfvirtualNetworksWanPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-38"}}},"getListNfvirtualSystemPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["system"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["nfvirtual"]}}}},"getSingleNfvirtualSystemPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["system"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["nfvirtual"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getSingleNfvirtualSystemAaaPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-40"}}},"getSingleNfvirtualSystemBannerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-42"}}},"getSingleNfvirtualSystemLoggingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-44"}}},"getSingleNfvirtualSystemNtpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-46"}}},"getSingleNfvirtualSystemSnmpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-48"}}},"getSingleNfvirtualSystemSystemSettingsPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-50"}}},"getListSdRoutingProfilePayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["profile"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getListSdRoutingCliPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["cli"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getSingleSdRoutingCliPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["cli"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdRoutingCliConfigPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-51"}}}}}},"getSingleSdRoutingCliConfigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-52"}}},"getListSdRoutingCliFullConfigPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-53"}}}}}},"getSingleSdRoutingCliFullConfigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-54"}}},"getListSdRoutingCliIosConfigPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-55"}}}}}},"getSingleSdRoutingCliIosConfigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-55"}}},"getListSdRoutingEmbeddedSecurityPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["embedded-security"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getSingleSdRoutingEmbeddedSecurityPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["embedded-security"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdRoutingEmbeddedSecurityPolicyPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-56"}}}}}},"getSingleSdRoutingEmbeddedSecurityPolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-57"}}},"getListSdRoutingEmbeddedSecurityUnifiedNgfirewallPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-58"}}}}}},"getSingleSdRoutingEmbeddedSecurityUnifiedNgfirewallPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-59"}}},"getListSdRoutingOtherCybervisionPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-60"}}}}}},"getSingleSdRoutingOtherCybervisionPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-60"}}},"getListSdRoutingServicePayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["service"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getSingleSdRoutingServicePayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["service"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdRoutingServiceDhcpServerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-61"}}}}}},"getSingleSdRoutingServiceDhcpServerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-62"}}},"getListSdRoutingServiceIpsecProfilePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-63"}}}}}},"getSingleSdRoutingServiceIpsecProfilePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-63"}}},"getListSdRoutingServiceIpv4AclPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-64"}}}}}},"getSingleSdRoutingServiceIpv4AclPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-64"}}},"getListSdRoutingServiceVrfLanMulticloudConnectionPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-65"}}}}}},"getSingleSdRoutingServiceVrfLanMulticloudConnectionPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-66"}}},"getListSdRoutingServiceObjecttrackerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-67"}}}}}},"getSingleSdRoutingServiceObjecttrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-67"}}},"getListSdRoutingServiceObjecttrackergroupPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-68"}}}}}},"getSingleSdRoutingServiceObjecttrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-68"}}},"getListSdRoutingServiceRoutePolicyPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-69"}}}}}},"getSingleSdRoutingServiceRoutePolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-69"}}},"getListSdRoutingServiceRoutingOspfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}}}}},"getSingleSdRoutingServiceRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}},"getListSdRoutingServiceRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}}}}},"getSingleSdRoutingServiceRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}},"getListSdRoutingServiceRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}}}}},"getSingleSdRoutingServiceRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}},"getListSdRoutingServiceVrfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-73"}}}}}},"getSingleSdRoutingServiceVrfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-73"}}},"getListSdRoutingServiceVrfRoutingBgpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}}}}},"getSingleSdRoutingServiceVrfRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}},"getListSdRoutingServiceVrfRoutingEigrpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-75"}}}}}},"getSingleSdRoutingServiceVrfRoutingEigrpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-75"}}},"getListSdRoutingServiceVrfLanDmvpnTunnelPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-76"}}}}}},"getSingleSdRoutingServiceVrfLanDmvpnTunnelPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-76"}}},"getListSdRoutingServiceVrfLanInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-77"}}}}}},"getSingleSdRoutingServiceVrfLanInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-77"}}},"getListSdRoutingServiceVrfInterfaceEthernetDhcpServerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-61"}}}},"getSingleSdRoutingServiceVrfInterfaceEthernetDhcpServerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-62"}}},"getListSdRoutingServiceVrfLanInterfaceIpsecPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-80"}}}}}},"getSingleSdRoutingServiceVrfLanInterfaceIpsecPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-80"}}},"getListSdRoutingServiceVrfVrfRoutingBgpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}}},"getSingleSdRoutingServiceVrfVrfRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}},"getListSdRoutingServiceVrfVrfRoutingEigrpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-75"}}}},"getSingleSdRoutingServiceVrfVrfRoutingEigrpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-75"}}},"getListSdRoutingServiceVrfRoutingOspfPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}}},"getSingleSdRoutingServiceVrfRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}},"getListSdRoutingServiceVrfRoutingOspfv3Ipv4Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}}},"getSingleSdRoutingServiceVrfRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}},"getListSdRoutingServiceVrfRoutingOspfv3Ipv6Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}}},"getSingleSdRoutingServiceVrfRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}},"getListSdRoutingSsePayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["sse"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getSingleSdRoutingSsePayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["sse"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdRoutingSseCiscoSsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-81"}}}}}},"getSingleSdRoutingSseCiscoSsePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-82"}}},"getListSdRoutingSystemPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["system"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getSingleSdRoutingSystemPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["system"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdRoutingSystemAaaSdRoutingPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-83"}}}}}},"getSingleSdRoutingSystemAaaSdRoutingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-83"}}},"getListSdRoutingSystemBannerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-84"}}}}}},"getSingleSdRoutingSystemBannerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-85"}}},"getListSdRoutingSystemCertificatePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-86"}}}}}},"getSingleSdRoutingSystemCertificatePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-86"}}},"getListSdRoutingSystemFlexiblePortSpeedPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-87"}}}}}},"getSingleSdRoutingSystemFlexiblePortSpeedPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-87"}}},"getListSdRoutingSystemGlobalPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-88"}}}}}},"getSingleSdRoutingSystemGlobalPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-89"}}},"getListSdRoutingSystemLoggingSdRoutingPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-90"}}}}}},"getSingleSdRoutingSystemLoggingSdRoutingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-90"}}},"getListSdRoutingSystemNtpSdRoutingPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-91"}}}}}},"getSingleSdRoutingSystemNtpSdRoutingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-91"}}},"getListSdRoutingSystemSnmpSdRoutingPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-92"}}}}}},"getSingleSdRoutingSystemSnmpSdRoutingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-92"}}},"getListSdRoutingTransportPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["transport"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]}}}},"getSingleSdRoutingTransportPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["transport"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sd-routing"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdRoutingTransportGlobalVrfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-93"}}}}}},"getSingleSdRoutingTransportGlobalVrfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-93"}}},"getListSdRoutingTransportGlobalVrfRoutingBgpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-94"}}}}}},"getSingleSdRoutingTransportGlobalVrfRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-94"}}},"getListSdRoutingTransportGlobalVrfWanInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-95"}}}}}},"getSingleSdRoutingTransportGlobalVrfWanInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-95"}}},"getListSdRoutingTransportGlobalVrfWanInterfaceIpsecPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-96"}}}}}},"getSingleSdRoutingTransportGlobalVrfWanInterfaceIpsecPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-96"}}},"getListSdRoutingTransportVrfWanMulticloudConnectionPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-97"}}}}}},"getSingleSdRoutingTransportVrfWanMulticloudConnectionPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-100"}}},"getListSdRoutingTransportGlobalVrfGlobalVrfRoutingBgpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}}},"getSingleSdRoutingTransportGlobalVrfGlobalVrfRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}},"getListSdRoutingTransportGlobalVrfRoutingOspfPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}}},"getSingleSdRoutingTransportGlobalVrfRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}},"getListSdRoutingTransportGlobalVrfRoutingOspfv3Ipv4Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}}},"getSingleSdRoutingTransportGlobalVrfRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}},"getListSdRoutingTransportGlobalVrfRoutingOspfv3Ipv6Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}}},"getSingleSdRoutingTransportGlobalVrfRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}},"getListSdRoutingTransportIpv4AclPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-64"}}}}}},"getSingleSdRoutingTransportIpv4AclPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-64"}}},"getListSdRoutingTransportManagementVrfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-98"}}}}}},"getSingleSdRoutingTransportManagementVrfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-98"}}},"getListSdRoutingTransportManagementVrfInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-99"}}}}}},"getSingleSdRoutingTransportManagementVrfInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-99"}}},"getListSdRoutingTransportObjecttrackerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-67"}}}}}},"getSingleSdRoutingTransportObjecttrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-67"}}},"getListSdRoutingTransportObjecttrackergroupPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-68"}}}}}},"getSingleSdRoutingTransportObjecttrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-68"}}},"getListSdRoutingTransportRoutePolicyPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-69"}}}}}},"getSingleSdRoutingTransportRoutePolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-69"}}},"getListSdRoutingTransportRoutingOspfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}}}}},"getSingleSdRoutingTransportRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}},"getListSdRoutingTransportRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}}}}},"getSingleSdRoutingTransportRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}},"getListSdRoutingTransportRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}}}}},"getSingleSdRoutingTransportRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}},"getListSdRoutingTransportVrfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-73"}}}}}},"getSingleSdRoutingTransportVrfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-73"}}},"getListSdRoutingTransportVrfRoutingBgpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}}}}},"getSingleSdRoutingTransportVrfRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}},"getListSdRoutingTransportVrfWanInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-101"}}}}}},"getSingleSdRoutingTransportVrfWanInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-101"}}},"getListSdRoutingTransportVrfWanInterfaceIpsecPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-102"}}}}}},"getSingleSdRoutingTransportVrfWanInterfaceIpsecPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-102"}}},"getListSdRoutingTransportVrfVrfRoutingBgpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}}},"getSingleSdRoutingTransportVrfVrfRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-74"}}},"getListSdRoutingTransportVrfRoutingOspfPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}}},"getSingleSdRoutingTransportVrfRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-70"}}},"getListSdRoutingTransportVrfRoutingOspfv3Ipv4Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}}},"getSingleSdRoutingTransportVrfRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-71"}}},"getListSdRoutingTransportVrfRoutingOspfv3Ipv6Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}}},"getSingleSdRoutingTransportVrfRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-72"}}},"getListSdwanProfilePayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["profile"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanApplicationPriorityQosPolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-104"}}},"getSingleSdwanApplicationPriorityTrafficPolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-106"}}},"getListSdwanCliPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["cli"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanCliPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["cli"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanCliConfigPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-107"}}}}}},"getSingleSdwanCliConfigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-108"}}},"getListSdwanDnsSecurityPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["dns-security"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanDnsSecurityPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["dns-security"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanDnsSecurityDnsPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-109"}}}}}},"getSingleSdwanDnsSecurityDnsPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-110"}}},"getListSdwanEmbeddedSecurityPolicyPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-56"}}}}}},"getSingleSdwanEmbeddedSecurityPolicyPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-57"}}},"getListSdwanEmbeddedSecurityUnifiedNgfirewallPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-58"}}}}}},"getSingleSdwanEmbeddedSecurityUnifiedNgfirewallPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-59"}}},"getListSdwanOtherPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["other"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanOtherPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["other"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanOtherThousandeyesPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-111"}}}}}},"getSingleSdwanOtherThousandeyesPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-112"}}},"getListSdwanOtherUcsePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-113"}}}}}},"getSingleSdwanOtherUcsePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-113"}}},"getListSdwanPolicyObjectUnifiedAdvancedInspectionProfilePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Schema2HubGeneratedSecurityprofileparceltypePost"}}}}}},"getSingleSdwanPolicyObjectUnifiedAdvancedInspectionProfilePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Schema2HubGeneratedSecurityprofileparceltypePut"}}},"getListSdwanPolicyObjectSecurityDataIpPrefixPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Schema2HubGeneratedPolicyobjectlisttypePost"}}}}}},"getSingleSdwanPolicyObjectSecurityDataIpPrefixPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/Schema2HubGeneratedPolicyobjectlisttypePut"}}},"getListSdwanServicePayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["service"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanServicePayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["service"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanServiceDhcpServerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-180"}}}}}},"getSingleSdwanServiceDhcpServerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-181"}}},"getListSdwanServiceLanVpnInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-184"}}}}}},"getSingleSdwanServiceLanVpnInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-185"}}},"getListSdwanServiceLanVpnInterfaceGrePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-188"}}}}}},"getSingleSdwanServiceLanVpnInterfaceGrePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-188"}}},"getListSdwanServiceLanVpnInterfaceIpsecPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-189"}}}}}},"getSingleSdwanServiceLanVpnInterfaceIpsecPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-189"}}},"getListSdwanServiceLanVpnInterfaceSviPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-190"}}}}}},"getSingleSdwanServiceLanVpnInterfaceSviPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-191"}}},"getListSdwanServiceLanVpnPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-182"}}}}}},"getSingleSdwanServiceLanVpnPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-183"}}},"getListSdwanServiceRoutingBgpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-192"}}}}}},"getSingleSdwanServiceRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-192"}}},"getListSdwanServiceRoutingMulticastPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-194"}}}}}},"getSingleSdwanServiceRoutingMulticastPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-194"}}},"getListSdwanServiceSwitchportPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-198"}}}}}},"getSingleSdwanServiceSwitchportPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-199"}}},"getListSdwanServiceTrackerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-186"}}}}}},"getSingleSdwanServiceTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-186"}}},"getListSdwanServiceTrackergroupPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}}}}},"getSingleSdwanServiceTrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}},"getListSdwanServiceWirelesslanPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-200"}}}}}},"getSingleSdwanServiceWirelesslanPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-201"}}},"getListSdwanServiceAppqoePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-179"}}}}}},"getSingleSdwanServiceAppqoePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-179"}}},"getListSdwanServiceLanVpnInterfaceEthernetDhcpServerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-180"}}}},"getSingleSdwanServiceLanVpnInterfaceEthernetDhcpServerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-181"}}},"getListSdwanServiceLanVpnInterfaceEthernetTrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-186"}}}},"getSingleSdwanServiceLanVpnInterfaceEthernetTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-186"}}},"getListSdwanServiceLanVpnInterfaceEthernetTrackergroupPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}}},"getSingleSdwanServiceLanVpnInterfaceEthernetTrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}},"getListSdwanServiceLanVpnInterfaceIpsecDhcpServerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-180"}}}},"getSingleSdwanServiceLanVpnInterfaceIpsecDhcpServerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-181"}}},"getListSdwanServiceLanVpnInterfaceSviDhcpServerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-180"}}}},"getSingleSdwanServiceLanVpnInterfaceSviDhcpServerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-181"}}},"getListSdwanServiceLanVpnRoutingBgpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-192"}}}},"getSingleSdwanServiceLanVpnRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-192"}}},"getListSdwanServiceLanVpnRoutingEigrpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-193"}}}},"getSingleSdwanServiceLanVpnRoutingEigrpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-193"}}},"getListSdwanServiceLanVpnRoutingMulticastPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-194"}}}},"getSingleSdwanServiceLanVpnRoutingMulticastPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-194"}}},"getListSdwanServiceLanVpnRoutingOspfPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}}},"getSingleSdwanServiceLanVpnRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}},"getListSdwanServiceLanVpnRoutingOspfv3Ipv4Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}}},"getSingleSdwanServiceLanVpnRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}},"getListSdwanServiceLanVpnRoutingOspfv3Ipv6Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}}},"getSingleSdwanServiceLanVpnRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}},"getListSdwanServiceRoutingEigrpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-193"}}}}}},"getSingleSdwanServiceRoutingEigrpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-193"}}},"getListSdwanServiceRoutingOspfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}}}}},"getSingleSdwanServiceRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}},"getListSdwanServiceRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}}}}},"getSingleSdwanServiceRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}},"getListSdwanServiceRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}}}}},"getSingleSdwanServiceRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}},"getListSdwanSigSecurityPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["sig-security"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanSigSecurityPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["sig-security"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanSigSecuritySigPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-202"}}}}}},"getSingleSdwanSigSecuritySigPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-203"}}},"getListSdwanSystemPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["system"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanSystemPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["system"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanSystemAaaPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-204"}}}}}},"getSingleSdwanSystemAaaPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-205"}}},"getListSdwanSystemBannerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-84"}}}}}},"getSingleSdwanSystemBannerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-85"}}},"getListSdwanSystemBasicPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-206"}}}}}},"getSingleSdwanSystemBasicPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-207"}}},"getListSdwanSystemBfdPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-208"}}}}}},"getSingleSdwanSystemBfdPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-209"}}},"getListSdwanSystemGlobalPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-210"}}}}}},"getSingleSdwanSystemGlobalPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-211"}}},"getListSdwanSystemLoggingPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-212"}}}}}},"getSingleSdwanSystemLoggingPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-213"}}},"getListSdwanSystemMrfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-214"}}}}}},"getSingleSdwanSystemMrfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-214"}}},"getListSdwanSystemNtpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-215"}}}}}},"getSingleSdwanSystemNtpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-216"}}},"getListSdwanSystemOmpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-217"}}}}}},"getSingleSdwanSystemOmpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-218"}}},"getListSdwanSystemSnmpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-220"}}}}}},"getSingleSdwanSystemSnmpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-221"}}},"getListSdwanSystemSecurityPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-219"}}}}}},"getSingleSdwanSystemSecurityPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-219"}}},"getListSdwanTransportPayload":{"type":"array","items":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"profileType":{"type":"string","enum":["transport"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]}}}},"getSingleSdwanTransportPayload":{"type":"object","properties":{"profileId":{"$ref":"#/components/schemas/uuidDef"},"profileType":{"type":"string","enum":["transport"]},"profileName":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"type":"string","enum":["sdwan"]},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"associatedProfileParcels":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"payload":{"type":"object"},"subparcels":{"type":"array","minItems":0,"items":{"type":"object"}}}}}}},"getListSdwanTransportCellularControllerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-222"}}}}}},"getSingleSdwanTransportCellularControllerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-223"}}},"getListSdwanTransportCellularProfilePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-224"}}}}}},"getSingleSdwanTransportCellularProfilePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-225"}}},"getListSdwanTransportIpv6TrackerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-232"}}}}}},"getSingleSdwanTransportIpv6TrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-233"}}},"getListSdwanTransportIpv6TrackergroupPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-234"}}}}}},"getSingleSdwanTransportIpv6TrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-234"}}},"getListSdwanTransportManagementVpnInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-237"}}}}}},"getSingleSdwanTransportManagementVpnInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-238"}}},"getListSdwanTransportManagementVpnPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-235"}}}}}},"getSingleSdwanTransportManagementVpnPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-236"}}},"getListSdwanTransportRoutingBgpPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-239"}}}}}},"getSingleSdwanTransportRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-239"}}},"getListSdwanTransportT1E1ControllerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-240"}}}}}},"getSingleSdwanTransportT1E1ControllerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-240"}}},"getListSdwanTransportTrackerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}}}}},"getSingleSdwanTransportTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}},"getListSdwanTransportTrackergroupPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}}}}},"getSingleSdwanTransportTrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}},"getListSdwanTransportWanVpnInterfaceCellularPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-244"}}}}}},"getSingleSdwanTransportWanVpnInterfaceCellularPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-245"}}},"getListSdwanTransportWanVpnInterfaceEthernetPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-246"}}}}}},"getSingleSdwanTransportWanVpnInterfaceEthernetPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-247"}}},"getListSdwanTransportWanVpnInterfaceGrePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-248"}}}}}},"getSingleSdwanTransportWanVpnInterfaceGrePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-248"}}},"getListSdwanTransportWanVpnInterfaceIpsecPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-249"}}}}}},"getSingleSdwanTransportWanVpnInterfaceIpsecPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-249"}}},"getListSdwanTransportWanVpnInterfaceSerialPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-250"}}}}}},"getSingleSdwanTransportWanVpnInterfaceSerialPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-250"}}},"getListSdwanTransportWanVpnPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-242"}}}}}},"getSingleSdwanTransportWanVpnPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-243"}}},"getListSdwanTransportCellularControllerCellularProfilePayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-224"}}}},"getSingleSdwanTransportCellularControllerCellularProfilePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-225"}}},"getListSdwanTransportCellularControllerGpsPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-226"}}}},"getSingleSdwanTransportCellularControllerGpsPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-227"}}},"getListSdwanTransportEsimcellularControllerPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-228"}}}}}},"getSingleSdwanTransportEsimcellularControllerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-229"}}},"getListSdwanTransportEsimcellularProfilePayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-230"}}}}}},"getSingleSdwanTransportEsimcellularProfilePayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-231"}}},"getListSdwanTransportGpsPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-226"}}}}}},"getSingleSdwanTransportGpsPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-227"}}},"getListSdwanTransportRoutingOspfPayload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}}}}},"getSingleSdwanTransportRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}},"getListSdwanTransportRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}}}}},"getSingleSdwanTransportRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}},"getListSdwanTransportRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}}}}},"getSingleSdwanTransportRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}},"getListSdwanTransportWanVpnInterfaceCellularIpv6TrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-232"}}}},"getSingleSdwanTransportWanVpnInterfaceCellularIpv6TrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-233"}}},"getListSdwanTransportWanVpnInterfaceCellularIpv6TrackergroupPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-234"}}}},"getSingleSdwanTransportWanVpnInterfaceCellularIpv6TrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-234"}}},"getListSdwanTransportWanVpnInterfaceCellularTrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}}},"getSingleSdwanTransportWanVpnInterfaceCellularTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}},"getListSdwanTransportWanVpnInterfaceEthernetIpv6TrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-232"}}}},"getSingleSdwanTransportWanVpnInterfaceEthernetIpv6TrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-233"}}},"getListSdwanTransportWanVpnInterfaceEthernetIpv6TrackergroupPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-234"}}}},"getSingleSdwanTransportWanVpnInterfaceEthernetIpv6TrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-234"}}},"getListSdwanTransportWanVpnInterfaceEthernetTrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}}},"getSingleSdwanTransportWanVpnInterfaceEthernetTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}},"getListSdwanTransportWanVpnInterfaceEthernetTrackergroupPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}}},"getSingleSdwanTransportWanVpnInterfaceEthernetTrackergroupPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-187"}}},"getListSdwanTransportWanVpnInterfaceGreTrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}}},"getSingleSdwanTransportWanVpnInterfaceGreTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}},"getListSdwanTransportWanVpnInterfaceIpsecTrackerPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}}},"getSingleSdwanTransportWanVpnInterfaceIpsecTrackerPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-241"}}},"getListSdwanTransportWanVpnRoutingBgpPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-239"}}}},"getSingleSdwanTransportWanVpnRoutingBgpPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-239"}}},"getListSdwanTransportWanVpnRoutingOspfPayload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}}},"getSingleSdwanTransportWanVpnRoutingOspfPayload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-195"}}},"getListSdwanTransportWanVpnRoutingOspfv3Ipv4Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}}},"getSingleSdwanTransportWanVpnRoutingOspfv3Ipv4Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-196"}}},"getListSdwanTransportWanVpnRoutingOspfv3Ipv6Payload":{"type":"array","items":{"type":"object","minItems":0,"properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}}},"getSingleSdwanTransportWanVpnRoutingOspfv3Ipv6Payload":{"type":"object","properties":{"parcelId":{"$ref":"#/components/schemas/uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"$ref":"#/components/schemas/request_schema-197"}}},"cgFpPpNameDef":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"solutionDef":{"type":"string","enum":["mobility","sdwan","sd-routing","nfvirtual","service-insertion","cellulargateway"]},"unsupportedFeaturesEnumDef":{"type":"string","enum":["wan/vpn/interface/gre","wan/vpn/interface/ethernet","wan/vpn/interface/cellular","wan/vpn/interface/ipsec","wan/vpn/interface/serial","wan/vpn/interface/dsl-pppoa","wan/vpn/interface/dsl-pppoe","wan/vpn/interface/dsl-ipoe","routing/ospf","lan/vpn/interface/ethernet","lan/vpn/interface/svi","lan/vpn/interface/ipsec","lan/vpn","wan/multicloud-connection","lan/multicloud-connection","vrf/wan/interface/gre","vrf/wan/interface/ethernet","vrf/wan/interface/ipsec","vrf/lan/interface/ethernet","vrf/lan/interface/ipsec","vrf","vrf/wan/multicloud-connection","vrf/lan/multicloud-connection","vrf/routing/bgp","routing/bgp","route-policy"]},"topologyDevicePropertiesDef":{"properties":{"criteria":{"type":"object","oneOf":[{"properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}},"required":["attribute","value"],"additionalProperties":false}]},"unsupportedFeatures":{"type":"array","uniqueItems":true,"items":{"properties":{"parcelType":{"$ref":"#/components/schemas/unsupportedFeaturesEnumDef"},"parcelId":{"type":"string","format":"uuid"}},"required":["parcelType","parcelId"],"additionalProperties":false},"additionalProperties":false}},"required":["criteria"],"additionalProperties":false},"topologyDef":{"type":"object","properties":{"devices":{"type":"array","description":"list of devices in a site","minItems":1,"maxItems":20,"uniqueItems":true,"items":{"type":"object","$ref":"#/components/schemas/topologyDevicePropertiesDef"},"additionalProperties":false},"siteDevices":{"type":"integer","minimum":1,"maximum":20}},"required":["devices"],"additionalProperties":false},"profileIdObjDef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"uuidDef":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"fromConfigGroupDef":{"oneOf":[{"properties":{"copy":{"$ref":"#/components/schemas/uuidDef"}},"required":["copy"],"additionalProperties":false}]},"request_schema":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/post/request_schema.json","title":"Config Group POST Request schema","description":"Config Group POST Request schema ","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"source":{"type":"string","enum":["retail_workflow","custom_workflow","nfvirtual_workflow","equinix_workflow"]},"solution":{"$ref":"#/components/schemas/solutionDef"},"topology":{"type":"object","description":"list of device provisioning rules that belongs to the config group topology","$ref":"#/components/schemas/topologyDef"},"profiles":{"type":"array","description":"list of profile ids that belongs to the config group","items":{"type":"object","$ref":"#/components/schemas/profileIdObjDef"},"uniqueItems":true,"additionalProperties":false},"fromConfigGroup":{"type":"object","description":"from another config group","$ref":"#/components/schemas/fromConfigGroupDef"}},"dependencies":{"profiles":{"not":{"required":["fromConfigGroup"]}},"fromConfigGroup":{"not":{"required":["profiles"]}}},"required":["name","description","solution"],"additionalProperties":false,"$defs":{"profileIdObjDef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"fromConfigGroupDef":{"oneOf":[{"properties":{"copy":{"$ref":"#/components/schemas/uuidDef"}},"required":["copy"],"additionalProperties":false}]},"topologyDef":{"type":"object","properties":{"devices":{"type":"array","description":"list of devices in a site","minItems":1,"maxItems":20,"uniqueItems":true,"items":{"type":"object","$ref":"#/components/schemas/topologyDevicePropertiesDef"},"additionalProperties":false},"siteDevices":{"type":"integer","minimum":1,"maximum":20}},"required":["devices"],"additionalProperties":false},"topologyDevicePropertiesDef":{"properties":{"criteria":{"type":"object","oneOf":[{"properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}},"required":["attribute","value"],"additionalProperties":false}]},"unsupportedFeatures":{"type":"array","uniqueItems":true,"items":{"properties":{"parcelType":{"$ref":"#/components/schemas/unsupportedFeaturesEnumDef"},"parcelId":{"type":"string","format":"uuid"}},"required":["parcelType","parcelId"],"additionalProperties":false},"additionalProperties":false}},"required":["criteria"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request api schema for config group","mandatoryProfileTypes":{"description":"This object specifies the mandatory profiles for each solution under config group.","mobility":["mobility"],"sdwan":["system","transport"],"nfvirtual":["system"]},"examples":{"CEDGE-ConfigGroup1-NY":{"value":{"name":"CEDGE-ConfigGroup1-NY","description":"CEDGE Config Group 1 for devices at site NY","solution":"sdwan","profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]}},"AON-ConfigGroup1-SF":{"value":{"name":"AON-ConfigGroup1-SF","description":"AON Config Group 1 for devices at site SF","solution":"mobility"}},"CEDGE-ConfigGroup2-DualDeviceSiteDeployment":{"value":{"name":"CEDGE-ConfigGroup2-DualDeviceSiteDeployment","description":"CEDGE Config Group 2 for Dual Device Site Deployment","solution":"sdwan","topology":{"devices":[{"criteria":{"attribute":"tag","value":"EdgeDevice_01"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]},{"criteria":{"attribute":"tag","value":"EdgeDevice_02"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FFBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FGBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FMBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]}],"siteDevices":2},"profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]}},"NFVIRTUAL-ConfigGroup1-SF":{"value":{"name":"NFVIRTUAL-ConfigGroup1-SF","description":"NFVIRTUAL Config Group 1 for devices at site SF","solution":"nfvirtual","profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"}]}},"CEDGE-ConfigGroup1-COPY":{"value":{"name":"CEDGE-ConfigGroup1-COPY","description":"Copy Config Group from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99","solution":"sdwan","fromConfigGroup":{"copy":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"}}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/post/request_schema.json","title":"Config Group POST Request schema","description":"Config Group POST Request schema ","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"source":{"type":"string","enum":["retail_workflow","custom_workflow","nfvirtual_workflow","equinix_workflow"]},"solution":{"type":"string","enum":["mobility","sdwan","sd-routing","nfvirtual","service-insertion","cellulargateway"]},"topology":{"type":"object","properties":{"devices":{"type":"array","description":"list of devices in a site","minItems":1,"maxItems":20,"uniqueItems":true,"items":{"properties":{"criteria":{"type":"object","oneOf":[{"properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}},"required":["attribute","value"],"additionalProperties":false}]},"unsupportedFeatures":{"type":"array","uniqueItems":true,"items":{"properties":{"parcelType":{"type":"string","enum":["wan/vpn/interface/gre","wan/vpn/interface/ethernet","wan/vpn/interface/cellular","wan/vpn/interface/ipsec","wan/vpn/interface/serial","wan/vpn/interface/dsl-pppoa","wan/vpn/interface/dsl-pppoe","wan/vpn/interface/dsl-ipoe","routing/ospf","lan/vpn/interface/ethernet","lan/vpn/interface/svi","lan/vpn/interface/ipsec","lan/vpn","wan/multicloud-connection","lan/multicloud-connection","vrf/wan/interface/gre","vrf/wan/interface/ethernet","vrf/wan/interface/ipsec","vrf/lan/interface/ethernet","vrf/lan/interface/ipsec","vrf","vrf/wan/multicloud-connection","vrf/lan/multicloud-connection","vrf/routing/bgp","routing/bgp","route-policy"]},"parcelId":{"type":"string","format":"uuid"}},"required":["parcelType","parcelId"],"additionalProperties":false},"additionalProperties":false}},"required":["criteria"],"additionalProperties":false},"additionalProperties":false},"siteDevices":{"type":"integer","minimum":1,"maximum":20}},"required":["devices"],"additionalProperties":false},"profiles":{"type":"array","description":"list of profile ids that belongs to the config group","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"uniqueItems":true,"additionalProperties":false},"fromConfigGroup":{"oneOf":[{"properties":{"copy":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"}},"required":["copy"],"additionalProperties":false}]},"documentation":{"description":"This is the documentation for POST request api schema for config group","mandatoryProfileTypes":{"description":"This object specifies the mandatory profiles for each solution under config group.","mobility":["mobility"],"sdwan":["system","transport"],"nfvirtual":["system"]},"examples":[{"name":"CEDGE-ConfigGroup1-NY","description":"CEDGE Config Group 1 for devices at site NY","solution":"sdwan","profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]},{"name":"AON-ConfigGroup1-SF","description":"AON Config Group 1 for devices at site SF","solution":"mobility"},{"name":"CEDGE-ConfigGroup2-DualDeviceSiteDeployment","description":"CEDGE Config Group 2 for Dual Device Site Deployment","solution":"sdwan","topology":{"devices":[{"criteria":{"attribute":"tag","value":"EdgeDevice_01"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]},{"criteria":{"attribute":"tag","value":"EdgeDevice_02"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FFBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FGBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FMBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]}],"siteDevices":2},"profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]},{"name":"NFVIRTUAL-ConfigGroup1-SF","description":"NFVIRTUAL Config Group 1 for devices at site SF","solution":"nfvirtual","profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"}]},{"name":"CEDGE-ConfigGroup1-COPY","description":"Copy Config Group from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99","solution":"sdwan","fromConfigGroup":{"copy":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"}}]}},"dependencies":{"profiles":{"not":{"required":["fromConfigGroup"]}},"fromConfigGroup":{"not":{"required":["profiles"]}}},"required":["name","description","solution"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"profileObjDef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"profileType":{"type":"string","enum":["global"]}},"required":["id","profileType"],"additionalProperties":false},"response_schema":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/post/response_schema.json","title":"Config Group POST Response schema","description":"Config Group POST Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"profiles":{"type":"array","description":"(Optional - only applicable for AON) List of profile ids that belongs to the config group","items":{"type":"object","$ref":"#/components/schemas/profileObjDef"}}},"required":["id"],"additionalProperties":false,"$defs":{"profileObjDef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"profileType":{"type":"string","enum":["global"]}},"required":["id","profileType"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST response schema for config group.","mobility":"For Mobility the response will include the list of profiles with id and type. For now its a single profile created internally \"global\"","sdwan":"For SDWAN the response will not include any list of profiles","examples":{"example_1":{"value":{"id":"3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac"}},"example_2":{"value":{"id":"5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060","profiles":[{"id":"002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6","profileType":"global"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/post/response_schema.json","title":"Config Group POST Response schema","description":"Config Group POST Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"profiles":{"type":"array","description":"(Optional - only applicable for AON) List of profile ids that belongs to the config group","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"profileType":{"type":"string","enum":["global"]}},"required":["id","profileType"],"additionalProperties":false}},"documentation":{"description":"This is the documentation for POST response schema for config group.","mobility":"For Mobility the response will include the list of profiles with id and type. For now its a single profile created internally \"global\"","sdwan":"For SDWAN the response will not include any list of profiles","examples":[{"id":"3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac"},{"id":"5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060","profiles":[{"id":"002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6","profileType":"global"}]}]}},"required":["id"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-2":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/put/request_schema.json","title":"Config Group PUT Request schema","description":"Config Group PUT Request schema ","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"solution":{"$ref":"#/components/schemas/solutionDef"},"topology":{"type":"object","description":"list of device provisioning rules that belongs to the config group topology","$ref":"#/components/schemas/topologyDef"},"profiles":{"type":"array","description":"list of profile ids that belongs to the config group","items":{"type":"object","$ref":"#/components/schemas/profileIdObjDef"},"uniqueItems":true,"additionalProperties":false}},"required":["name","description","solution"],"additionalProperties":false,"$defs":{"profileIdObjDef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"topologyDef":{"type":"object","properties":{"devices":{"type":"array","description":"list of devices in a site","minItems":1,"maxItems":20,"uniqueItems":true,"items":{"type":"object","$ref":"#/components/schemas/topologyDevicePropertiesDef"},"additionalProperties":false},"siteDevices":{"type":"integer","minimum":1,"maximum":20}},"required":["devices"],"additionalProperties":false},"topologyDevicePropertiesDef":{"properties":{"criteria":{"type":"object","oneOf":[{"properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}},"required":["attribute","value"],"additionalProperties":false}]},"unsupportedFeatures":{"type":"array","uniqueItems":true,"items":{"properties":{"parcelType":{"$ref":"#/components/schemas/unsupportedFeaturesEnumDef"},"parcelId":{"type":"string","format":"uuid"}},"required":["parcelType","parcelId"],"additionalProperties":false},"additionalProperties":false}},"required":["criteria"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request api schema for config group","mandatoryProfileTypes":{"description":"This object specifies the mandatory profiles for each solution under config group.","mobility":["mobility"],"sdwan":["system","transport"],"nfvirtual":["system"]},"examples":{"CEDGE-ConfigGroup1-NY":{"value":{"name":"CEDGE-ConfigGroup1-NY","description":"CEDGE Config Group 1 for devices at site NY","solution":"sdwan","profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]}},"AON-ConfigGroup1-SF":{"value":{"name":"AON-ConfigGroup1-SF","description":"AON Config Group 1 for devices at site SF","solution":"mobility"}},"CEDGE-ConfigGroup2-DualDeviceSiteDeployment":{"value":{"name":"CEDGE-ConfigGroup2-DualDeviceSiteDeployment","description":"CEDGE Config Group 2 for Dual Device Site Deployment","solution":"sdwan","topology":{"devices":[{"criteria":{"attribute":"tag","value":"EdgeDevice_01"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]},{"criteria":{"attribute":"tag","value":"EdgeDevice_02"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FFBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FGBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FMBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]}],"siteDevices":2},"profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/put/request_schema.json","title":"Config Group PUT Request schema","description":"Config Group PUT Request schema ","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"solution":{"type":"string","enum":["mobility","sdwan","sd-routing","nfvirtual","service-insertion","cellulargateway"]},"topology":{"type":"object","properties":{"devices":{"type":"array","description":"list of devices in a site","minItems":1,"maxItems":20,"uniqueItems":true,"items":{"properties":{"criteria":{"type":"object","oneOf":[{"properties":{"attribute":{"type":"string","enum":["tag"]},"value":{"type":"string"}},"required":["attribute","value"],"additionalProperties":false}]},"unsupportedFeatures":{"type":"array","uniqueItems":true,"items":{"properties":{"parcelType":{"type":"string","enum":["wan/vpn/interface/gre","wan/vpn/interface/ethernet","wan/vpn/interface/cellular","wan/vpn/interface/ipsec","wan/vpn/interface/serial","wan/vpn/interface/dsl-pppoa","wan/vpn/interface/dsl-pppoe","wan/vpn/interface/dsl-ipoe","routing/ospf","lan/vpn/interface/ethernet","lan/vpn/interface/svi","lan/vpn/interface/ipsec","lan/vpn","wan/multicloud-connection","lan/multicloud-connection","vrf/wan/interface/gre","vrf/wan/interface/ethernet","vrf/wan/interface/ipsec","vrf/lan/interface/ethernet","vrf/lan/interface/ipsec","vrf","vrf/wan/multicloud-connection","vrf/lan/multicloud-connection","vrf/routing/bgp","routing/bgp","route-policy"]},"parcelId":{"type":"string","format":"uuid"}},"required":["parcelType","parcelId"],"additionalProperties":false},"additionalProperties":false}},"required":["criteria"],"additionalProperties":false},"additionalProperties":false},"siteDevices":{"type":"integer","minimum":1,"maximum":20}},"required":["devices"],"additionalProperties":false},"profiles":{"type":"array","description":"list of profile ids that belongs to the config group","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false},"uniqueItems":true,"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request api schema for config group","mandatoryProfileTypes":{"description":"This object specifies the mandatory profiles for each solution under config group.","mobility":["mobility"],"sdwan":["system","transport"],"nfvirtual":["system"]},"examples":[{"name":"CEDGE-ConfigGroup1-NY","description":"CEDGE Config Group 1 for devices at site NY","solution":"sdwan","profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]},{"name":"AON-ConfigGroup1-SF","description":"AON Config Group 1 for devices at site SF","solution":"mobility"},{"name":"CEDGE-ConfigGroup2-DualDeviceSiteDeployment","description":"CEDGE Config Group 2 for Dual Device Site Deployment","solution":"sdwan","topology":{"devices":[{"criteria":{"attribute":"tag","value":"EdgeDevice_01"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]},{"criteria":{"attribute":"tag","value":"EdgeDevice_02"},"unsupportedFeatures":[{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FFBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEE"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FGBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEF"},{"parcelType":"wan/vpn/interface/ethernet","parcelId":"FMBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FEG"}]}],"siteDevices":2},"profiles":[{"id":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED"},{"id":"4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4"},{"id":"4C56e3c3-C67F-Cf66-d02f-8c666bd005CC"}]}]}},"required":["name","description","solution"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"response_schema-2":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/put/response_schema.json","title":"Config Group PUT Response schema","description":"Config Group PUT Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"profiles":{"type":"array","description":"(Optional - only applicable for AON) List of profile ids that belongs to the config group","items":{"type":"object","$ref":"#/components/schemas/profileObjDef"}}},"required":["id"],"additionalProperties":false,"$defs":{"profileObjDef":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"profileType":{"type":"string","enum":["global"]}},"required":["id","profileType"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT response schema for config group.","mobility":"For Mobility the response will include the list of profiles with id and type. For now its a single profile created internally \"global\"","sdwan":"For SDWAN the response will not include any list of profiles","examples":{"example_1":{"value":{"id":"3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac"}},"example_2":{"value":{"id":"5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060","profiles":[{"id":"002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6","profileType":"global"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/put/response_schema.json","title":"Config Group PUT Response schema","description":"Config Group PUT Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"profiles":{"type":"array","description":"(Optional - only applicable for AON) List of profile ids that belongs to the config group","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"profileType":{"type":"string","enum":["global"]}},"required":["id","profileType"],"additionalProperties":false}},"documentation":{"description":"This is the documentation for PUT response schema for config group.","mobility":"For Mobility the response will include the list of profiles with id and type. For now its a single profile created internally \"global\"","sdwan":"For SDWAN the response will not include any list of profiles","examples":[{"id":"3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac"},{"id":"5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060","profiles":[{"id":"002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6","profileType":"global"}]}]}},"required":["id"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"response_schema-3":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/associate/get/response_schema.json","title":"Config Group Associate GET response","description":"Schema for the response of a GET request to associate a config group","type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the device","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"site-name":{"type":"string","description":"Name of the site"},"host-name":{"type":"string","description":"Host name of the device"},"site-id":{"type":"string","description":"Identifier for the site"},"deviceModel":{"type":"string","description":"Model of the device"},"tags":{"type":"array","description":"Tags associated with the device","items":{"type":"string"}},"device-lock":{"type":"string","description":"Indicates if the device is locked"},"addedByRule":{"type":"boolean","description":"Indicates if the device was added by a rule"},"configStatusMessage":{"type":"string","description":"Configuration status message"},"deviceIP":{"type":"string","description":"IP address of the device","format":"ipv4"},"configGroupLastUpdatedOn":{"type":"string","description":"Timestamp of the last update to the config group","format":"date-time"},"unsupportedFeatures":{"type":"array","description":"List of unsupported features","items":{"type":"string"}},"hierarchyNamePath":{"type":"string","description":"Hierarchy name path"},"hierarchyTypePath":{"type":"string","description":"Hierarchy type path"},"configGroupUpToDate":{"type":"string","description":"Indicates if the config group is up to date"}},"required":["id","site-name","host-name","site-id","deviceModel","tags","device-lock","addedByRule","configStatusMessage","deviceIP","configGroupLastUpdatedOn","unsupportedFeatures","hierarchyNamePath","hierarchyTypePath","configGroupUpToDate"]}}},"required":["devices"],"additionalProperties":false},"deviceIdDef":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"request_schema-3":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/associate/put/request_schema.json","title":"Config Group Associate Put Request schema","description":"Config Group Associate Put Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be associated with","items":{"type":"object","$ref":"#/components/schemas/deviceIdDef"},"uniqueItems":true,"additionalProperties":false}},"required":["devices"],"additionalProperties":false,"$defs":{"deviceIdDef":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for associate PUT API request schema for config group.","examples":{"example_1":{"value":{"devices":[{"id":"C8K-bee4a662-2a65-4b45-872a-b501bc5a465d"},{"id":"C8K-knt4aui2-2a65-4b45-872a-b501bc5a465d"}]}},"example_2":{"value":{"devices":[{"id":"C8K-iuvbubb2-2a65-4b45-872a-86987buh24ss"},{"id":"C8K-ad1235hb-13se-kjbi-421v-86987buh24ss"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/associate/put/request_schema.json","title":"Config Group Associate Put Request schema","description":"Config Group Associate Put Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be associated with","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"uniqueItems":true,"additionalProperties":false},"documentation":{"description":"This is the documentation for associate PUT API request schema for config group.","examples":[{"devices":[{"id":"C8K-bee4a662-2a65-4b45-872a-b501bc5a465d"},{"id":"C8K-knt4aui2-2a65-4b45-872a-b501bc5a465d"}]},{"devices":[{"id":"C8K-iuvbubb2-2a65-4b45-872a-86987buh24ss"},{"id":"C8K-ad1235hb-13se-kjbi-421v-86987buh24ss"}]}]}},"required":["devices"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-4":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/associate/post/request_schema.json","title":"Config Group Associate Post Request schema","description":"Config Group Associate Post Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be associated with","items":{"type":"object","$ref":"#/components/schemas/deviceIdDef"},"uniqueItems":true,"minItems":1,"additionalProperties":false}},"required":["devices"],"additionalProperties":false,"$defs":{"deviceIdDef":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for associate POST API request schema for config group.","examples":{"example_1":{"value":{"devices":[{"id":"C8K-bee4a662-2a65-4b45-872a-b501bc5a465d"},{"id":"C8K-knt4aui2-2a65-4b45-872a-b501bc5a465d"}]}},"example_2":{"value":{"devices":[{"id":"C8K-iuvbubb2-2a65-4b45-872a-86987buh24ss"},{"id":"C8K-ad1235hb-13se-kjbi-421v-86987buh24ss"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/associate/post/request_schema.json","title":"Config Group Associate Post Request schema","description":"Config Group Associate Post Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be associated with","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"uniqueItems":true,"minItems":1,"additionalProperties":false},"documentation":{"description":"This is the documentation for associate POST API request schema for config group.","examples":[{"devices":[{"id":"C8K-bee4a662-2a65-4b45-872a-b501bc5a465d"},{"id":"C8K-knt4aui2-2a65-4b45-872a-b501bc5a465d"}]},{"devices":[{"id":"C8K-iuvbubb2-2a65-4b45-872a-86987buh24ss"},{"id":"C8K-ad1235hb-13se-kjbi-421v-86987buh24ss"}]}]}},"required":["devices"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-5":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/associate/delete/request_schema.json","title":"Config Group Associate Delete Request schema","description":"Config Group Associate Delete Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be associated with","items":{"type":"object","$ref":"#/components/schemas/deviceIdDef"},"uniqueItems":true,"minItems":1,"additionalProperties":false}},"required":["devices"],"additionalProperties":false,"$defs":{"deviceIdDef":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for associate DELETE API request schema for config group.","examples":{"example_1":{"value":{"devices":[{"id":"C8K-bee4a662-2a65-4b45-872a-b501bc5a465d"},{"id":"C8K-knt4aui2-2a65-4b45-872a-b501bc5a465d"}]}},"example_2":{"value":{"devices":[{"id":"C8K-iuvbubb2-2a65-4b45-872a-86987buh24ss"},{"id":"C8K-ad1235hb-13se-kjbi-421v-86987buh24ss"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/associate/delete/request_schema.json","title":"Config Group Associate Delete Request schema","description":"Config Group Associate Delete Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be associated with","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"uniqueItems":true,"minItems":1,"additionalProperties":false},"documentation":{"description":"This is the documentation for associate DELETE API request schema for config group.","examples":[{"devices":[{"id":"C8K-bee4a662-2a65-4b45-872a-b501bc5a465d"},{"id":"C8K-knt4aui2-2a65-4b45-872a-b501bc5a465d"}]},{"devices":[{"id":"C8K-iuvbubb2-2a65-4b45-872a-86987buh24ss"},{"id":"C8K-ad1235hb-13se-kjbi-421v-86987buh24ss"}]}]}},"required":["devices"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-6":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/deploy/post/request_schema.json","title":"Config Group Deploy Request schema","description":"Config Group Deploy Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be deployed","items":{"type":"object","$ref":"#/components/schemas/deviceIdDef"},"uniqueItems":true,"minItems":1,"additionalProperties":false}},"required":[],"additionalProperties":false,"$defs":{"deviceIdDef":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for DEPLOY API request schema for config group.","examples":{"example_1":{"value":{"devices":[{"id":"7f97aaa9-fac0-4461-aa31-9bf234d5f0af"},{"id":"3ed9aab9-b965-421f-973e-6887b17e5d68"}]}},"example_2":{"value":{"devices":[{"id":"3ed9aab9-b965-421f-973e-6887b17e5d78"},{"id":"ce1f3c7a-11c8-4c68-b71b-1fff5206ff09"}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/deploy/post/request_schema.json","title":"Config Group Deploy Request schema","description":"Config Group Deploy Request schema ","type":"object","properties":{"devices":{"type":"array","description":"list of device ids that config group need to be deployed","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"required":["id"],"additionalProperties":false},"uniqueItems":true,"minItems":1,"additionalProperties":false},"documentation":{"description":"This is the documentation for DEPLOY API request schema for config group.","examples":[{"devices":[{"id":"7f97aaa9-fac0-4461-aa31-9bf234d5f0af"},{"id":"3ed9aab9-b965-421f-973e-6887b17e5d68"}]},{"devices":[{"id":"3ed9aab9-b965-421f-973e-6887b17e5d78"},{"id":"ce1f3c7a-11c8-4c68-b71b-1fff5206ff09"}]}]}},"required":[],"not":{"required":["documentation"]},"additionalProperties":false}}}},"nonEmptyStringDef":{"type":"string","minLength":1},"response_schema-4":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/deploy/post/response_schema.json","title":"Config Group deploy Response schema","description":"Config Group deploy Response schema ","type":"object","properties":{"parentTaskId":{"$ref":"#/components/schemas/nonEmptyStringDef"}},"required":["parentTaskId"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for DEPLOY response schema for config group deploy API which returns the task id of the parent task scheduled for deploy operation","examples":{"example_1":{"value":{"parentTaskId":"deploy-config-group-73C544A7-5B4d-8f6c-feB4-b4af830b0d2c"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/deploy/post/response_schema.json","title":"Config Group deploy Response schema","description":"Config Group deploy Response schema ","type":"object","properties":{"parentTaskId":{"type":"string","minLength":1}},"documentation":{"description":"This is the documentation for DEPLOY response schema for config group deploy API which returns the task id of the parent task scheduled for deploy operation","examples":[{"parentTaskId":"deploy-config-group-73C544A7-5B4d-8f6c-feB4-b4af830b0d2c"}]},"required":["parentTaskId"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"response_schema-5":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/variables/get/response_schema.json","title":"Config Group Variables GET response","description":"Schema for the response of a GET request to retrieve config group variables","type":"object","properties":{"family":{"type":"string","description":"Family of the configuration"},"devices":{"type":"array","items":{"type":"object","properties":{"device-id":{"type":"string","description":"Unique identifier for the device","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the variable"},"value":{"type":"string","description":"Value of the variable"},"suggestions":{"type":"array","description":"List of suggestions for the variable","items":{"type":"string"}}},"required":["name"]}}},"required":["device-id","variables"]}},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the group"},"group-variables":{"type":"array","description":"Variables associated with the group","items":{"type":"object"}}},"required":["name","group-variables"]}}},"required":["family","devices","groups"],"additionalProperties":false},"request_schema-7":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/variables/put/request_schema.json","title":"Variables PUT request Schema","description":"Variables PUT request Schema","type":"object","properties":{"solution":{"$ref":"#/components/schemas/solutionDef"},"devices":{"description":"Variables for devices","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"device-id":{"description":"Device unique id ","type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"},"variables":{"description":"Variable object for the device","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":["string","integer","number","boolean","array"]}},"required":["name","value"],"additionalProperties":false}}},"required":["device-id","variables"],"additionalProperties":false}},"groups":{"description":"Variables for groups","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"group-variables":{"description":"global variables object for the group","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":["string","integer","number","boolean","array"]}},"required":["name","value"],"additionalProperties":false}}},"required":["name","group-variables"],"additionalProperties":false}}},"required":["solution","devices"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for variable.","details-1":"devices object is for device specific variables","details-2":"group-variables object is for group level variables (common for all devices)","examples":{"example_1":{"value":{"solution":"sdwan","devices":[{"device-id":"device1","variables":[{"name":"var1","value":"vm5"},{"name":"var2","value":20}]},{"device-id":"device2","variables":[{"name":"var3","value":"10.10.10.10"},{"name":"var4","value":true}]}],"groups":[{"name":"groupabcd","group-variables":[{"name":"name1","value":"value1"},{"name":"name2","value":"value2"}]}]}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/variables/put/request_schema.json","title":"Variables PUT request Schema","description":"Variables PUT request Schema","type":"object","properties":{"solution":{"type":"string","enum":["mobility","sdwan","sd-routing","nfvirtual","service-insertion","cellulargateway"]},"devices":{"description":"Variables for devices","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"device-id":{"description":"Device unique id ","type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"},"variables":{"description":"Variable object for the device","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":["string","integer","number","boolean","array"]}},"required":["name","value"],"additionalProperties":false}}},"required":["device-id","variables"],"additionalProperties":false}},"groups":{"description":"Variables for groups","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"group-variables":{"description":"global variables object for the group","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":["string","integer","number","boolean","array"]}},"required":["name","value"],"additionalProperties":false}}},"required":["name","group-variables"],"additionalProperties":false}}},"documentation":{"description":"This is the documentation for PUT request schema for variable.","details-1":"devices object is for device specific variables","details-2":"group-variables object is for group level variables (common for all devices)","examples":[{"solution":"sdwan","devices":[{"device-id":"device1","variables":[{"name":"var1","value":"vm5"},{"name":"var2","value":20}]},{"device-id":"device2","variables":[{"name":"var3","value":"10.10.10.10"},{"name":"var4","value":true}]}],"groups":[{"name":"groupabcd","group-variables":[{"name":"name1","value":"value1"},{"name":"name2","value":"value2"}]}]}]},"required":["solution","devices"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-8":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/variables/post/request_schema.json","title":"Variables POST request Schema","description":"Variables POST request Schema","type":"object","properties":{"deviceIds":{"description":"ID of devices for which Variables need to be fetched","type":"array","uniqueItems":true,"items":{"description":"Device unique id ","type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"suggestions":{"description":"Variable object for the device","type":"boolean"},"required":[],"additionalProperties":false},"required":[],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for variable.","details-1":"devices object is for device specific variables","details-2":"group-variables object is for group level variables (common for all devices)","examples":{"example_1":{"value":{"deviceIds":["C1111-8PWH-FGL2128903M","C8200-1N-4T-FGL2433L3BA"],"suggestions":true}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/variables/post/request_schema.json","title":"Variables POST request Schema","description":"Variables POST request Schema","type":"object","properties":{"deviceIds":{"description":"ID of devices for which Variables need to be fetched","type":"array","uniqueItems":true,"items":{"description":"Device unique id ","type":"string","pattern":"^[a-zA-Z0-9\\-/]+$"}},"suggestions":{"description":"Variable object for the device","type":"boolean"},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for variable.","details-1":"devices object is for device specific variables","details-2":"group-variables object is for group level variables (common for all devices)","examples":[{"deviceIds":["C1111-8PWH-FGL2128903M","C8200-1N-4T-FGL2433L3BA"],"suggestions":true}]},"required":[],"not":{"required":["documentation"]},"additionalProperties":false}}}},"response_schema-6":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/preview/post/response_schema.json","title":"Config Group preview Response schema","description":"Config Group preview Response schema ","type":"object","properties":{"existingConfig":{"type":"string"},"newConfig":{"type":"string"},"unsupportedParcels":{"type":"array","minItems":0,"items":{"type":"object"}}},"required":["existingConfig","newConfig"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for DEPLOY POST response schema for config group.","examples":{"example_1":{"value":{"newConfig":" system\n ztp-status success\n pseudo-confirm-commit 300\n personality vedge\n device-model vedge-C8000V\n chassis-number C8K-44ff74b5-fa18-4c3a-ad92-cc3520409963\n system-ip 172.16.255.15\n domain-id 1\n overlay-id 1\n site-id 500\n ipv6-strict-control false\n role edge-router\n port-offset 0\n control-session-pps 300\n admin-tech-on-failure\n sp-organization-name \"vIPtela Inc Regression\"\n organization-name \"vIPtela Inc Regression\"\n port-hop\n track-transport\n track-default-gateway\n","existingConfig":"","unsupportedFeatureTypes":[],"iOSConfigDeployFailure":""}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/configgroup/common/preview/post/response_schema.json","title":"Config Group preview Response schema","description":"Config Group preview Response schema ","type":"object","properties":{"existingConfig":{"type":"string"},"newConfig":{"type":"string"},"unsupportedParcels":{"type":"array","minItems":0,"items":{"type":"object"}}},"documentation":{"description":"This is the documentation for DEPLOY POST response schema for config group.","examples":[{"newConfig":" system\n ztp-status success\n pseudo-confirm-commit 300\n personality vedge\n device-model vedge-C8000V\n chassis-number C8K-44ff74b5-fa18-4c3a-ad92-cc3520409963\n system-ip 172.16.255.15\n domain-id 1\n overlay-id 1\n site-id 500\n ipv6-strict-control false\n role edge-router\n port-offset 0\n control-session-pps 300\n admin-tech-on-failure\n sp-organization-name \"vIPtela Inc Regression\"\n organization-name \"vIPtela Inc Regression\"\n port-hop\n track-transport\n track-default-gateway\n","existingConfig":"","unsupportedFeatureTypes":[],"iOSConfigDeployFailure":""}]},"required":["existingConfig","newConfig"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-9":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/cli/config/post/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"}},"required":["name","data"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","examples":{"CliConfigParcel1":{"value":{"data":{"config":"gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure"},"name":"CliConfigParcel1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/cli/config/post/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","examples":[{"data":{"config":"gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure"},"name":"CliConfigParcel1"}]}},"required":["name","data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}}},"response_schema-7":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/common/post/response_schema.json","title":"Profile Parcel POST Response schema","description":"Profile Parcel POST Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"metadata":{"minVManageVersion":"20.15.1"}},"required":["id"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST response schema for profile parcel","examples":{"example_1":{"value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/common/post/response_schema.json","title":"Profile Parcel POST Response schema","description":"Profile Parcel POST Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"documentation":{"description":"This is the documentation for POST response schema for profile parcel","examples":[{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["id"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}}},"request_schema-10":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/cli/config/put/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"}},"required":["name","data"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","examples":{"CliConfigParcel1":{"value":{"data":{"config":"gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure"},"name":"CliConfigParcel1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/cli/config/put/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","examples":[{"data":{"config":"gw-system:system logging disk enable\ngw-system:system admin-tech-on-failure"},"name":"CliConfigParcel1"}]}},"required":["name","data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}}},"response_schema-8":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/common/put/response_schema.json","title":"Profile Parcel PUT Response schema","description":"Profile Parcel PUT Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"metadata":{"minVManageVersion":"20.15.1"}},"required":["id"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT response schema for profile parcel","examples":{"example_1":{"value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/common/put/response_schema.json","title":"Profile Parcel PUT Response schema","description":"Profile Parcel PUT Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"documentation":{"description":"This is the documentation for PUT response schema for profile parcel","examples":[{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["id"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}}},"variableOptionTypeDef":{"type":"string","enum":["variable"]},"valueDef":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"defaultDef":{"minLength":1,"type":"string","maxLength":2048},"descriptionDef":{"minLength":1,"type":"string","maxLength":128},"variableOptionTypeObjectDef":{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/valueDef"},"default":{"$ref":"#/components/schemas/defaultDef"},"description":{"$ref":"#/components/schemas/descriptionDef"}},"required":["optionType","value"],"additionalProperties":false},"globalOptionTypeDef":{"type":"string","enum":["global"]},"booleanDef":{"type":"boolean"},"defaultOptionTypeDef":{"type":"string","enum":["default"]},"booleanFalseDef":{"type":"boolean","enum":[false]},"oneOfOnBooleanDefaultFalseOptionsDef":{"oneOf":[{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType","value"],"additionalProperties":false}]},"gigInterfaceRateDef":{"minimum":1,"maximum":1000,"default":1000,"type":"integer"},"oneOfGigInterfaceRateDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/gigInterfaceRateDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","minimum":1000,"maximum":1000}},"required":["optionType","value"],"additionalProperties":false}]},"cellularInterfaceRateDef":{"minimum":1,"maximum":1000,"default":150,"type":"integer"},"oneOfCellularInterfaceRateDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/cellularInterfaceRateDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","minimum":150,"maximum":150}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-11":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/qos/common/request_schema.json","title":"AON QOS Parcel Schema","description":"AON QOS profile parcel schema for post and put requests ","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"enableQos":{"type":"object","description":"Enable the QOS feature","$ref":"#/components/schemas/oneOfOnBooleanDefaultFalseOptionsDef"},"gigabitEthernet00QosConfig":{"description":"GigabitEthernet0/0 IEEE 802.3z interface QOS configuration","type":"object","properties":{"rate":{"description":"Uplink Max data rate in Mbps 1! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"enableQos":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType","value"],"additionalProperties":false}]},"gigabitEthernet00QosConfig":{"description":"GigabitEthernet0/0 IEEE 802.3z interface QOS configuration","type":"object","properties":{"rate":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":1000,"default":1000,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","minimum":1000,"maximum":1000}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["rate"],"additionalProperties":false},"cellular1QosConfig":{"description":"Cellular1 interface QOS configuration","type":"object","properties":{"rate":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":1000,"default":150,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","minimum":150,"maximum":150}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["rate"],"additionalProperties":false}},"required":["enableQos","gigabitEthernet00QosConfig","cellular1QosConfig"],"additionalProperties":false},"documentation":{"description":"This is the documentation for post and put request schema for QoS profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"enableQos":{"optionType":"default","value":false},"gigabitEthernet00QosConfig":{"rate":{"optionType":"global","value":100}},"cellular1QosConfig":{"rate":{"optionType":"global","value":200}}},"description":"This module defines the data model for AON QoS management","name":"AonQoSParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data","name"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"radiusServerNameDef":{"type":"string","minLength":1,"maxLength":31},"oneOfRadiusServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"ipv4AddressPatternDef":{"pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$"},"oneOfRadiusServerIpAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4AddressPatternDef"}},"required":["optionType","value"],"additionalProperties":false}]},"radiusServerPortDef":{"type":"integer","minimum":1,"maximum":65535},"oneOfRadiusServerPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerPortDef"}},"required":["optionType","value"],"additionalProperties":false}]},"radiusServerSecretDef":{"type":"string","minLength":1},"oneOfRadiusServerSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerSecretDef"}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-12":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/aaaservers/post/request_schema.json","title":"AON AAA Servers Parcel Schema","description":"AON AAA Servers profile parcel schema for POST request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"radiusServers":{"description":"Radius Server Configuration","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Set the Radius Server Name","type":"object","$ref":"#/components/schemas/oneOfRadiusServerNameOptionsDef"},"ipAddress":{"description":"Set the Radius Server IP Address","type":"object","$ref":"#/components/schemas/oneOfRadiusServerIpAddressOptionsDef"},"port":{"description":"Set the Radius Server Port","type":"object","$ref":"#/components/schemas/oneOfRadiusServerPortOptionsDef"},"secret":{"description":"Set the Radius Server Secret","type":"object","$ref":"#/components/schemas/oneOfRadiusServerSecretOptionsDef"}},"required":["name","ipAddress","port","secret"],"additionalProperties":false}}},"required":["radiusServers"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfRadiusServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusServerIpAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4AddressPatternDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusServerPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerPortDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusServerSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerSecretDef"}},"required":["optionType","value"],"additionalProperties":false}]},"radiusServerNameDef":{"type":"string","minLength":1,"maxLength":31},"radiusServerPortDef":{"type":"integer","minimum":1,"maximum":65535},"radiusServerSecretDef":{"type":"string","minLength":1},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for AAA Servers profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"AonAAAServersParcelConfig":{"value":{"data":{"radiusServers":[{"name":{"optionType":"global","value":"radiusServer7"},"ipAddress":{"optionType":"global","value":"10.5.6.2"},"port":{"optionType":"global","value":5},"secret":{"optionType":"global","value":"Secret$123"}}]},"description":"Aon AAA Servers Parcel config","name":"AonAAAServersParcelConfig"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/aaaservers/post/request_schema.json","title":"AON AAA Servers Parcel Schema","description":"AON AAA Servers profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"radiusServers":{"description":"Radius Server Configuration","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1,"maxLength":31}},"required":["optionType","value"],"additionalProperties":false}]},"ipAddress":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$"}},"required":["optionType","value"],"additionalProperties":false}]},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":65535}},"required":["optionType","value"],"additionalProperties":false}]},"secret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","ipAddress","port","secret"],"additionalProperties":false}}},"required":["radiusServers"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for AAA Servers profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"radiusServers":[{"name":{"optionType":"global","value":"radiusServer7"},"ipAddress":{"optionType":"global","value":"10.5.6.2"},"port":{"optionType":"global","value":5},"secret":{"optionType":"global","value":"Secret$123"}}]},"description":"Aon AAA Servers Parcel config","name":"AonAAAServersParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-13":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/aaaservers/put/request_schema.json","title":"AON AAA Servers Parcel Schema","description":"AON AAA Servers profile parcel schema for PUT request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"radiusServers":{"description":"Radius Server Configuration","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Set the Radius Server Name","type":"object","$ref":"#/components/schemas/oneOfRadiusServerNameOptionsDef"},"ipAddress":{"description":"Set the Radius Server IP Address","type":"object","$ref":"#/components/schemas/oneOfRadiusServerIpAddressOptionsDef"},"port":{"description":"Set the Radius Server Port","type":"object","$ref":"#/components/schemas/oneOfRadiusServerPortOptionsDef"},"secret":{"description":"Set the Radius Server Secret","type":"object","$ref":"#/components/schemas/oneOfRadiusServerSecretOptionsDef"}},"required":["name","ipAddress","port","secret"],"additionalProperties":false}}},"required":["radiusServers"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfRadiusServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusServerIpAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4AddressPatternDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusServerPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerPortDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusServerSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusServerSecretDef"}},"required":["optionType","value"],"additionalProperties":false}]},"radiusServerNameDef":{"type":"string","minLength":1,"maxLength":31},"radiusServerPortDef":{"type":"integer","minimum":1,"maximum":65535},"radiusServerSecretDef":{"type":"string","minLength":1},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for AAA Servers profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"AonAAAServersParcelConfig":{"value":{"data":{"radiusServers":[{"name":{"optionType":"global","value":"radiusServer7"},"ipAddress":{"optionType":"global","value":"10.6.5.4"},"port":{"optionType":"global","value":5},"secret":{"optionType":"global","value":"Secret$123"}}]},"description":"Aon AAA Servers Parcel config","name":"AonAAAServersParcelConfig"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/aaaservers/put/request_schema.json","title":"AON AAA Servers Parcel Schema","description":"AON AAA Servers profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"radiusServers":{"description":"Radius Server Configuration","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1,"maxLength":31}},"required":["optionType","value"],"additionalProperties":false}]},"ipAddress":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$"}},"required":["optionType","value"],"additionalProperties":false}]},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":65535}},"required":["optionType","value"],"additionalProperties":false}]},"secret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","ipAddress","port","secret"],"additionalProperties":false}}},"required":["radiusServers"],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for AAA Servers profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"radiusServers":[{"name":{"optionType":"global","value":"radiusServer7"},"ipAddress":{"optionType":"global","value":"10.6.5.4"},"port":{"optionType":"global","value":5},"secret":{"optionType":"global","value":"Secret$123"}}]},"description":"Aon AAA Servers Parcel config","name":"AonAAAServersParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"userNameDef":{"type":"string","enum":["admin"]},"oneOfUserNameOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userNameDef"}},"required":["optionType","value"],"additionalProperties":false},"userPasswordDef":{"type":"string","description":"Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters","minLength":8,"maxLength":32,"allOf":[{"pattern":".*\\d{1,}.*"},{"pattern":".*[A-Z]{1,}.*"},{"pattern":".*[a-z]{1,}.*"},{"pattern":".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*"}]},"oneOfUserPasswordOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},"request_schema-14":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/basic/post/request_schema.json","title":"AON Basic Parcel Schema","description":"AON Basic profile parcel schema for POST request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"items":{"type":"object","properties":{"name":{"description":"Set the username","type":"object","$ref":"#/components/schemas/oneOfUserNameOptionsDef"},"password":{"description":"Set the user password","type":"object","$ref":"#/components/schemas/oneOfUserPasswordOptionsDef"}},"required":["name","password"],"additionalProperties":false}}},"required":["user"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfUserNameOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userNameDef"}},"required":["optionType","value"],"additionalProperties":false},"oneOfUserPasswordOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},"userNameDef":{"type":"string","enum":["admin"]},"userPasswordDef":{"type":"string","description":"Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters","minLength":8,"maxLength":32,"allOf":[{"pattern":".*\\d{1,}.*"},{"pattern":".*[A-Z]{1,}.*"},{"pattern":".*[a-z]{1,}.*"},{"pattern":".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*"}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Basic profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"AonBasicParcelConfig":{"value":{"data":{"user":[{"name":{"optionType":"global","value":"admin"},"password":{"optionType":"global","value":"Admin@123"}}]},"description":"Aon Basic Parcel config","name":"AonBasicParcelConfig"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/basic/post/request_schema.json","title":"AON Basic Parcel Schema","description":"AON Basic profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"items":{"type":"object","properties":{"name":{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["admin"]}},"required":["optionType","value"],"additionalProperties":false},"password":{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","description":"Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters","minLength":8,"maxLength":32,"allOf":[{"pattern":".*\\d{1,}.*"},{"pattern":".*[A-Z]{1,}.*"},{"pattern":".*[a-z]{1,}.*"},{"pattern":".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*"}]}},"required":["optionType","value"],"additionalProperties":false}},"required":["name","password"],"additionalProperties":false}}},"required":["user"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for Basic profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"user":[{"name":{"optionType":"global","value":"admin"},"password":{"optionType":"global","value":"Admin@123"}}]},"description":"Aon Basic Parcel config","name":"AonBasicParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-15":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/basic/put/request_schema.json","title":"AON Basic Parcel Schema","description":"AON Basic profile parcel schema for PUT request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"items":{"type":"object","properties":{"name":{"description":"Set the username","type":"object","$ref":"#/components/schemas/oneOfUserNameOptionsDef"},"password":{"description":"Set the user password","type":"object","$ref":"#/components/schemas/oneOfUserPasswordOptionsDef"}},"required":["name","password"],"additionalProperties":false}}},"required":["user"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfUserNameOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userNameDef"}},"required":["optionType","value"],"additionalProperties":false},"oneOfUserPasswordOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},"userNameDef":{"type":"string","enum":["admin"]},"userPasswordDef":{"type":"string","description":"Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters","minLength":8,"maxLength":32,"allOf":[{"pattern":".*\\d{1,}.*"},{"pattern":".*[A-Z]{1,}.*"},{"pattern":".*[a-z]{1,}.*"},{"pattern":".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*"}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Basic profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"AonBasicParcelConfig":{"value":{"data":{"user":[{"name":{"optionType":"global","value":"admin"},"password":{"optionType":"global","value":"Admin@123"}}]},"description":"Aon Basic Parcel config","name":"AonBasicParcelConfig"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/basic/put/request_schema.json","title":"AON Basic Parcel Schema","description":"AON Basic profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"items":{"type":"object","properties":{"name":{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["admin"]}},"required":["optionType","value"],"additionalProperties":false},"password":{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","description":"Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters","minLength":8,"maxLength":32,"allOf":[{"pattern":".*\\d{1,}.*"},{"pattern":".*[A-Z]{1,}.*"},{"pattern":".*[a-z]{1,}.*"},{"pattern":".*[!@#$%^&*-+=;:\",<.>?~`]{1,}.*"}]}},"required":["optionType","value"],"additionalProperties":false}},"required":["name","password"],"additionalProperties":false}}},"required":["user"],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for Basic profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"user":[{"name":{"optionType":"global","value":"admin"},"password":{"optionType":"global","value":"Admin@123"}}]},"description":"Aon Basic Parcel config","name":"AonBasicParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"wanConfigDef":{"type":"string","enum":["Active","Standby"]},"wanConfigOptionTypesDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/wanConfigDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"eSimAccountInfoDef":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false},"apnDef":{"type":"string"},"oneOfApnOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/apnDef"}},"required":["optionType","value"],"additionalProperties":false}]},"defaultAuthenticationDef":{"type":"string","enum":["none"]},"oneOfDefaultAuthenticationOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false},"oneOfNoAuthenticationOptionsDef":{"type":"object","properties":{"noAuthentication":{"type":"object","description":"No Authentication","$ref":"#/components/schemas/oneOfDefaultAuthenticationOptionsDef"}},"required":["noAuthentication"],"additionalProperties":false},"authenticationDef":{"enum":["pap","chap","pap_chap"],"type":"string"},"oneOfAuthenticationOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/authenticationDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"usernameDef":{"type":"string"},"oneOfUsernameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/usernameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"passwordDef":{"type":"string"},"oneOfPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/passwordDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNeedAuthenticationOptionsDef":{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"description":"Set authentication type","type":"object","$ref":"#/components/schemas/oneOfAuthenticationOptionsDef"},"username":{"description":"Set the username","type":"object","$ref":"#/components/schemas/oneOfUsernameOptionsDef"},"password":{"description":"Set the password","type":"object","$ref":"#/components/schemas/oneOfPasswordOptionsDef"}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false},"pdnTypeDef":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"},"defaultPdnTypeDef":{"type":"string","enum":["IPv4"]},"oneOfPdnTypeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/pdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultPdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"commonCellularProfileInfoDef":{"type":"object","properties":{"apn":{"description":"Set access point name","type":"object","$ref":"#/components/schemas/oneOfApnOptionsDef"},"authentication":{"oneOf":[{"$ref":"#/components/schemas/oneOfNoAuthenticationOptionsDef"},{"$ref":"#/components/schemas/oneOfNeedAuthenticationOptionsDef"}]},"pdnType":{"description":"Set packet data network type","type":"object","$ref":"#/components/schemas/oneOfPdnTypeOptionsDef"}},"required":["apn"],"additionalProperties":false},"eSimCellularSlotConfigDef":{"type":"object","properties":{"accountInfo":{"$ref":"#/components/schemas/eSimAccountInfoDef"},"attachProfileConfig":{"description":"Set attach profile eSim cellular configuration","type":"object","$ref":"#/components/schemas/commonCellularProfileInfoDef"},"dataProfileConfig":{"description":"Set data profile eSim cellular configuration","type":"object","$ref":"#/components/schemas/commonCellularProfileInfoDef"}},"required":["accountInfo","attachProfileConfig"],"additionalProperties":false},"slotConfigDef":{"type":"object","description":"Set the slot specific eSim cellular configuration","properties":{"slot0Config":{"description":"Set the slot 0 eSim cellular configuration","$ref":"#/components/schemas/eSimCellularSlotConfigDef"}},"required":["slot0Config"],"additionalProperties":false},"request_schema-16":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/esimcellular/post/request_schema.json","title":"Mobility eSim Cellular Schema","description":"eSim Cellular profile feature schema for POST request","type":"object","properties":{"name":{"description":"Set the eSim Cellular profile feature name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the eSim Cellular profile feature description","type":"string"},"data":{"type":"object","properties":{"wanConfig":{"description":"Set wanConfig for cellular as Active/Standby","type":"object","$ref":"#/components/schemas/wanConfigOptionTypesDef"},"slotConfig":{"$ref":"#/components/schemas/slotConfigDef"}},"required":["slotConfig"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"wanConfigOptionTypesDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/wanConfigDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"wanConfigDef":{"type":"string","enum":["Active","Standby"]},"slotConfigDef":{"type":"object","description":"Set the slot specific eSim cellular configuration","properties":{"slot0Config":{"description":"Set the slot 0 eSim cellular configuration","$ref":"#/components/schemas/eSimCellularSlotConfigDef"}},"required":["slot0Config"],"additionalProperties":false},"eSimCellularSlotConfigDef":{"type":"object","properties":{"accountInfo":{"$ref":"#/components/schemas/eSimAccountInfoDef"},"attachProfileConfig":{"description":"Set attach profile eSim cellular configuration","type":"object","$ref":"#/components/schemas/commonCellularProfileInfoDef"},"dataProfileConfig":{"description":"Set data profile eSim cellular configuration","type":"object","$ref":"#/components/schemas/commonCellularProfileInfoDef"}},"required":["accountInfo","attachProfileConfig"],"additionalProperties":false},"commonCellularProfileInfoDef":{"type":"object","properties":{"apn":{"description":"Set access point name","type":"object","$ref":"#/components/schemas/oneOfApnOptionsDef"},"authentication":{"oneOf":[{"$ref":"#/components/schemas/oneOfNoAuthenticationOptionsDef"},{"$ref":"#/components/schemas/oneOfNeedAuthenticationOptionsDef"}]},"pdnType":{"description":"Set packet data network type","type":"object","$ref":"#/components/schemas/oneOfPdnTypeOptionsDef"}},"required":["apn"],"additionalProperties":false},"eSimAccountInfoDef":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false},"oneOfApnOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/apnDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfNoAuthenticationOptionsDef":{"type":"object","properties":{"noAuthentication":{"type":"object","description":"No Authentication","$ref":"#/components/schemas/oneOfDefaultAuthenticationOptionsDef"}},"required":["noAuthentication"],"additionalProperties":false},"oneOfNeedAuthenticationOptionsDef":{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"description":"Set authentication type","type":"object","$ref":"#/components/schemas/oneOfAuthenticationOptionsDef"},"username":{"description":"Set the username","type":"object","$ref":"#/components/schemas/oneOfUsernameOptionsDef"},"password":{"description":"Set the password","type":"object","$ref":"#/components/schemas/oneOfPasswordOptionsDef"}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false},"oneOfAuthenticationOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/authenticationDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDefaultAuthenticationOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false},"oneOfPdnTypeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/pdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultPdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUsernameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/usernameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/passwordDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"apnDef":{"type":"string"},"authenticationDef":{"enum":["pap","chap","pap_chap"],"type":"string"},"defaultAuthenticationDef":{"type":"string","enum":["none"]},"pdnTypeDef":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"},"defaultPdnTypeDef":{"type":"string","enum":["IPv4"]},"usernameDef":{"type":"string"},"passwordDef":{"type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Mobility eSim Cellular profile feature","examples":{"AON_CG1_eSim_Cellular_Profile_Feature1":{"value":{"data":{"slotConfig":{"slot0Config":{"accountInfo":{"accountId":{"optionType":"global","value":"accountId1"},"commPlan":{"optionType":"global","value":"comPlan1"},"ratePlan":{"optionType":"global","value":"ratePlan1"}},"attachProfileConfig":{"apn":{"optionType":"global","value":"apn1"},"authentication":{"noAuthentication":{"optionType":"default","value":"none"}},"pdnType":{"optionType":"default","value":"IPv4"}}}}},"description":"AON eSim Cellular Profile Feature config","name":"AON_CG1_eSim_Cellular_Profile_Feature1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/esimcellular/post/request_schema.json","title":"Mobility eSim Cellular Schema","description":"eSim Cellular profile feature schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the eSim Cellular profile feature description","type":"string"},"data":{"type":"object","properties":{"wanConfig":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["Active","Standby"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"slotConfig":{"type":"object","description":"Set the slot specific eSim cellular configuration","properties":{"slot0Config":{"type":"object","properties":{"accountInfo":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this configuration","properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this configuration","properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this configuration","properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false},"attachProfileConfig":{"type":"object","properties":{"apn":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["none"]}},"required":["optionType","value"],"additionalProperties":false}},"required":["noAuthentication"],"additionalProperties":false},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["pap","chap","pap_chap"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"username":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"password":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false}]},"pdnType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["IPv4"]}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["apn"],"additionalProperties":false},"dataProfileConfig":{"type":"object","properties":{"apn":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["none"]}},"required":["optionType","value"],"additionalProperties":false}},"required":["noAuthentication"],"additionalProperties":false},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["pap","chap","pap_chap"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"username":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"password":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false}]},"pdnType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["IPv4"]}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["apn"],"additionalProperties":false}},"required":["accountInfo","attachProfileConfig"],"additionalProperties":false}},"required":["slot0Config"],"additionalProperties":false}},"required":["slotConfig"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for Mobility eSim Cellular profile feature","examples":[{"data":{"slotConfig":{"slot0Config":{"accountInfo":{"accountId":{"optionType":"global","value":"accountId1"},"commPlan":{"optionType":"global","value":"comPlan1"},"ratePlan":{"optionType":"global","value":"ratePlan1"}},"attachProfileConfig":{"apn":{"optionType":"global","value":"apn1"},"authentication":{"noAuthentication":{"optionType":"default","value":"none"}},"pdnType":{"optionType":"default","value":"IPv4"}}}}},"description":"AON eSim Cellular Profile Feature config","name":"AON_CG1_eSim_Cellular_Profile_Feature1"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-17":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/esimcellular/put/request_schema.json","title":"Mobility eSim Cellular Schema","description":"eSim Cellular profile feature schema for PUT request","type":"object","properties":{"name":{"description":"Set the eSim Cellular profile feature name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the eSim Cellular profile feature description","type":"string"},"data":{"type":"object","properties":{"wanConfig":{"description":"Set wanConfig for cellular as Active/Standby","type":"object","$ref":"#/components/schemas/wanConfigOptionTypesDef"},"slotConfig":{"$ref":"#/components/schemas/slotConfigDef"}},"required":["slotConfig"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"wanConfigOptionTypesDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/wanConfigDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"wanConfigDef":{"type":"string","enum":["Active","Standby"]},"slotConfigDef":{"type":"object","description":"Set the slot specific eSim cellular configuration","properties":{"slot0Config":{"description":"Set the slot 0 eSim cellular configuration","$ref":"#/components/schemas/eSimCellularSlotConfigDef"}},"required":["slot0Config"],"additionalProperties":false},"eSimCellularSlotConfigDef":{"type":"object","properties":{"accountInfo":{"$ref":"#/components/schemas/eSimAccountInfoDef"},"attachProfileConfig":{"description":"Set attach profile eSim cellular configuration","type":"object","$ref":"#/components/schemas/commonCellularProfileInfoDef"},"dataProfileConfig":{"description":"Set data profile eSim cellular configuration","type":"object","$ref":"#/components/schemas/commonCellularProfileInfoDef"}},"required":["accountInfo","attachProfileConfig"],"additionalProperties":false},"commonCellularProfileInfoDef":{"type":"object","properties":{"apn":{"description":"Set access point name","type":"object","$ref":"#/components/schemas/oneOfApnOptionsDef"},"authentication":{"oneOf":[{"$ref":"#/components/schemas/oneOfNoAuthenticationOptionsDef"},{"$ref":"#/components/schemas/oneOfNeedAuthenticationOptionsDef"}]},"pdnType":{"description":"Set packet data network type","type":"object","$ref":"#/components/schemas/oneOfPdnTypeOptionsDef"}},"required":["apn"],"additionalProperties":false},"eSimAccountInfoDef":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this configuration","properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false},"oneOfApnOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/apnDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfNoAuthenticationOptionsDef":{"type":"object","properties":{"noAuthentication":{"type":"object","description":"No Authentication","$ref":"#/components/schemas/oneOfDefaultAuthenticationOptionsDef"}},"required":["noAuthentication"],"additionalProperties":false},"oneOfNeedAuthenticationOptionsDef":{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"description":"Set authentication type","type":"object","$ref":"#/components/schemas/oneOfAuthenticationOptionsDef"},"username":{"description":"Set the username","type":"object","$ref":"#/components/schemas/oneOfUsernameOptionsDef"},"password":{"description":"Set the password","type":"object","$ref":"#/components/schemas/oneOfPasswordOptionsDef"}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false},"oneOfAuthenticationOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/authenticationDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDefaultAuthenticationOptionsDef":{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false},"oneOfPdnTypeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/pdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultPdnTypeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUsernameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/usernameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/passwordDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"apnDef":{"type":"string"},"authenticationDef":{"enum":["pap","chap","pap_chap"],"type":"string"},"defaultAuthenticationDef":{"type":"string","enum":["none"]},"pdnTypeDef":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"},"defaultPdnTypeDef":{"type":"string","enum":["IPv4"]},"usernameDef":{"type":"string"},"passwordDef":{"type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Mobility eSim Cellular profile feature","examples":{"AON_CG1_eSim_Cellular_Profile_Feature1":{"value":{"data":{"slotConfig":{"slot0Config":{"accountInfo":{"accountId":{"optionType":"global","value":"accountId1"},"commPlan":{"optionType":"global","value":"comPlan1"},"ratePlan":{"optionType":"global","value":"ratePlan1"}},"attachProfileConfig":{"apn":{"optionType":"global","value":"apn1"},"authentication":{"noAuthentication":{"optionType":"default","value":"none"}},"pdnType":{"optionType":"default","value":"IPv4"}}}}},"description":"AON eSim Cellular Profile Feature config","name":"AON_CG1_eSim_Cellular_Profile_Feature1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/esimcellular/put/request_schema.json","title":"Mobility eSim Cellular Schema","description":"eSim Cellular profile feature schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the eSim Cellular profile feature description","type":"string"},"data":{"type":"object","properties":{"wanConfig":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["Active","Standby"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"slotConfig":{"type":"object","description":"Set the slot specific eSim cellular configuration","properties":{"slot0Config":{"type":"object","properties":{"accountInfo":{"type":"object","properties":{"accountId":{"type":"object","description":"Set provider account Id used for this configuration","properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"commPlan":{"type":"object","description":"Set communication plan used for this configuration","properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false},"ratePlan":{"type":"object","description":"Set rate plan used for this configuration","properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1}},"required":["optionType","value"],"additionalProperties":false}},"required":["accountId","commPlan","ratePlan"],"additionalProperties":false},"attachProfileConfig":{"type":"object","properties":{"apn":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["none"]}},"required":["optionType","value"],"additionalProperties":false}},"required":["noAuthentication"],"additionalProperties":false},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["pap","chap","pap_chap"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"username":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"password":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false}]},"pdnType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["IPv4"]}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["apn"],"additionalProperties":false},"dataProfileConfig":{"type":"object","properties":{"apn":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"authentication":{"oneOf":[{"type":"object","properties":{"noAuthentication":{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["none"]}},"required":["optionType","value"],"additionalProperties":false}},"required":["noAuthentication"],"additionalProperties":false},{"type":"object","properties":{"needAuthentication":{"type":"object","properties":{"type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["pap","chap","pap_chap"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"username":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"password":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["type","username","password"],"additionalProperties":false}},"required":["needAuthentication"],"additionalProperties":false}]},"pdnType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"IPv4","enum":["IPv4","IPv6","IPv4v6"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["IPv4"]}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["apn"],"additionalProperties":false}},"required":["accountInfo","attachProfileConfig"],"additionalProperties":false}},"required":["slot0Config"],"additionalProperties":false}},"required":["slotConfig"],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for Mobility eSim Cellular profile feature","examples":[{"data":{"slotConfig":{"slot0Config":{"accountInfo":{"accountId":{"optionType":"global","value":"accountId1"},"commPlan":{"optionType":"global","value":"comPlan1"},"ratePlan":{"optionType":"global","value":"ratePlan1"}},"attachProfileConfig":{"apn":{"optionType":"global","value":"apn1"},"authentication":{"noAuthentication":{"optionType":"default","value":"none"}},"pdnType":{"optionType":"default","value":"IPv4"}}}}},"description":"AON eSim Cellular Profile Feature config","name":"AON_CG1_eSim_Cellular_Profile_Feature1"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}},"additionalProperties":false},"diskFileSizeDef":{"type":"integer","minimum":1,"maximum":20,"default":10},"oneOfDiskFileSizeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diskFileSizeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileRotateDef":{"type":"integer","minimum":1,"maximum":10,"default":10},"oneOfDiskFileRotateOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diskFileRotateDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIpv4OrDomainNameRemotePublicIpAddressesDef":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"oneOfServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfsourceIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["systemIp"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"type":"string","enum":["{{logging_server_source_ip}}"]}},"required":["optionType","value"],"additionalProperties":false}]},"prioritytDef":{"type":"string","enum":["information","notice","warn","error","critical","alert","emergency"],"default":"information"},"oneOfPriorityOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/prioritytDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["error"]}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-18":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/logging/post/request_schema.json","title":"Logging Parcel Schema","description":"Logging profile parcel schema for POST request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"disk":{"description":"Enable logging to disk","type":"object","properties":{"file":{"description":"File to which to log messages","type":"object","properties":{"diskFileSize":{"description":"Maximum size of file before it is rotated, in MB","$ref":"#/components/schemas/oneOfDiskFileSizeOptionsDef"},"diskFileRotate":{"description":"Number of rotations before the file is discarded","$ref":"#/components/schemas/oneOfDiskFileRotateOptionsDef"}},"required":["diskFileSize","diskFileRotate"],"additionalProperties":false}},"required":["file"],"additionalProperties":false},"server":{"description":"Remote host logging parameters","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"name":{"description":"Set hostname or IPv4 address of server","type":"object","$ref":"#/components/schemas/oneOfServerNameOptionsDef"},"sourceIp":{"description":"Source interface for outgoing logging messages to server","type":"object","$ref":"#/components/schemas/oneOfsourceIpOptionsDef"},"priority":{"description":"Set level of logging to file, default is ERROR","type":"object","$ref":"#/components/schemas/oneOfPriorityOptionsDef"}},"required":["name","sourceIp","priority"],"additionalProperties":false}}},"required":["disk"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfDiskFileSizeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diskFileSizeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileSizeDef":{"type":"integer","minimum":1,"maximum":20,"default":10},"oneOfDiskFileRotateOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diskFileRotateDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileRotateDef":{"type":"integer","minimum":1,"maximum":10,"default":10},"oneOfServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfsourceIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["systemIp"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"type":"string","enum":["{{logging_server_source_ip}}"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPriorityOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/prioritytDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["error"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIpv4OrDomainNameRemotePublicIpAddressesDef":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"prioritytDef":{"type":"string","enum":["information","notice","warn","error","critical","alert","emergency"],"default":"information"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Logging profile parcel","examples":{"AON_CG1_MOBILITY_Logging_parcel1":{"value":{"data":{"disk":{"file":{"diskFileSize":{"optionType":"global","value":4},"diskFileRotate":{"optionType":"global","value":10}}},"server":[{"name":{"optionType":"global","value":"vm12"},"sourceIp":{"optionType":"variable","value":"{{logging_server_source_ip}}"},"priority":{"optionType":"global","value":"critical"}}]},"description":"AON System Logging Parcel config","name":"AON_CG1_MOBILITY_Logging_parcel1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/logging/post/request_schema.json","title":"Logging Parcel Schema","description":"Logging profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"disk":{"description":"Enable logging to disk","type":"object","properties":{"file":{"description":"File to which to log messages","type":"object","properties":{"diskFileSize":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":20,"default":10}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileRotate":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":10,"default":10}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["diskFileSize","diskFileRotate"],"additionalProperties":false}},"required":["file"],"additionalProperties":false},"server":{"description":"Remote host logging parameters","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]}},"required":["optionType","value"],"additionalProperties":false}]},"sourceIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["systemIp"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","enum":["{{logging_server_source_ip}}"]}},"required":["optionType","value"],"additionalProperties":false}]},"priority":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["information","notice","warn","error","critical","alert","emergency"],"default":"information"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["error"]}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","sourceIp","priority"],"additionalProperties":false}}},"required":["disk"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for Logging profile parcel","examples":[{"data":{"disk":{"file":{"diskFileSize":{"optionType":"global","value":4},"diskFileRotate":{"optionType":"global","value":10}}},"server":[{"name":{"optionType":"global","value":"vm12"},"sourceIp":{"optionType":"variable","value":"{{logging_server_source_ip}}"},"priority":{"optionType":"global","value":"critical"}}]},"description":"AON System Logging Parcel config","name":"AON_CG1_MOBILITY_Logging_parcel1"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-19":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/logging/put/request_schema.json","title":"Logging Parcel Schema","description":"Logging profile parcel schema for PUT request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"disk":{"description":"Enable logging to disk","type":"object","properties":{"file":{"description":"File to which to log messages","type":"object","properties":{"diskFileSize":{"description":"Maximum size of file before it is rotated, in MB","$ref":"#/components/schemas/oneOfDiskFileSizeOptionsDef"},"diskFileRotate":{"description":"Number of rotations before the file is discarded","$ref":"#/components/schemas/oneOfDiskFileRotateOptionsDef"}},"required":["diskFileSize","diskFileRotate"],"additionalProperties":false}},"required":["file"],"additionalProperties":false},"server":{"description":"Remote host logging parameters","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"name":{"description":"Set hostname or IPv4 address of server","type":"object","$ref":"#/components/schemas/oneOfServerNameOptionsDef"},"sourceIp":{"description":"Source interface for outgoing logging messages to server","type":"object","$ref":"#/components/schemas/oneOfsourceIpOptionsDef"},"priority":{"description":"Set level of logging to file, default is ERROR","type":"object","$ref":"#/components/schemas/oneOfPriorityOptionsDef"}},"required":["name","sourceIp","priority"],"additionalProperties":false}}},"required":["disk"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfDiskFileSizeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diskFileSizeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileSizeDef":{"type":"integer","minimum":1,"maximum":20,"default":10},"oneOfDiskFileRotateOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diskFileRotateDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileRotateDef":{"type":"integer","minimum":1,"maximum":10,"default":10},"oneOfServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfsourceIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["systemIp"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"type":"string","enum":["{{logging_server_source_ip}}"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPriorityOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/prioritytDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["error"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIpv4OrDomainNameRemotePublicIpAddressesDef":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"prioritytDef":{"type":"string","enum":["information","notice","warn","error","critical","alert","emergency"],"default":"information"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Logging profile parcel","examples":{"AON_CG1_MOBILITY_Logging_parcel1":{"value":{"data":{"disk":{"file":{"diskFileSize":{"optionType":"global","value":4},"diskFileRotate":{"optionType":"global","value":10}}},"server":[{"name":{"optionType":"global","value":"vm12"},"sourceIp":{"optionType":"variable","value":"{{logging_server_source_ip}}"},"priority":{"optionType":"global","value":"critical"}}]},"description":"AON System Logging Parcel config","name":"AON_CG1_MOBILITY_Logging_parcel1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/logging/put/request_schema.json","title":"Logging Parcel Schema","description":"Logging profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"disk":{"description":"Enable logging to disk","type":"object","properties":{"file":{"description":"File to which to log messages","type":"object","properties":{"diskFileSize":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":20,"default":10}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]},"diskFileRotate":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":10,"default":10}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":10,"minimum":10,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["diskFileSize","diskFileRotate"],"additionalProperties":false}},"required":["file"],"additionalProperties":false},"server":{"description":"Remote host logging parameters","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]}},"required":["optionType","value"],"additionalProperties":false}]},"sourceIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["systemIp"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","enum":["{{logging_server_source_ip}}"]}},"required":["optionType","value"],"additionalProperties":false}]},"priority":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["information","notice","warn","error","critical","alert","emergency"],"default":"information"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["error"]}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","sourceIp","priority"],"additionalProperties":false}}},"required":["disk"],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for Logging profile parcel","examples":[{"data":{"disk":{"file":{"diskFileSize":{"optionType":"global","value":4},"diskFileRotate":{"optionType":"global","value":10}}},"server":[{"name":{"optionType":"global","value":"vm12"},"sourceIp":{"optionType":"variable","value":"{{logging_server_source_ip}}"},"priority":{"optionType":"global","value":"critical"}}]},"description":"AON System Logging Parcel config","name":"AON_CG1_MOBILITY_Logging_parcel1"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"tunnelNameDef":{"type":"string","pattern":"^ipsec[1-5]$","minLength":1},"oneOfTunnelNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tunnelNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelDescriptionDef":{"type":"string","pattern":"^[^<> ]*$","minLength":1,"maxLength":127},"oneOfTunnelDescriptionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tunnelDescriptionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"listOfIpv4RemotePrivateSubnetsDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":75,"additionalProperties":false,"items":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}},"oneOfListOfIpv4RemotePrivateSubnetsOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4RemotePrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false}]},"ipv4LocalPrivateSubnetsDef":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"},"oneOfLocalPrivateSubnetOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4LocalPrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"staticLocalRemotePrivateSubnetDef":{"type":"object","properties":{"remotePrivateSubnets":{"description":"Remote Private Subnet","type":"object","$ref":"#/components/schemas/oneOfListOfIpv4RemotePrivateSubnetsOptionsDef"},"localPrivateSubnet":{"description":"Local Private Subnet","type":"object","$ref":"#/components/schemas/oneOfLocalPrivateSubnetOptionsDef"}},"additionalProperties":false,"required":["remotePrivateSubnets","localPrivateSubnet"]},"oneOfPrivateSubnetsDef":{"oneOf":[{"$ref":"#/components/schemas/staticLocalRemotePrivateSubnetDef"}]},"preSharedSecretInputDef":{"type":"string","pattern":"^(?!.*[!#]).*","minLength":1,"maxLength":127},"oneOfPresharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/preSharedSecretInputDef"}},"required":["optionType","value"],"additionalProperties":false}]},"listOfIpv4OrDomainNameRemotePublicIpAddressesDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}},"oneOfRemotePublicIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"listOfIpv4DNSAddressesDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"type":"string","format":"ipv4"}},"oneOfListOfIpv4TunnelDnsAddressesOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4DNSAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTunnelDnsAddressOptionsDef":{"oneOf":[{"$ref":"#/components/schemas/oneOfListOfIpv4TunnelDnsAddressesOptionsDef"}]},"localInterfaceDef":{"enum":["Cellular1/0","GigabitEthernet0/0"],"type":"string"},"oneOfLocalInterfaceOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/localInterfaceDef"}},"required":["optionType","value"],"additionalProperties":false}]},"secondaryIpv4OrDomainNameRemotePublicIpAddressesDef":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]},"oneOfSecondaryRemotePublicIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/secondaryIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"dpdIntervalDef":{"maximum":65535,"minimum":0,"type":"integer","default":10},"dpdIntervalDefaultDef":{"maximum":10,"minimum":10,"type":"integer"},"oneOfDpdIntervalOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdIntervalDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdIntervalDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"dpdRetriesDef":{"maximum":255,"minimum":0,"type":"integer","default":3},"dpdRetriesDefaultDef":{"maximum":3,"minimum":3,"type":"integer"},"oneOfDpdRetriesOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdRetriesDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdRetriesDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelRedundancyConfigDef":{"type":"object","properties":{"secondaryRemotePublicIp":{"description":"Secondary Remote Public IP Address","type":"object","$ref":"#/components/schemas/oneOfSecondaryRemotePublicIpOptionsDef"},"dpdInterval":{"description":"Dead Peer Detection Interval","type":"object","$ref":"#/components/schemas/oneOfDpdIntervalOptionsDef"},"dpdRetries":{"description":"Dead Peer Detection Retries","type":"object","$ref":"#/components/schemas/oneOfDpdRetriesOptionsDef"}},"additionalProperties":false,"required":["secondaryRemotePublicIp"]},"ikePhase1CipherSuiteDefaultDef":{"enum":["aes128-cbc-sha1"],"type":"string"},"ikePhase1CipherSuiteDef":{"enum":["aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-cbc-sha1"},"oneOfIkePhase1CipherSuiteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase1CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase1CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"ikeVersionDefaultDef":{"maximum":2,"minimum":2,"type":"integer"},"oneOfIkeVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikeVersionDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"diffeHellmanGroupDef":{"enum":["14","15","16","19","20","21"],"type":"string","default":"14"},"diffeHellmanGroupDefaultDef":{"enum":["14"],"type":"string"},"oneOfDiffeHellmanGroupOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diffeHellmanGroupDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/diffeHellmanGroupDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"rekeyTimerDef":{"maximum":1209600,"minimum":300,"type":"integer","default":7200},"rekeyTimerDefaultDef":{"maximum":7200,"minimum":7200,"type":"integer"},"oneOfRekeyTimerOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/rekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/rekeyTimerDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"ikePhase2CipherSuiteDefaultDef":{"enum":["aes128-sha1"],"type":"string"},"ikePhase2CipherSuiteDef":{"enum":["aes128-sha1","aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-sha1"},"oneOfIkePhase2CipherSuiteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"ikePhase2RekeyTimerDef":{"maximum":1209600,"minimum":300,"type":"integer","default":7200},"ikePhase2RekeyDefaultDef":{"maximum":7200,"minimum":7200,"type":"integer"},"oneOfIkePhase2RekeyTimerOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2RekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2RekeyDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-20":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/vpn/post/request_schema.json","title":"AON VPN Parcel Schema","description":"AON VPN profile parcel schema for POST request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"vpnTunnels":{"type":"array","description":"Container to provide multiple VPN tunnels configurations","minItems":1,"maxItems":1,"uniqueItems":true,"additionalProperties":false,"items":{"type":"object","properties":{"vpnTunnelInfo":{"type":"object","description":"Provide specific tunnel information","properties":{"name":{"description":"Tunnel Name","type":"object","$ref":"#/components/schemas/oneOfTunnelNameOptionsDef"},"description":{"description":"Tunnel Description","type":"object","$ref":"#/components/schemas/oneOfTunnelDescriptionOptionsDef"},"privateSubnets":{"description":"Container for Local and Remote Private Subnets","type":"object","$ref":"#/components/schemas/oneOfPrivateSubnetsDef"},"preSharedSecret":{"description":"Preshared Secret","type":"object","$ref":"#/components/schemas/oneOfPresharedSecretOptionsDef"},"remotePublicIp":{"description":"Remote Public IP Address","type":"object","$ref":"#/components/schemas/oneOfRemotePublicIpOptionsDef"},"tunnelDnsAddress":{"description":"List of Tunnel DNS Addresses","type":"object","$ref":"#/components/schemas/oneOfTunnelDnsAddressOptionsDef"},"localInterface":{"description":"Local Interface","type":"object","$ref":"#/components/schemas/oneOfLocalInterfaceOptionsDef"},"tunnelRedundancyConfiguration":{"description":"Container for Fields Related to Redundancy Configuration","type":"object","$ref":"#/components/schemas/tunnelRedundancyConfigDef"}},"required":["name","preSharedSecret","remotePublicIp","localInterface"],"additionalProperties":false},"ipSecPolicy":{"type":"object","description":"Provide IPSEC policy information","properties":{"ikePhase1":{"type":"object","description":"IKE Phase 1","properties":{"cipherSuite":{"description":"IKE Phase 1 Cipher Suite","type":"object","$ref":"#/components/schemas/oneOfIkePhase1CipherSuiteOptionsDef"},"ikeVersion":{"description":"IKE Phase 1 Version","type":"object","$ref":"#/components/schemas/oneOfIkeVersionOptionsDef"},"diffeHellmanGroup":{"description":"IKE Phase 1 Diffe-Hellman Group","type":"object","$ref":"#/components/schemas/oneOfDiffeHellmanGroupOptionsDef"},"rekeyTimer":{"description":"IKE Phase 1 Rekey Timer","type":"object","$ref":"#/components/schemas/oneOfRekeyTimerOptionsDef"}},"required":["cipherSuite","diffeHellmanGroup"],"additionalProperties":false},"ikePhase2CipherSuite":{"description":"Ike Phase 2 Cipher Suite","type":"object","$ref":"#/components/schemas/oneOfIkePhase2CipherSuiteOptionsDef"},"ikePhase2RekeyTimer":{"description":"Ike Phase 2 Rekey Timer","type":"object","$ref":"#/components/schemas/oneOfIkePhase2RekeyTimerOptionsDef"}},"required":["ikePhase1","ikePhase2CipherSuite"],"additionalProperties":false}},"required":["vpnTunnelInfo","ipSecPolicy"],"additionalProperties":false}}},"required":["vpnTunnels"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfTunnelNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tunnelNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTunnelDescriptionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tunnelDescriptionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPrivateSubnetsDef":{"oneOf":[{"$ref":"#/components/schemas/staticLocalRemotePrivateSubnetDef"}]},"staticLocalRemotePrivateSubnetDef":{"type":"object","properties":{"remotePrivateSubnets":{"description":"Remote Private Subnet","type":"object","$ref":"#/components/schemas/oneOfListOfIpv4RemotePrivateSubnetsOptionsDef"},"localPrivateSubnet":{"description":"Local Private Subnet","type":"object","$ref":"#/components/schemas/oneOfLocalPrivateSubnetOptionsDef"}},"additionalProperties":false,"required":["remotePrivateSubnets","localPrivateSubnet"]},"oneOfListOfIpv4RemotePrivateSubnetsOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4RemotePrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPresharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/preSharedSecretInputDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRemotePublicIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTunnelDnsAddressOptionsDef":{"oneOf":[{"$ref":"#/components/schemas/oneOfListOfIpv4TunnelDnsAddressesOptionsDef"}]},"oneOfListOfIpv4TunnelDnsAddressesOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4DNSAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLocalInterfaceOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/localInterfaceDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkePhase1CipherSuiteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase1CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase1CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkeVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikeVersionDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDiffeHellmanGroupOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diffeHellmanGroupDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/diffeHellmanGroupDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRekeyTimerOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/rekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/rekeyTimerDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkePhase2CipherSuiteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLocalPrivateSubnetOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4LocalPrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"tunnelRedundancyConfigDef":{"type":"object","properties":{"secondaryRemotePublicIp":{"description":"Secondary Remote Public IP Address","type":"object","$ref":"#/components/schemas/oneOfSecondaryRemotePublicIpOptionsDef"},"dpdInterval":{"description":"Dead Peer Detection Interval","type":"object","$ref":"#/components/schemas/oneOfDpdIntervalOptionsDef"},"dpdRetries":{"description":"Dead Peer Detection Retries","type":"object","$ref":"#/components/schemas/oneOfDpdRetriesOptionsDef"}},"additionalProperties":false,"required":["secondaryRemotePublicIp"]},"oneOfSecondaryRemotePublicIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/secondaryIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDpdIntervalOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdIntervalDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdIntervalDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDpdRetriesOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdRetriesDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdRetriesDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkePhase2RekeyTimerOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2RekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2RekeyDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelNameDef":{"type":"string","pattern":"^ipsec[1-5]$","minLength":1},"tunnelDescriptionDef":{"type":"string","pattern":"^[^<> ]*$","minLength":1,"maxLength":127},"preSharedSecretInputDef":{"type":"string","pattern":"^(?!.*[!#]).*","minLength":1,"maxLength":127},"listOfIpv4RemotePrivateSubnetsDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":75,"additionalProperties":false,"items":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}},"ipv4LocalPrivateSubnetsDef":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"},"listOfIpv4OrDomainNameRemotePublicIpAddressesDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}},"listOfIpv4DNSAddressesDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"type":"string","format":"ipv4"}},"localInterfaceDef":{"enum":["Cellular1/0","GigabitEthernet0/0"],"type":"string"},"ikePhase1CipherSuiteDef":{"enum":["aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-cbc-sha1"},"ikePhase1CipherSuiteDefaultDef":{"enum":["aes128-cbc-sha1"],"type":"string"},"ikeVersionDefaultDef":{"maximum":2,"minimum":2,"type":"integer"},"ikePhase2CipherSuiteDef":{"enum":["aes128-sha1","aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-sha1"},"ikePhase2CipherSuiteDefaultDef":{"enum":["aes128-sha1"],"type":"string"},"diffeHellmanGroupDef":{"enum":["14","15","16","19","20","21"],"type":"string","default":"14"},"diffeHellmanGroupDefaultDef":{"enum":["14"],"type":"string"},"rekeyTimerDef":{"maximum":1209600,"minimum":300,"type":"integer","default":7200},"rekeyTimerDefaultDef":{"maximum":7200,"minimum":7200,"type":"integer"},"secondaryIpv4OrDomainNameRemotePublicIpAddressesDef":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]},"dpdIntervalDef":{"maximum":65535,"minimum":0,"type":"integer","default":10},"dpdIntervalDefaultDef":{"maximum":10,"minimum":10,"type":"integer"},"dpdRetriesDef":{"maximum":255,"minimum":0,"type":"integer","default":3},"dpdRetriesDefaultDef":{"maximum":3,"minimum":3,"type":"integer"},"ikePhase2RekeyTimerDef":{"maximum":1209600,"minimum":300,"type":"integer","default":7200},"ikePhase2RekeyDefaultDef":{"maximum":7200,"minimum":7200,"type":"integer"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for VPN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"AonVPNParcelConfig":{"value":{"data":{"vpnTunnels":[{"vpnTunnelInfo":{"name":{"optionType":"global","value":"ipsec1"},"description":{"optionType":"global","value":"ipsec1TunnelConfiguration"},"privateSubnets":{"remotePrivateSubnets":{"optionType":"global","value":["1.0.0.0/1","2.0.0.0/1"]},"localPrivateSubnet":{"optionType":"variable","value":"{{local-private-subnet}}"}},"preSharedSecret":{"optionType":"global","value":"$ecret@"},"remotePublicIp":{"optionType":"global","value":["1.0.0.0"]},"tunnelDnsAddress":{"optionType":"global","value":["2.0.0.0"]},"localInterface":{"optionType":"global","value":"Cellular1/0"},"tunnelRedundancyConfiguration":{"secondaryRemotePublicIp":{"optionType":"global","value":"5.4.3.2"},"dpdInterval":{"optionType":"global","value":30},"dpdRetries":{"optionType":"global","value":20}}},"ipSecPolicy":{"ikePhase1":{"cipherSuite":{"optionType":"default","value":"aes128-cbc-sha1"},"ikeVersion":{"optionType":"default","value":2},"diffeHellmanGroup":{"optionType":"global","value":"14"},"rekeyTimer":{"optionType":"global","value":1209600}},"ikePhase2CipherSuite":{"optionType":"default","value":"aes128-sha1"},"ikePhase2RekeyTimer":{"optionType":"global","value":1209600}}}]},"description":"Aon VPN Parcel config","name":"AonVPNParcelConfig"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/vpn/post/request_schema.json","title":"AON VPN Parcel Schema","description":"AON VPN profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"vpnTunnels":{"type":"array","description":"Container to provide multiple VPN tunnels configurations","minItems":1,"maxItems":1,"uniqueItems":true,"additionalProperties":false,"items":{"type":"object","properties":{"vpnTunnelInfo":{"type":"object","description":"Provide specific tunnel information","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^ipsec[1-5]$","minLength":1}},"required":["optionType","value"],"additionalProperties":false}]},"description":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^[^<> ]*$","minLength":1,"maxLength":127}},"required":["optionType","value"],"additionalProperties":false}]},"privateSubnets":{"oneOf":[{"type":"object","properties":{"remotePrivateSubnets":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":75,"additionalProperties":false,"items":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}}},"required":["optionType","value"],"additionalProperties":false}]},"localPrivateSubnet":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"required":["remotePrivateSubnets","localPrivateSubnet"]}]},"preSharedSecret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^(?!.*[!#]).*","minLength":1,"maxLength":127}},"required":["optionType","value"],"additionalProperties":false}]},"remotePublicIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelDnsAddress":{"oneOf":[{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"type":"string","format":"ipv4"}}},"required":["optionType","value"],"additionalProperties":false}]}]},"localInterface":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["Cellular1/0","GigabitEthernet0/0"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelRedundancyConfiguration":{"type":"object","properties":{"secondaryRemotePublicIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false}]},"dpdInterval":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":65535,"minimum":0,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":10,"minimum":10,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"dpdRetries":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":255,"minimum":0,"type":"integer","default":3}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":3,"minimum":3,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"required":["secondaryRemotePublicIp"]}},"required":["name","preSharedSecret","remotePublicIp","localInterface"],"additionalProperties":false},"ipSecPolicy":{"type":"object","description":"Provide IPSEC policy information","properties":{"ikePhase1":{"type":"object","description":"IKE Phase 1","properties":{"cipherSuite":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["aes128-cbc-sha1"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-cbc-sha1"}},"required":["optionType","value"],"additionalProperties":false}]},"ikeVersion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":2,"minimum":2,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"diffeHellmanGroup":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["14","15","16","19","20","21"],"type":"string","default":"14"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["14"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"rekeyTimer":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":1209600,"minimum":300,"type":"integer","default":7200}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":7200,"minimum":7200,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["cipherSuite","diffeHellmanGroup"],"additionalProperties":false},"ikePhase2CipherSuite":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["aes128-sha1"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["aes128-sha1","aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-sha1"}},"required":["optionType","value"],"additionalProperties":false}]},"ikePhase2RekeyTimer":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":1209600,"minimum":300,"type":"integer","default":7200}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":7200,"minimum":7200,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["ikePhase1","ikePhase2CipherSuite"],"additionalProperties":false}},"required":["vpnTunnelInfo","ipSecPolicy"],"additionalProperties":false}}},"required":["vpnTunnels"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for VPN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"vpnTunnels":[{"vpnTunnelInfo":{"name":{"optionType":"global","value":"ipsec1"},"description":{"optionType":"global","value":"ipsec1TunnelConfiguration"},"privateSubnets":{"remotePrivateSubnets":{"optionType":"global","value":["1.0.0.0/1","2.0.0.0/1"]},"localPrivateSubnet":{"optionType":"variable","value":"{{local-private-subnet}}"}},"preSharedSecret":{"optionType":"global","value":"$ecret@"},"remotePublicIp":{"optionType":"global","value":["1.0.0.0"]},"tunnelDnsAddress":{"optionType":"global","value":["2.0.0.0"]},"localInterface":{"optionType":"global","value":"Cellular1/0"},"tunnelRedundancyConfiguration":{"secondaryRemotePublicIp":{"optionType":"global","value":"5.4.3.2"},"dpdInterval":{"optionType":"global","value":30},"dpdRetries":{"optionType":"global","value":20}}},"ipSecPolicy":{"ikePhase1":{"cipherSuite":{"optionType":"default","value":"aes128-cbc-sha1"},"ikeVersion":{"optionType":"default","value":2},"diffeHellmanGroup":{"optionType":"global","value":"14"},"rekeyTimer":{"optionType":"global","value":1209600}},"ikePhase2CipherSuite":{"optionType":"default","value":"aes128-sha1"},"ikePhase2RekeyTimer":{"optionType":"global","value":1209600}}}]},"description":"Aon VPN Parcel config","name":"AonVPNParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-21":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/vpn/put/request_schema.json","title":"AON VPN Parcel Schema","description":"AON VPN profile parcel schema for PUT request","type":"object","properties":{"name":{"description":"Set the parcel name","$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"vpnTunnels":{"type":"array","description":"Container to provide multiple VPN tunnels configurations","minItems":1,"maxItems":1,"uniqueItems":true,"additionalProperties":false,"items":{"type":"object","properties":{"vpnTunnelInfo":{"type":"object","description":"Provide specific tunnel information","properties":{"name":{"description":"Tunnel Name","type":"object","$ref":"#/components/schemas/oneOfTunnelNameOptionsDef"},"description":{"description":"Tunnel Description","type":"object","$ref":"#/components/schemas/oneOfTunnelDescriptionOptionsDef"},"privateSubnets":{"description":"Container for Local and Remote Private Subnets","type":"object","$ref":"#/components/schemas/oneOfPrivateSubnetsDef"},"preSharedSecret":{"description":"Preshared Secret","type":"object","$ref":"#/components/schemas/oneOfPresharedSecretOptionsDef"},"remotePublicIp":{"description":"Remote Public IP Address","type":"object","$ref":"#/components/schemas/oneOfRemotePublicIpOptionsDef"},"tunnelDnsAddress":{"description":"List of Tunnel DNS Addresses","type":"object","$ref":"#/components/schemas/oneOfTunnelDnsAddressOptionsDef"},"localInterface":{"description":"Local Interface","type":"object","$ref":"#/components/schemas/oneOfLocalInterfaceOptionsDef"},"tunnelRedundancyConfiguration":{"description":"Container for Fields Related to Redundancy Configuration","type":"object","$ref":"#/components/schemas/tunnelRedundancyConfigDef"}},"required":["name","preSharedSecret","remotePublicIp","localInterface"],"additionalProperties":false},"ipSecPolicy":{"type":"object","description":"Provide IPSEC policy information","properties":{"ikePhase1":{"type":"object","description":"IKE Phase 1","properties":{"cipherSuite":{"description":"IKE Phase 1 Cipher Suite","type":"object","$ref":"#/components/schemas/oneOfIkePhase1CipherSuiteOptionsDef"},"ikeVersion":{"description":"IKE Phase 1 Version","type":"object","$ref":"#/components/schemas/oneOfIkeVersionOptionsDef"},"diffeHellmanGroup":{"description":"IKE Phase 1 Diffe-Hellman Group","type":"object","$ref":"#/components/schemas/oneOfDiffeHellmanGroupOptionsDef"},"rekeyTimer":{"description":"IKE Phase 1 Rekey Timer","type":"object","$ref":"#/components/schemas/oneOfRekeyTimerOptionsDef"}},"required":["cipherSuite","diffeHellmanGroup"],"additionalProperties":false},"ikePhase2CipherSuite":{"description":"Ike Phase 2 Cipher Suite","type":"object","$ref":"#/components/schemas/oneOfIkePhase2CipherSuiteOptionsDef"},"ikePhase2RekeyTimer":{"description":"Ike Phase 2 Rekey Timer","type":"object","$ref":"#/components/schemas/oneOfIkePhase2RekeyTimerOptionsDef"}},"required":["ikePhase1","ikePhase2CipherSuite"],"additionalProperties":false}},"required":["vpnTunnelInfo","ipSecPolicy"],"additionalProperties":false}}},"required":["vpnTunnels"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"$defs":{"oneOfTunnelNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tunnelNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTunnelDescriptionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tunnelDescriptionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPrivateSubnetsDef":{"oneOf":[{"$ref":"#/components/schemas/staticLocalRemotePrivateSubnetDef"}]},"staticLocalRemotePrivateSubnetDef":{"type":"object","properties":{"remotePrivateSubnets":{"description":"Remote Private Subnet","type":"object","$ref":"#/components/schemas/oneOfListOfIpv4RemotePrivateSubnetsOptionsDef"},"localPrivateSubnet":{"description":"Local Private Subnet","type":"object","$ref":"#/components/schemas/oneOfLocalPrivateSubnetOptionsDef"}},"additionalProperties":false,"required":["remotePrivateSubnets","localPrivateSubnet"]},"oneOfListOfIpv4RemotePrivateSubnetsOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4RemotePrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPresharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/preSharedSecretInputDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRemotePublicIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTunnelDnsAddressOptionsDef":{"oneOf":[{"$ref":"#/components/schemas/oneOfListOfIpv4TunnelDnsAddressesOptionsDef"}]},"oneOfListOfIpv4TunnelDnsAddressesOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/listOfIpv4DNSAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLocalInterfaceOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/localInterfaceDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkePhase1CipherSuiteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase1CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase1CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkeVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikeVersionDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDiffeHellmanGroupOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/diffeHellmanGroupDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/diffeHellmanGroupDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRekeyTimerOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/rekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/rekeyTimerDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkePhase2CipherSuiteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2CipherSuiteDefaultDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2CipherSuiteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLocalPrivateSubnetOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4LocalPrivateSubnetsDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"tunnelRedundancyConfigDef":{"type":"object","properties":{"secondaryRemotePublicIp":{"description":"Secondary Remote Public IP Address","type":"object","$ref":"#/components/schemas/oneOfSecondaryRemotePublicIpOptionsDef"},"dpdInterval":{"description":"Dead Peer Detection Interval","type":"object","$ref":"#/components/schemas/oneOfDpdIntervalOptionsDef"},"dpdRetries":{"description":"Dead Peer Detection Retries","type":"object","$ref":"#/components/schemas/oneOfDpdRetriesOptionsDef"}},"additionalProperties":false,"required":["secondaryRemotePublicIp"]},"oneOfSecondaryRemotePublicIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/secondaryIpv4OrDomainNameRemotePublicIpAddressesDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDpdIntervalOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdIntervalDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdIntervalDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDpdRetriesOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdRetriesDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/dpdRetriesDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfIkePhase2RekeyTimerOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2RekeyTimerDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/ikePhase2RekeyDefaultDef"}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelNameDef":{"type":"string","pattern":"^ipsec[1-5]$","minLength":1},"tunnelDescriptionDef":{"type":"string","pattern":"^[^<> ]*$","minLength":1,"maxLength":127},"preSharedSecretInputDef":{"type":"string","pattern":"^(?!.*[!#]).*","minLength":1,"maxLength":127},"listOfIpv4RemotePrivateSubnetsDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":75,"additionalProperties":false,"items":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}},"ipv4LocalPrivateSubnetsDef":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"},"listOfIpv4OrDomainNameRemotePublicIpAddressesDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}},"listOfIpv4DNSAddressesDef":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"type":"string","format":"ipv4"}},"localInterfaceDef":{"enum":["Cellular1/0","GigabitEthernet0/0"],"type":"string"},"ikePhase1CipherSuiteDef":{"enum":["aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-cbc-sha1"},"ikePhase1CipherSuiteDefaultDef":{"enum":["aes128-cbc-sha1"],"type":"string"},"ikeVersionDefaultDef":{"maximum":2,"minimum":2,"type":"integer"},"ikePhase2CipherSuiteDef":{"enum":["aes128-sha1","aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-sha1"},"ikePhase2CipherSuiteDefaultDef":{"enum":["aes128-sha1"],"type":"string"},"diffeHellmanGroupDef":{"enum":["14","15","16","19","20","21"],"type":"string","default":"14"},"diffeHellmanGroupDefaultDef":{"enum":["14"],"type":"string"},"rekeyTimerDef":{"maximum":1209600,"minimum":300,"type":"integer","default":7200},"rekeyTimerDefaultDef":{"maximum":7200,"minimum":7200,"type":"integer"},"secondaryIpv4OrDomainNameRemotePublicIpAddressesDef":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]},"dpdIntervalDef":{"maximum":65535,"minimum":0,"type":"integer","default":10},"dpdIntervalDefaultDef":{"maximum":10,"minimum":10,"type":"integer"},"dpdRetriesDef":{"maximum":255,"minimum":0,"type":"integer","default":3},"dpdRetriesDefaultDef":{"maximum":3,"minimum":3,"type":"integer"},"ikePhase2RekeyTimerDef":{"maximum":1209600,"minimum":300,"type":"integer","default":7200},"ikePhase2RekeyDefaultDef":{"maximum":7200,"minimum":7200,"type":"integer"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for VPN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"AonVPNParcelConfig":{"value":{"data":{"vpnTunnels":[{"vpnTunnelInfo":{"name":{"optionType":"global","value":"ipsec1"},"description":{"optionType":"global","value":"ipsec1TunnelConfiguration"},"privateSubnets":{"remotePrivateSubnets":{"optionType":"global","value":["1.0.0.0/1","2.0.0.0/1"]},"localPrivateSubnet":{"optionType":"variable","value":"{{local-private-subnet}}"}},"preSharedSecret":{"optionType":"global","value":"$ecret@"},"remotePublicIp":{"optionType":"global","value":["1.0.0.0"]},"tunnelDnsAddress":{"optionType":"global","value":["2.0.0.0"]},"localInterface":{"optionType":"global","value":"Cellular1/0"},"tunnelRedundancyConfiguration":{"secondaryRemotePublicIp":{"optionType":"global","value":"5.4.3.2"},"dpdInterval":{"optionType":"global","value":30},"dpdRetries":{"optionType":"global","value":20}}},"ipSecPolicy":{"ikePhase1":{"cipherSuite":{"optionType":"default","value":"aes128-cbc-sha1"},"ikeVersion":{"optionType":"default","value":2},"diffeHellmanGroup":{"optionType":"global","value":"14"},"rekeyTimer":{"optionType":"global","value":1209600}},"ikePhase2CipherSuite":{"optionType":"default","value":"aes128-sha1"},"ikePhase2RekeyTimer":{"optionType":"global","value":1209600}}}]},"description":"Aon VPN Parcel config","name":"AonVPNParcelConfig"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/mobility/global/vpn/put/request_schema.json","title":"AON VPN Parcel Schema","description":"AON VPN profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"vpnTunnels":{"type":"array","description":"Container to provide multiple VPN tunnels configurations","minItems":1,"maxItems":1,"uniqueItems":true,"additionalProperties":false,"items":{"type":"object","properties":{"vpnTunnelInfo":{"type":"object","description":"Provide specific tunnel information","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^ipsec[1-5]$","minLength":1}},"required":["optionType","value"],"additionalProperties":false}]},"description":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^[^<> ]*$","minLength":1,"maxLength":127}},"required":["optionType","value"],"additionalProperties":false}]},"privateSubnets":{"oneOf":[{"type":"object","properties":{"remotePrivateSubnets":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":75,"additionalProperties":false,"items":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}}},"required":["optionType","value"],"additionalProperties":false}]},"localPrivateSubnet":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^(([01]?\\d\\d?|2[0-1]\\d|22[0-3])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)(([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.)([01]?\\d\\d?|2[0-4]\\d|25[0-5])/([0-2]?\\d|(3[0-2]))$"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"required":["remotePrivateSubnets","localPrivateSubnet"]}]},"preSharedSecret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^(?!.*[!#]).*","minLength":1,"maxLength":127}},"required":["optionType","value"],"additionalProperties":false}]},"remotePublicIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelDnsAddress":{"oneOf":[{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":1,"additionalProperties":false,"items":{"type":"string","format":"ipv4"}}},"required":["optionType","value"],"additionalProperties":false}]}]},"localInterface":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["Cellular1/0","GigabitEthernet0/0"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"tunnelRedundancyConfiguration":{"type":"object","properties":{"secondaryRemotePublicIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"anyOf":[{"type":"string","pattern":"(^((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?$)|(^\\.$))","minLength":1,"maxLength":253},{"type":"string","format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false}]},"dpdInterval":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":65535,"minimum":0,"type":"integer","default":10}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":10,"minimum":10,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"dpdRetries":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":255,"minimum":0,"type":"integer","default":3}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":3,"minimum":3,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"required":["secondaryRemotePublicIp"]}},"required":["name","preSharedSecret","remotePublicIp","localInterface"],"additionalProperties":false},"ipSecPolicy":{"type":"object","description":"Provide IPSEC policy information","properties":{"ikePhase1":{"type":"object","description":"IKE Phase 1","properties":{"cipherSuite":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["aes128-cbc-sha1"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-cbc-sha1"}},"required":["optionType","value"],"additionalProperties":false}]},"ikeVersion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":2,"minimum":2,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"diffeHellmanGroup":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["14","15","16","19","20","21"],"type":"string","default":"14"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["14"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"rekeyTimer":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":1209600,"minimum":300,"type":"integer","default":7200}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":7200,"minimum":7200,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["cipherSuite","diffeHellmanGroup"],"additionalProperties":false},"ikePhase2CipherSuite":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["aes128-sha1"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["aes128-sha1","aes128-cbc-sha1","aes256-cbc-sha1","aes128-cbc-sha256","aes256-cbc-sha256","aes128-gcm","aes256-gcm"],"type":"string","default":"aes128-sha1"}},"required":["optionType","value"],"additionalProperties":false}]},"ikePhase2RekeyTimer":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":1209600,"minimum":300,"type":"integer","default":7200}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":7200,"minimum":7200,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["ikePhase1","ikePhase2CipherSuite"],"additionalProperties":false}},"required":["vpnTunnelInfo","ipSecPolicy"],"additionalProperties":false}}},"required":["vpnTunnels"],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for VPN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"vpnTunnels":[{"vpnTunnelInfo":{"name":{"optionType":"global","value":"ipsec1"},"description":{"optionType":"global","value":"ipsec1TunnelConfiguration"},"privateSubnets":{"remotePrivateSubnets":{"optionType":"global","value":["1.0.0.0/1","2.0.0.0/1"]},"localPrivateSubnet":{"optionType":"variable","value":"{{local-private-subnet}}"}},"preSharedSecret":{"optionType":"global","value":"$ecret@"},"remotePublicIp":{"optionType":"global","value":["1.0.0.0"]},"tunnelDnsAddress":{"optionType":"global","value":["2.0.0.0"]},"localInterface":{"optionType":"global","value":"Cellular1/0"},"tunnelRedundancyConfiguration":{"secondaryRemotePublicIp":{"optionType":"global","value":"5.4.3.2"},"dpdInterval":{"optionType":"global","value":30},"dpdRetries":{"optionType":"global","value":20}}},"ipSecPolicy":{"ikePhase1":{"cipherSuite":{"optionType":"default","value":"aes128-cbc-sha1"},"ikeVersion":{"optionType":"default","value":2},"diffeHellmanGroup":{"optionType":"global","value":"14"},"rekeyTimer":{"optionType":"global","value":1209600}},"ikePhase2CipherSuite":{"optionType":"default","value":"aes128-sha1"},"ikePhase2RekeyTimer":{"optionType":"global","value":1209600}}}]},"description":"Aon VPN Parcel config","name":"AonVPNParcelConfig"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"fromFeatureProfileDef":{"oneOf":[{"properties":{"copy":{"$ref":"#/components/schemas/uuidDef"}},"required":["copy"],"additionalProperties":false}]},"request_schema-22":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/post/request_schema.json","title":"Feature Profile Schema","description":"Feature Profile Schema for POST Request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"fromFeatureProfile":{"type":"object","description":"from another feature profile","$ref":"#/components/schemas/fromFeatureProfileDef"}},"required":["name","description"],"additionalProperties":false,"$defs":{"fromFeatureProfileDef":{"oneOf":[{"properties":{"copy":{"$ref":"#/components/schemas/uuidDef"}},"required":["copy"],"additionalProperties":false}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request api schema for feature profile","mandatoryProfileParcels":{"description":"This object specifies the mandatory profile parcels for each feature profile type under each solution.","mobility":{"global":[""]},"sdwan":{"system":["banner","basic","logging","omp","bfd","aaa","service"],"transport":[""]},"cellulargateway":{"global":["aaa"]}},"examples":{"FeatureProfile1":{"value":{"name":"FeatureProfile1","description":"Feature Profile 1"}},"FeatureProfile2":{"value":{"name":"FeatureProfile2","description":"Copy Feature Profile from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99","fromFeatureProfile":{"copy":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"}}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/post/request_schema.json","title":"Feature Profile Schema","description":"Feature Profile Schema for POST Request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"fromFeatureProfile":{"oneOf":[{"properties":{"copy":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"}},"required":["copy"],"additionalProperties":false}]},"documentation":{"description":"This is the documentation for POST request api schema for feature profile","mandatoryProfileParcels":{"description":"This object specifies the mandatory profile parcels for each feature profile type under each solution.","mobility":{"global":[""]},"sdwan":{"system":["banner","basic","logging","omp","bfd","aaa","service"],"transport":[""]},"cellulargateway":{"global":["aaa"]}},"examples":[{"name":"FeatureProfile1","description":"Feature Profile 1"},{"name":"FeatureProfile2","description":"Copy Feature Profile from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99","fromFeatureProfile":{"copy":"EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99"}}]}},"required":["name","description"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"response_schema-9":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/post/response_schema.json","title":"Feature Profile POST Response schema","description":"Feature Profile POST Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"}},"required":["id"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST response schema for feature profile","examples":{"example_1":{"value":{"id":"Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/post/response_schema.json","title":"Feature Profile POST Response schema","description":"Feature Profile POST Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"documentation":{"description":"This is the documentation for POST response schema for feature profile","examples":[{"id":"Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB"}]}},"required":["id"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-23":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/put/request_schema.json","title":"Feature Profile Schema","description":"Feature Profile Schema for PUT Request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"}},"required":["name","description"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request api schema for feature profile","mandatoryProfileParcels":{"description":"This object specifies the mandatory profile parcels for each feature profile type under each solution.","mobility":{"global":[""]},"sdwan":{"system":["banner","basic","logging","omp","bfd","aaa","service"],"transport":[""]},"cellulargateway":{"global":["aaa"]}},"examples":{"FeatureProfile-1":{"value":{"name":"FeatureProfile-1","description":"Feature Profile 1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/put/request_schema.json","title":"Feature Profile Schema","description":"Feature Profile Schema for PUT Request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"documentation":{"description":"This is the documentation for PUT request api schema for feature profile","mandatoryProfileParcels":{"description":"This object specifies the mandatory profile parcels for each feature profile type under each solution.","mobility":{"global":[""]},"sdwan":{"system":["banner","basic","logging","omp","bfd","aaa","service"],"transport":[""]},"cellulargateway":{"global":["aaa"]}},"examples":[{"name":"FeatureProfile-1","description":"Feature Profile 1"}]}},"required":["name","description"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"response_schema-10":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/put/response_schema.json","title":"Feature Profile PUT Response schema","description":"Feature Profile PUT Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"}},"required":["id"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT response schema for feature profile","examples":{"example_1":{"value":{"id":"Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/featureprofile/common/put/response_schema.json","title":"Feature Profile PUT Response schema","description":"Feature Profile PUT Response schema ","type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"},"documentation":{"description":"This is the documentation for PUT response schema for feature profile","examples":[{"id":"Cc51Cc8B-e2c3-F701-438F-eE6Fbac38AAB"}]}},"required":["id"],"not":{"required":["documentation"]},"additionalProperties":false}}}},"request_schema-24":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/cli/config/post/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","examples":{"CliConfigParcel1":{"value":{"data":{"config":"vrf definition 100"},"name":"CliConfigParcel1"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/cli/config/post/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","examples":[{"data":{"config":"bfd default-dscp 48\nbfd app-route multiplier 6\nbfd app-route poll-interval 600000"},"name":"CliConfigParcel1"},{"data":{"config":"vrf definition 100"},"name":"CliConfigParcel1"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["name","data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}}},"nameDef":{"type":"string","maxLength":12},"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"interface_nameDef":{"type":"string","maxLength":15},"oneOfInterface_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interface_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"bridgeDef":{"minLength":1,"type":"string","maxLength":256},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"modeDef":{"enum":["access","trunk"],"type":"string"},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"native_lanDef":{"type":"integer","minimum":1,"maximum":4095},"oneOfNative_lanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_lanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"oneOfAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"ipv4SubnetMaskDef":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDhcpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"gatewayDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"oneOfGatewayOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/gatewayDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-25":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/ovsnetwork/put/request_schema.json","title":"Network Parcel Schema","description":"Network profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"network_name":{"description":"Name of the network","type":"object","$ref":"#/components/schemas/oneOfNameOptionsDef"},"interface_name":{"description":"Set interface_name","type":"object","$ref":"#/components/schemas/oneOfInterface_nameOptionsDef"},"bridge":{"description":"name of the bridge","type":"object","$ref":"#/components/schemas/oneOfBridgeOptionsDef"},"mode":{"description":"Set type of switch port: access/trunk","type":"object","$ref":"#/components/schemas/oneOfModeOptionsDef"},"vlan":{"description":"Set vlan","type":"object","$ref":"#/components/schemas/oneOfVlanOptionsDef"},"native_vlan":{"description":"Set native vlan","type":"object","$ref":"#/components/schemas/oneOfNative_lanOptionsDef"},"ip_address":{"description":"Set Subnet-address","type":"object","$ref":"#/components/schemas/oneOfAddressOptionsDef"},"netmask":{"description":"Set Subnet-mask","type":"object","$ref":"#/components/schemas/oneOfNetmaskOptionsDef"},"dhcp":{"description":"dhcp","type":"object","$ref":"#/components/schemas/oneOfDhcpOptionsDef"},"gateway":{"description":"gateway","type":"object","$ref":"#/components/schemas/oneOfGatewayOptionsDef"}},"required":["network_name"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterface_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interface_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNative_lanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_lanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDhcpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfGatewayOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/gatewayDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"nameDef":{"type":"string","maxLength":12},"interface_nameDef":{"type":"string","maxLength":15},"bridgeDef":{"minLength":1,"type":"string","maxLength":256},"modeDef":{"enum":["access","trunk"],"type":"string"},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"native_lanDef":{"type":"integer","minimum":1,"maximum":4095},"addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"gatewayDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for network profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"NetworkParcelGlobalDefault":{"value":{"data":{"name":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"native_lan":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"dhcp":{"optionType":"global","value":"xxx"},"gateway":{"optionType":"global","value":"xxx"}},"name":"NetworkParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/ovsnetwork/put/request_schema.json","title":"Network Parcel Schema","description":"Network profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"network_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":12}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":15}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bridge":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["access","trunk"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"ip_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"netmask":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"dhcp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"gateway":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["network_name"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for network profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"name":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"native_lan":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"dhcp":{"optionType":"global","value":"xxx"},"gateway":{"optionType":"global","value":"xxx"}},"name":"NetworkParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"portDef":{"type":"string"},"oneOfPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/portDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"ipAddressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"oneOfIpAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipAddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"network_nameDef":{"type":"string","maxLength":12},"oneOfNetwork_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/network_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"$defs-bridgeDef":{"type":"string","maxLength":15},"$defs-oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"$defs-modeDef":{"default":"trunk","enum":["trunk","access"],"type":"string"},"defaultModeDef":{"enum":["trunk"],"type":"string"},"$defs-oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultModeDef"}},"required":["optionType"],"additionalProperties":false}]},"native_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"oneOfNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-26":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/lan/post/request_schema.json","title":"LAN Parcel Schema","description":"LAN profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"interface_name":{"description":" Lan Interface Name","type":"object","$ref":"#/components/schemas/oneOfPortOptionsDef"},"ip_address":{"description":" ip address for static","type":"object","$ref":"#/components/schemas/oneOfIpAddressOptionsDef"},"netmask":{"description":"subnet mask","type":"object","$ref":"#/components/schemas/oneOfNetmaskOptionsDef"},"network_name":{"description":"Name of the WAN Network","type":"object","$ref":"#/components/schemas/oneOfNetwork_nameOptionsDef"},"bridge":{"description":"Name of the WAN Bridge","type":"object","$ref":"#/components/schemas/$defs-oneOfBridgeOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","$ref":"#/components/schemas/$defs-oneOfModeOptionsDef"},"vlan":{"description":"Range of VLANs for the network","type":"object","$ref":"#/components/schemas/oneOfVlanOptionsDef"},"native_vlan":{"description":"Native Vlan for the network","type":"object","$ref":"#/components/schemas/oneOfNative_vlanOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/portDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfIpAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipAddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetwork_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/network_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultModeDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"portDef":{"type":"string"},"ipAddressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"network_nameDef":{"type":"string","maxLength":12},"bridgeDef":{"type":"string","maxLength":15},"modeDef":{"default":"trunk","enum":["trunk","access"],"type":"string"},"defaultModeDef":{"enum":["trunk"],"type":"string"},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"native_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for LAN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"LANParcelGlobalDefault":{"value":{"data":{"interface_name":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"}},"name":"LANParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/lan/post/request_schema.json","title":"LAN Parcel Schema","description":"LAN profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"ip_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"netmask":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"network_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":12}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bridge":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":15}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"trunk","enum":["trunk","access"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["trunk"],"type":"string"}},"required":["optionType"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for LAN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"interface_name":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"}},"name":"LANParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-27":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/lan/put/request_schema.json","title":"LAN Parcel Schema","description":"LAN profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"interface_name":{"description":"Lan Interface Name","type":"object","$ref":"#/components/schemas/oneOfPortOptionsDef"},"ip_address":{"description":" ip address for static","type":"object","$ref":"#/components/schemas/oneOfIpAddressOptionsDef"},"netmask":{"description":"subnet mask","type":"object","$ref":"#/components/schemas/oneOfNetmaskOptionsDef"},"network_name":{"description":"Name of the WAN Network","type":"object","$ref":"#/components/schemas/oneOfNetwork_nameOptionsDef"},"bridge":{"description":"Name of the WAN Bridge","type":"object","$ref":"#/components/schemas/$defs-oneOfBridgeOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","$ref":"#/components/schemas/$defs-oneOfModeOptionsDef"},"vlan":{"description":"Range of VLANs for the network","type":"object","$ref":"#/components/schemas/oneOfVlanOptionsDef"},"native_vlan":{"description":"Native Vlan for the network","type":"object","$ref":"#/components/schemas/oneOfNative_vlanOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/portDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfIpAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipAddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetwork_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/network_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultModeDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"portDef":{"type":"string"},"ipAddressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"network_nameDef":{"type":"string","maxLength":12},"bridgeDef":{"type":"string","maxLength":15},"modeDef":{"default":"trunk","enum":["trunk","access"],"type":"string"},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"native_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"defaultModeDef":{"enum":["trunk"],"type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for LAN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"LANParcelGlobalDefault":{"value":{"data":{"interface_name":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"vlan":{"optionType":"global","value":"xxx"},"native_vlan":{"optionType":"global","value":"xxx"}},"name":"LANParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/lan/put/request_schema.json","title":"LAN Parcel Schema","description":"LAN profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"ip_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"netmask":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"network_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":12}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bridge":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":15}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"trunk","enum":["trunk","access"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["trunk"],"type":"string"}},"required":["optionType"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for LAN profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"interface_name":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"vlan":{"optionType":"global","value":"xxx"},"native_vlan":{"optionType":"global","value":"xxx"}},"name":"LANParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-28":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/ovsnetwork/post/request_schema.json","title":"Network Parcel Schema","description":"Network profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"network_name":{"description":"Name of the network","type":"object","$ref":"#/components/schemas/oneOfNameOptionsDef"},"interface_name":{"description":"Set interface_name","type":"object","$ref":"#/components/schemas/oneOfInterface_nameOptionsDef"},"bridge":{"description":"name of the bridge","type":"object","$ref":"#/components/schemas/oneOfBridgeOptionsDef"},"mode":{"description":"Set type of switch port: access/trunk","type":"object","$ref":"#/components/schemas/oneOfModeOptionsDef"},"vlan":{"description":"Set vlan","type":"object","$ref":"#/components/schemas/oneOfVlanOptionsDef"},"native_vlan":{"description":"Set native vlan","type":"object","$ref":"#/components/schemas/oneOfNative_lanOptionsDef"},"ip_address":{"description":"Set Subnet-address","type":"object","$ref":"#/components/schemas/oneOfAddressOptionsDef"},"netmask":{"description":"Set Subnet-mask","type":"object","$ref":"#/components/schemas/oneOfNetmaskOptionsDef"},"dhcp":{"description":"dhcp","type":"object","$ref":"#/components/schemas/oneOfDhcpOptionsDef"},"gateway":{"description":"gateway","type":"object","$ref":"#/components/schemas/oneOfGatewayOptionsDef"}},"required":["network_name"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterface_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interface_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNative_lanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_lanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfAddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDhcpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfGatewayOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/gatewayDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"nameDef":{"type":"string","maxLength":12},"interface_nameDef":{"type":"string","maxLength":15},"bridgeDef":{"minLength":1,"type":"string","maxLength":256},"modeDef":{"enum":["access","trunk"],"type":"string"},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"native_lanDef":{"type":"integer","minimum":1,"maximum":4095},"addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"gatewayDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for network profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"NetworkParcelGlobalDefault":{"value":{"data":{"name":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"native_lan":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"dhcp":{"optionType":"global","value":"xxx"},"gateway":{"optionType":"global","value":"xxx"}},"name":"NetworkParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/ovsnetwork/post/request_schema.json","title":"Network Parcel Schema","description":"Network profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"network_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":12}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":15}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bridge":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["access","trunk"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"ip_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"netmask":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"dhcp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"gateway":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["network_name"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for network profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"name":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"native_lan":{"optionType":"global","value":"xxx"},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"dhcp":{"optionType":"global","value":"xxx"},"gateway":{"optionType":"global","value":"xxx"}},"name":"NetworkParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"routesNetwork_addressDef":{"type":"string","pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/)([1-9]|[1-2][0-9]|3[012])$"},"oneOfRoutesNetwork_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/routesNetwork_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"routesNexthop_addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"oneOfRoutesNexthop_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/routesNexthop_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-29":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/routes/post/request_schema.json","title":"Routes Parcel Schema","description":"Routes profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"routes":{"description":"List of Routes","type":"array","uniqueItems":true,"minItems":0,"maxItems":25,"items":{"type":"object","properties":{"network_address":{"description":"Ip address for network","type":"object","$ref":"#/components/schemas/oneOfRoutesNetwork_addressOptionsDef"},"nexthop_address":{"description":"Ip address for next hop","type":"object","$ref":"#/components/schemas/oneOfRoutesNexthop_addressOptionsDef"}},"required":[],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfRoutesNetwork_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/routesNetwork_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRoutesNexthop_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/routesNexthop_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"routesNetwork_addressDef":{"type":"string","pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/)([1-9]|[1-2][0-9]|3[012])$"},"routesNexthop_addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Routes profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"RoutesParcelGlobalDefault":{"value":{"data":{"routes":[{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}},{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}}]},"name":"RoutesParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/routes/post/request_schema.json","title":"Routes Parcel Schema","description":"Routes profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"routes":{"description":"List of Routes","type":"array","uniqueItems":true,"minItems":0,"maxItems":25,"items":{"type":"object","properties":{"network_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/)([1-9]|[1-2][0-9]|3[012])$"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"nexthop_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for Routes profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"routes":[{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}},{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}}]},"name":"RoutesParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"$defs-routesNexthop_addressDef":{"routesNexthop_addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]}},"$defs-oneOfRoutesNexthop_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-routesNexthop_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-30":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/routes/put/request_schema.json","title":"Routes Parcel Schema","description":"Routes profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"routes":{"description":"List of Routes","type":"array","uniqueItems":true,"minItems":0,"maxItems":25,"items":{"type":"object","properties":{"network_address":{"description":"Ip address for network","type":"object","$ref":"#/components/schemas/oneOfRoutesNetwork_addressOptionsDef"},"nexthop_address":{"description":"Ip address for next hop","type":"object","$ref":"#/components/schemas/$defs-oneOfRoutesNexthop_addressOptionsDef"}},"required":[],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfRoutesNetwork_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/routesNetwork_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRoutesNexthop_addressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-routesNexthop_addressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"routesNetwork_addressDef":{"type":"string","pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/)([1-9]|[1-2][0-9]|3[012])$"},"routesNexthop_addressDef":{"routesNexthop_addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]}},"additionalProperties":false,"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Routes profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"RoutesParcelGlobalDefault":{"value":{"data":{"routes":[{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}},{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}}]},"name":"RoutesParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/routes/put/request_schema.json","title":"Routes Parcel Schema","description":"Routes profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"routes":{"description":"List of Routes","type":"array","uniqueItems":true,"minItems":0,"maxItems":25,"items":{"type":"object","properties":{"network_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/)([1-9]|[1-2][0-9]|3[012])$"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"nexthop_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"routesNexthop_addressDef":{"type":"string","anyOf":[{"format":"ipv4"}]}}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for Routes profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"routes":[{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}},{"network_address":{"optionType":"global","value":"xxx"},"nexthop_address":{"optionType":"global","value":"xxx"}}]},"name":"RoutesParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]}}}}},"interfacesInterface_nameDef":{"type":"string","enum":["gigabitEthernet1/0","gigabitEthernet1/1","gigabitEthernet1/2","gigabitEthernet1/3","gigabitEthernet1/4","gigabitEthernet1/5","gigabitEthernet1/6","gigabitEthernet1/7"]},"oneOfInterfacesInterface_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesInterface_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"interfacesVlanDef":{"type":"string","default":"1","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*)"},"oneOfInterfacesVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesVlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"interfacesModeDef":{"default":"access","enum":["trunk","access"],"type":"string"},"oneOfInterfacesModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesModeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"interfacesNative_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"oneOfInterfacesNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNative_vlanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-31":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/switch/post/request_schema.json","title":"Switch Parcel Schema","description":"Switch profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"interfaces":{"description":"List of Interfaces","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"interface_name":{"description":"Interface Name","type":"object","$ref":"#/components/schemas/oneOfInterfacesInterface_nameOptionsDef"},"vlan":{"description":"Range of VLANs for the interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesVlanOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesModeOptionsDef"},"native_vlan":{"description":"Native Vlan for the interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesNative_vlanOptionsDef"}},"required":["interface_name"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["vedge-nfvis-ENCS5400"],"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfInterfacesInterface_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesInterface_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesVlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesModeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfInterfacesNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNative_vlanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"interfacesInterface_nameDef":{"type":"string","enum":["gigabitEthernet1/0","gigabitEthernet1/1","gigabitEthernet1/2","gigabitEthernet1/3","gigabitEthernet1/4","gigabitEthernet1/5","gigabitEthernet1/6","gigabitEthernet1/7"]},"interfacesVlanDef":{"type":"string","default":"1","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*)"},"interfacesModeDef":{"default":"access","enum":["trunk","access"],"type":"string"},"interfacesNative_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Switch profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"SwitchParcelGlobalDefault":{"value":{"data":{"interfaces":[{"interface_name":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"access"},"native_vlan":{"optionType":"global","value":"xxx"}}]},"name":"SwitchParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/switch/post/request_schema.json","title":"Switch Parcel Schema","description":"Switch profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"interfaces":{"description":"List of Interfaces","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["gigabitEthernet1/0","gigabitEthernet1/1","gigabitEthernet1/2","gigabitEthernet1/3","gigabitEthernet1/4","gigabitEthernet1/5","gigabitEthernet1/6","gigabitEthernet1/7"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","default":"1","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*)"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"access","enum":["trunk","access"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["interface_name"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["vedge-nfvis-ENCS5400"],"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for Switch profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"interfaces":[{"interface_name":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"access"},"native_vlan":{"optionType":"global","value":"xxx"}}]},"name":"SwitchParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-32":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/switch/put/request_schema.json","title":"Switch Parcel Schema","description":"Switch profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"interfaces":{"description":"List of Interfaces","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"interface_name":{"description":"Interface Name","type":"object","$ref":"#/components/schemas/oneOfInterfacesInterface_nameOptionsDef"},"vlan":{"description":"Range of VLANs for the interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesVlanOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesModeOptionsDef"},"native_vlan":{"description":"Native Vlan for the interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesNative_vlanOptionsDef"}},"required":["interface_name"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["vedge-nfvis-ENCS5400"],"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfInterfacesInterface_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesInterface_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesVlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesModeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfInterfacesNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNative_vlanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"interfacesInterface_nameDef":{"type":"string","enum":["gigabitEthernet1/0","gigabitEthernet1/1","gigabitEthernet1/2","gigabitEthernet1/3","gigabitEthernet1/4","gigabitEthernet1/5","gigabitEthernet1/6","gigabitEthernet1/7"]},"interfacesVlanDef":{"type":"string","default":"1","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*)"},"interfacesModeDef":{"default":"access","enum":["trunk","access"],"type":"string"},"interfacesNative_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Switch profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"SwitchParcelGlobalDefault":{"value":{"data":{"interfaces":[{"interface_name":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"access"},"native_vlan":{"optionType":"global","value":"xxx"}}]},"name":"SwitchParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/switch/put/request_schema.json","title":"Switch Parcel Schema","description":"Switch profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"interfaces":{"description":"List of Interfaces","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["gigabitEthernet1/0","gigabitEthernet1/1","gigabitEthernet1/2","gigabitEthernet1/3","gigabitEthernet1/4","gigabitEthernet1/5","gigabitEthernet1/6","gigabitEthernet1/7"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","default":"1","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?)(,(([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-3]))?))*)"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"access","enum":["trunk","access"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["interface_name"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["vedge-nfvis-ENCS5400"],"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for Switch profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"interfaces":[{"interface_name":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"access"},"native_vlan":{"optionType":"global","value":"xxx"}}]},"name":"SwitchParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}},"additionalProperties":false},"$defs-nameDef":{"type":"string"},"defaultOptionNoDefaultDef":{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false},"$defs-oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"srcDef":{"minLength":1,"type":"string","maxLength":256},"oneOfSrcOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/srcDef"}},"required":["optionType","value"],"additionalProperties":false}]},"checksumDef":{"minLength":1,"type":"string","maxLength":256},"oneOfChecksumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/checksumDef"}},"required":["optionType","value"],"additionalProperties":false}]},"$defs-usernameDef":{"minLength":1,"type":"string","maxLength":256},"$defs-oneOfUsernameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-usernameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"$defs-passwordDef":{"minLength":1,"type":"string","maxLength":256},"$defs-oneOfPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-passwordDef"}},"required":["optionType","value"],"additionalProperties":false}]},"versionDef":{"type":"string"},"oneOfVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/versionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"vnf_typeDef":{"default":"ROUTER","type":"string"},"oneOfVnf_typeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vnf_typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLow_latencyOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfSriov_supportedOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfNocloudOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfThick_disk_provisioningOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"bootstrap_cloud_init_drive_typeDef":{"default":"cdrom","type":"string"},"oneOfBootstrap_cloud_init_drive_typeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bootstrap_cloud_init_drive_typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"root_image_disk_formatDef":{"default":"qcow2","type":"string"},"oneOfRoot_image_disk_formatOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/root_image_disk_formatDef"}},"required":["optionType","value"],"additionalProperties":false}]},"console_type_serialDef":{"type":"boolean","default":true},"oneOfConsole_type_serialOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/console_type_serialDef"}},"required":["optionType","value"],"additionalProperties":false}]},"vendorDef":{"minLength":1,"type":"string","maxLength":128},"oneOfVendorOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vendorDef"}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-33":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/post/request_schema.json","title":"VNF Attributes Parcel Schema","description":"VNF Attributes profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"image_name":{"description":"Name of the image","type":"object","$ref":"#/components/schemas/$defs-oneOfNameOptionsDef"},"src":{"description":"Source of the image to be downloaded from","type":"object","$ref":"#/components/schemas/oneOfSrcOptionsDef"},"checksum":{"description":"checksum","type":"object","$ref":"#/components/schemas/oneOfChecksumOptionsDef"},"username":{"description":"Username for the remote server","type":"object","$ref":"#/components/schemas/$defs-oneOfUsernameOptionsDef"},"password":{"description":"password for the remote server","type":"object","$ref":"#/components/schemas/$defs-oneOfPasswordOptionsDef"},"version":{"description":"Version","type":"object","$ref":"#/components/schemas/oneOfVersionOptionsDef"},"vnf_type":{"description":"VNF Type","type":"object","$ref":"#/components/schemas/oneOfVnf_typeOptionsDef"},"low_latency":{"description":"Latency","type":"object","$ref":"#/components/schemas/oneOfLow_latencyOptionsDef"},"sriov_supported":{"description":"Sriov supported","type":"object","$ref":"#/components/schemas/oneOfSriov_supportedOptionsDef"},"nocloud":{"description":"nocloud","type":"object","$ref":"#/components/schemas/oneOfNocloudOptionsDef"},"thick_disk_provisioning":{"description":"Disk Provisioning","type":"object","$ref":"#/components/schemas/oneOfThick_disk_provisioningOptionsDef"},"bootstrap_cloud_init_drive_type":{"description":"Cloud init drive type","type":"object","$ref":"#/components/schemas/oneOfBootstrap_cloud_init_drive_typeOptionsDef"},"root_image_disk_format":{"description":"Root file disk bus","type":"object","$ref":"#/components/schemas/oneOfRoot_image_disk_formatOptionsDef"},"console_type_serial":{"description":"Console Type","type":"object","$ref":"#/components/schemas/oneOfConsole_type_serialOptionsDef"},"vendor":{"description":"Name of the vendor","type":"object","$ref":"#/components/schemas/oneOfVendorOptionsDef"}},"required":["image_name","src"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"oneOfSrcOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/srcDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfChecksumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/checksumDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUsernameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-usernameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-passwordDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/versionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVnf_typeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vnf_typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLow_latencyOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfSriov_supportedOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfNocloudOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfThick_disk_provisioningOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfBootstrap_cloud_init_drive_typeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bootstrap_cloud_init_drive_typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRoot_image_disk_formatOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/root_image_disk_formatDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfConsole_type_serialOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/console_type_serialDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVendorOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vendorDef"}},"required":["optionType","value"],"additionalProperties":false}]},"nameDef":{"type":"string"},"srcDef":{"minLength":1,"type":"string","maxLength":256},"checksumDef":{"minLength":1,"type":"string","maxLength":256},"usernameDef":{"minLength":1,"type":"string","maxLength":256},"passwordDef":{"minLength":1,"type":"string","maxLength":256},"versionDef":{"type":"string"},"vnf_typeDef":{"default":"ROUTER","type":"string"},"bootstrap_cloud_init_drive_typeDef":{"default":"cdrom","type":"string"},"root_image_disk_formatDef":{"default":"qcow2","type":"string"},"vendorDef":{"minLength":1,"type":"string","maxLength":128},"console_type_serialDef":{"type":"boolean","default":true},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"name":{"optionType":"global","value":"xxx"},"src":{"optionType":"global","value":"xxx"},"checksum":{"optionType":"global","value":"xxx"},"username":{"optionType":"global","value":"xxx"},"password":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"17.10.1"},"vnf_type":{"optionType":"default","value":"ROUTER"},"low_latency":{"optionType":"default","value":true},"sriov_supported":{"optionType":"default","value":true},"nocloud":{"optionType":"global","value":"xxx"},"thick_disk_provisioning":{"optionType":"global","value":"xxx"},"bootstrap_cloud_init_drive_type":{"optionType":"default","value":"cdrom"},"root_image_disk_format":{"optionType":"default","value":"qcow2"},"console_type_serial":{"optionType":"global","value":"xxx"},"vendor":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/post/request_schema.json","title":"VNF Attributes Parcel Schema","description":"VNF Attributes profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"image_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"src":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"checksum":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"username":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"password":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"version":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"vnf_type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"ROUTER","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"low_latency":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"sriov_supported":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"nocloud":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"thick_disk_provisioning":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"bootstrap_cloud_init_drive_type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"cdrom","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"root_image_disk_format":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"qcow2","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"console_type_serial":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean","default":true}},"required":["optionType","value"],"additionalProperties":false}]},"vendor":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["image_name","src"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"name":{"optionType":"global","value":"xxx"},"src":{"optionType":"global","value":"xxx"},"checksum":{"optionType":"global","value":"xxx"},"username":{"optionType":"global","value":"xxx"},"password":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"17.10.1"},"vnf_type":{"optionType":"default","value":"ROUTER"},"low_latency":{"optionType":"default","value":true},"sriov_supported":{"optionType":"default","value":true},"nocloud":{"optionType":"global","value":"xxx"},"thick_disk_provisioning":{"optionType":"global","value":"xxx"},"bootstrap_cloud_init_drive_type":{"optionType":"default","value":"cdrom"},"root_image_disk_format":{"optionType":"default","value":"qcow2"},"console_type_serial":{"optionType":"global","value":"xxx"},"vendor":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-34":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/put/request_schema.json","title":"VNF Attributes Parcel Schema","description":"VNF Attributes profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"image_name":{"description":"Name of the image","type":"object","$ref":"#/components/schemas/$defs-oneOfNameOptionsDef"},"src":{"description":"Source of the image to be downloaded from","type":"object","$ref":"#/components/schemas/oneOfSrcOptionsDef"},"checksum":{"description":"checksum","type":"object","$ref":"#/components/schemas/oneOfChecksumOptionsDef"},"username":{"description":"Username for the remote server","type":"object","$ref":"#/components/schemas/$defs-oneOfUsernameOptionsDef"},"password":{"description":"password for the remote server","type":"object","$ref":"#/components/schemas/$defs-oneOfPasswordOptionsDef"},"version":{"description":"Version","type":"object","$ref":"#/components/schemas/oneOfVersionOptionsDef"},"vnf_type":{"description":"VNF Type","type":"object","$ref":"#/components/schemas/oneOfVnf_typeOptionsDef"},"low_latency":{"description":"Latency","type":"object","$ref":"#/components/schemas/oneOfLow_latencyOptionsDef"},"sriov_supported":{"description":"Sriov supported","type":"object","$ref":"#/components/schemas/oneOfSriov_supportedOptionsDef"},"nocloud":{"description":"nocloud","type":"object","$ref":"#/components/schemas/oneOfNocloudOptionsDef"},"thick_disk_provisioning":{"description":"Disk Provisioning","type":"object","$ref":"#/components/schemas/oneOfThick_disk_provisioningOptionsDef"},"bootstrap_cloud_init_drive_type":{"description":"Cloud init drive type","type":"object","$ref":"#/components/schemas/oneOfBootstrap_cloud_init_drive_typeOptionsDef"},"root_image_disk_format":{"description":"Root file disk bus","type":"object","$ref":"#/components/schemas/oneOfRoot_image_disk_formatOptionsDef"},"console_type_serial":{"description":"Console Type","type":"object","$ref":"#/components/schemas/oneOfConsole_type_serialOptionsDef"},"vendor":{"description":"Name of the vendor","type":"object","$ref":"#/components/schemas/oneOfVendorOptionsDef"}},"required":["image_name","src"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"oneOfSrcOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/srcDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfChecksumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/checksumDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUsernameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-usernameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-passwordDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/versionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVnf_typeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vnf_typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfLow_latencyOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfSriov_supportedOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfNocloudOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfThick_disk_provisioningOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfBootstrap_cloud_init_drive_typeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bootstrap_cloud_init_drive_typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRoot_image_disk_formatOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/root_image_disk_formatDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfConsole_type_serialOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/console_type_serialDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVendorOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vendorDef"}},"required":["optionType","value"],"additionalProperties":false}]},"nameDef":{"type":"string"},"srcDef":{"minLength":1,"type":"string","maxLength":256},"checksumDef":{"minLength":1,"type":"string","maxLength":256},"usernameDef":{"minLength":1,"type":"string","maxLength":256},"passwordDef":{"minLength":1,"type":"string","maxLength":256},"versionDef":{"type":"string"},"vnf_typeDef":{"default":"ROUTER","type":"string"},"bootstrap_cloud_init_drive_typeDef":{"default":"cdrom","type":"string"},"root_image_disk_formatDef":{"default":"qcow2","type":"string"},"vendorDef":{"minLength":1,"type":"string","maxLength":128},"console_type_serialDef":{"type":"boolean","default":true},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"name":{"optionType":"global","value":"xxx"},"src":{"optionType":"global","value":"xxx"},"checksum":{"optionType":"global","value":"xxx"},"username":{"optionType":"global","value":"xxx"},"password":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"17.10.1"},"vnf_type":{"optionType":"default","value":"ROUTER"},"low_latency":{"optionType":"default","value":true},"sriov_supported":{"optionType":"default","value":true},"nocloud":{"optionType":"global","value":"xxx"},"thick_disk_provisioning":{"optionType":"global","value":"xxx"},"bootstrap_cloud_init_drive_type":{"optionType":"default","value":"cdrom"},"root_image_disk_format":{"optionType":"default","value":"qcow2"},"console_type_serial":{"optionType":"global","value":"xxx"},"vendor":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/put/request_schema.json","title":"VNF Attributes Parcel Schema","description":"VNF Attributes profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"image_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"src":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"checksum":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"username":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"password":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":256}},"required":["optionType","value"],"additionalProperties":false}]},"version":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"vnf_type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"ROUTER","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"low_latency":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"sriov_supported":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"nocloud":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"thick_disk_provisioning":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false}]},"bootstrap_cloud_init_drive_type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"cdrom","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"root_image_disk_format":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"qcow2","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"console_type_serial":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean","default":true}},"required":["optionType","value"],"additionalProperties":false}]},"vendor":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["image_name","src"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"name":{"optionType":"global","value":"xxx"},"src":{"optionType":"global","value":"xxx"},"checksum":{"optionType":"global","value":"xxx"},"username":{"optionType":"global","value":"xxx"},"password":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"17.10.1"},"vnf_type":{"optionType":"default","value":"ROUTER"},"low_latency":{"optionType":"default","value":true},"sriov_supported":{"optionType":"default","value":true},"nocloud":{"optionType":"global","value":"xxx"},"thick_disk_provisioning":{"optionType":"global","value":"xxx"},"bootstrap_cloud_init_drive_type":{"optionType":"default","value":"cdrom"},"root_image_disk_format":{"optionType":"default","value":"qcow2"},"console_type_serial":{"optionType":"global","value":"xxx"},"vendor":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema_$defs-nameDef":{"minLength":1,"type":"string","maxLength":128},"request_schema_$defs-oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/request_schema_$defs-nameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"imageDef":{"minLength":1,"type":"string","maxLength":128},"oneOfImageOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/imageDef"}},"required":["optionType","value"],"additionalProperties":false}]},"bootup_timeDef":{"default":-1,"type":"integer"},"oneOfBootup_timeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bootup_timeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"deployment_datastoreDef":{"type":"string","enum":["datastore1","datastore2","datastore3"]},"oneOfDeployment_datastoreOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/deployment_datastoreDef"}},"required":["optionType","value"],"additionalProperties":false}]},"vcpusDef":{"type":"integer","minimum":1,"maximum":16},"oneOfVcpusOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vcpusDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"memory_mbDef":{"type":"integer","minimum":256,"maximum":73728},"oneOfMemory_mbOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/memory_mbDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"root_disk_mbDef":{"type":"integer","minimum":1024,"maximum":2048000},"oneOfRoot_disk_mbOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/root_disk_mbDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"dayZeroMount_pointDef":{"minLength":1,"type":"string","maxLength":128},"oneOfDayZeroMount_pointOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroMount_pointDef"}},"required":["optionType","value"],"additionalProperties":false}]},"dayZeroDayZeroFileContentDef":{"minLength":1,"type":"string"},"oneOfDayZeroDayZeroFileContentOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroDayZeroFileContentDef"}},"required":["optionType","value"],"additionalProperties":false}]},"dayZeroCustomPropertyNameDef":{"type":"string"},"oneOfDayZeroCustomPropertyNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"dayZeroCustomPropertyValDef":{"type":"string"},"oneOfCustomVarNameValueDef":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]},"oneOfDayZeroCustomPropertyValOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyValDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfCustomVarNameValueDef"}},"required":["optionType","value"],"additionalProperties":false}]},"dayZeroCustomPropertyEncrypted_valDef":{"type":"string"},"oneOfDayZeroCustomPropertyEncrypted_valOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyEncrypted_valDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfCustomVarNameValueDef"}},"required":["optionType","value"],"additionalProperties":false}]},"interfacesNameDef":{"minimum":1,"maximum":32,"type":"string"},"oneOfInterfacesNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"interfacesNicidDef":{"type":"integer","minimum":0,"maximum":65535},"oneOfInterfacesNicidOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNicidDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesSriovOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"$defs-vlanDef":{"type":"integer","minimum":1,"maximum":4094},"$defs-oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"disk_sizeDef":{"type":"integer","minimum":0,"maximum":2048000},"oneOfAdditionalDisksDiskSizeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/disk_sizeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"mount_pathDef":{"type":"string"},"oneOfAdditionalDisksMount_pathOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/mount_pathDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-35":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/vnf/post/request_schema.json","title":"VNF Parcel Schema","description":"VNF profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"name":{"description":"Name of the VM to be deployed","type":"object","$ref":"#/components/schemas/request_schema_$defs-oneOfNameOptionsDef"},"image":{"description":"Name of the Image to be used for VM deployment","type":"object","$ref":"#/components/schemas/oneOfImageOptionsDef"},"bootup_time":{"description":"Boot up time for the VM","type":"object","$ref":"#/components/schemas/oneOfBootup_timeOptionsDef"},"deployment_datastore":{"description":"Deployment datastore","type":"object","$ref":"#/components/schemas/oneOfDeployment_datastoreOptionsDef"},"vcpus":{"description":"Number of virtual cores for the Flavor","type":"object","$ref":"#/components/schemas/oneOfVcpusOptionsDef"},"memory_mb":{"description":"Memory in MB for the Flavor","type":"object","$ref":"#/components/schemas/oneOfMemory_mbOptionsDef"},"root_disk_mb":{"description":"Root disk size in MB","type":"object","$ref":"#/components/schemas/oneOfRoot_disk_mbOptionsDef"},"dayZero":{"description":"DayZero file","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"mount_point":{"description":"Destination for Day zero config file","type":"object","$ref":"#/components/schemas/oneOfDayZeroMount_pointOptionsDef"},"dayZeroFileContent":{"description":"Day zero config file","type":"object","$ref":"#/components/schemas/oneOfDayZeroDayZeroFileContentOptionsDef"},"customProperty":{"description":"custom property","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Name","type":"object","$ref":"#/components/schemas/oneOfDayZeroCustomPropertyNameOptionsDef"},"val":{"description":"Value","type":"object","$ref":"#/components/schemas/oneOfDayZeroCustomPropertyValOptionsDef"},"encrypted_val":{"description":"Encrypted value","type":"object","$ref":"#/components/schemas/oneOfDayZeroCustomPropertyEncrypted_valOptionsDef"}}},"additionalProperties":false}},"required":["mount_point","dayZeroFileContent"],"additionalProperties":false}},"interfaces":{"description":"Interface name","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"name":{"description":"Set network or interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesNameOptionsDef"},"nicid":{"description":"Set Nicid","type":"object","$ref":"#/components/schemas/oneOfInterfacesNicidOptionsDef"},"sriov":{"description":"Set sriov","type":"object","$ref":"#/components/schemas/oneOfInterfacesSriovOptionsDef"},"mode":{"description":"Set type of switch port: access/trunk","type":"object","$ref":"#/components/schemas/oneOfModeOptionsDef"},"vlan":{"description":"Set vlan","type":"object","$ref":"#/components/schemas/$defs-oneOfVlanOptionsDef"}},"additionalProperties":false,"allOf":[{"if":{"properties":{"sriov":{"properties":{"value":{"const":true}}}}},"then":{"required":["nicid","name"]},"else":{"required":["nicid"]}}]}},"additionalDisks":{"description":"Additional disks","type":"array","minItems":0,"maxItems":2,"items":{"type":"object","properties":{"disk_size":{"description":"Set disk size","type":"object","$ref":"#/components/schemas/oneOfAdditionalDisksDiskSizeOptionsDef"},"mount_path":{"description":"Mount path","type":"object","$ref":"#/components/schemas/oneOfAdditionalDisksMount_pathOptionsDef"}},"required":["disk_size"],"additionalProperties":false}}},"required":["name","image","vcpus","memory_mb"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/request_schema_$defs-nameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfImageOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/imageDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfBootup_timeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bootup_timeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDeployment_datastoreOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/deployment_datastoreDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVcpusOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vcpusDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfMemory_mbOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/memory_mbDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRoot_disk_mbOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/root_disk_mbDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDayZeroMount_pointOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroMount_pointDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroDayZeroFileContentOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroDayZeroFileContentDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroCustomPropertyNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroCustomPropertyValOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyValDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfCustomVarNameValueDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroCustomPropertyEncrypted_valOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyEncrypted_valDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfCustomVarNameValueDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfInterfacesNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesNicidOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNicidDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesSriovOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfAdditionalDisksDiskSizeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/disk_sizeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfAdditionalDisksMount_pathOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/mount_pathDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"nameDef":{"minLength":1,"type":"string","maxLength":128},"imageDef":{"minLength":1,"type":"string","maxLength":128},"bootup_timeDef":{"default":-1,"type":"integer"},"deployment_datastoreDef":{"type":"string","enum":["datastore1","datastore2","datastore3"]},"vcpusDef":{"type":"integer","minimum":1,"maximum":16},"memory_mbDef":{"type":"integer","minimum":256,"maximum":73728},"root_disk_mbDef":{"type":"integer","minimum":1024,"maximum":2048000},"mount_pathDef":{"type":"string"},"disk_sizeDef":{"type":"integer","minimum":0,"maximum":2048000},"dayZeroMount_pointDef":{"minLength":1,"type":"string","maxLength":128},"dayZeroDayZeroFileContentDef":{"minLength":1,"type":"string"},"dayZeroCustomPropertyNameDef":{"type":"string"},"dayZeroCustomPropertyValDef":{"type":"string"},"dayZeroCustomPropertyEncrypted_valDef":{"type":"string"},"interfacesNameDef":{"minimum":1,"maximum":32,"type":"string"},"interfacesNicidDef":{"type":"integer","minimum":0,"maximum":65535},"modeDef":{"enum":["access","trunk"],"type":"string"},"vlanDef":{"type":"integer","minimum":1,"maximum":4094},"oneOfCustomVarNameValueDef":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"name":{"optionType":"global","value":"xxx"},"image":{"optionType":"global","value":"xxx"},"bootup_time":{"optionType":"default","value":-1},"deployment_datastore":{"optionType":"global","value":"xxx"},"vcpus":{"optionType":"global","value":"xxx"},"memory_mb":{"optionType":"global","value":"xxx"},"root_disk_mb":{"optionType":"global","value":"xxx"},"dayZero":{"mount_point":{"optionType":"global","value":"xxx"},"dayZeroFileContent":{"optionType":"global","value":"xxx"},"customProperty":{"val":{"optionType":"global","value":"xxx"},"encrypted_val":{"optionType":"global","value":"xxx"}}},"interfaces":{"name":{"optionType":"global","value":"xxx"},"nicid":{"optionType":"global","value":"xxx"},"sriov":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/vnf/post/request_schema.json","title":"VNF Parcel Schema","description":"VNF profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"image":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bootup_time":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":-1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"deployment_datastore":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["datastore1","datastore2","datastore3"]}},"required":["optionType","value"],"additionalProperties":false}]},"vcpus":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":16}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"memory_mb":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":256,"maximum":73728}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"root_disk_mb":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1024,"maximum":2048000}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"dayZero":{"description":"DayZero file","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"mount_point":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"dayZeroFileContent":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"customProperty":{"description":"custom property","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"val":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]}},"required":["optionType","value"],"additionalProperties":false}]},"encrypted_val":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]}},"required":["optionType","value"],"additionalProperties":false}]}}},"additionalProperties":false}},"required":["mount_point","dayZeroFileContent"],"additionalProperties":false}},"interfaces":{"description":"Interface name","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":32,"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"nicid":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":0,"maximum":65535}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"sriov":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["access","trunk"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4094}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"allOf":[{"if":{"properties":{"sriov":{"properties":{"value":{"const":true}}}}},"then":{"required":["nicid","name"]},"else":{"required":["nicid"]}}]}},"additionalDisks":{"description":"Additional disks","type":"array","minItems":0,"maxItems":2,"items":{"type":"object","properties":{"disk_size":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":0,"maximum":2048000}},"required":["optionType","value"],"additionalProperties":false}]},"mount_path":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["disk_size"],"additionalProperties":false}}},"required":["name","image","vcpus","memory_mb"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"name":{"optionType":"global","value":"xxx"},"image":{"optionType":"global","value":"xxx"},"bootup_time":{"optionType":"default","value":-1},"deployment_datastore":{"optionType":"global","value":"xxx"},"vcpus":{"optionType":"global","value":"xxx"},"memory_mb":{"optionType":"global","value":"xxx"},"root_disk_mb":{"optionType":"global","value":"xxx"},"dayZero":{"mount_point":{"optionType":"global","value":"xxx"},"dayZeroFileContent":{"optionType":"global","value":"xxx"},"customProperty":{"val":{"optionType":"global","value":"xxx"},"encrypted_val":{"optionType":"global","value":"xxx"}}},"interfaces":{"name":{"optionType":"global","value":"xxx"},"nicid":{"optionType":"global","value":"xxx"},"sriov":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-36":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/vnf/put/request_schema.json","title":"VNF Parcel Schema","description":"VNF profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"name":{"description":"Name of the VM to be deployed","type":"object","$ref":"#/components/schemas/request_schema_$defs-oneOfNameOptionsDef"},"image":{"description":"Name of the Image to be used for VM deployment","type":"object","$ref":"#/components/schemas/oneOfImageOptionsDef"},"bootup_time":{"description":"Boot up time for the VM","type":"object","$ref":"#/components/schemas/oneOfBootup_timeOptionsDef"},"deployment_datastore":{"description":"Deployment datastore","type":"object","$ref":"#/components/schemas/oneOfDeployment_datastoreOptionsDef"},"vcpus":{"description":"Number of virtual cores for the Flavor","type":"object","$ref":"#/components/schemas/oneOfVcpusOptionsDef"},"memory_mb":{"description":"Memory in MB for the Flavor","type":"object","$ref":"#/components/schemas/oneOfMemory_mbOptionsDef"},"root_disk_mb":{"description":"Root disk size in MB","type":"object","$ref":"#/components/schemas/oneOfRoot_disk_mbOptionsDef"},"dayZero":{"description":"DayZero file","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"mount_point":{"description":"Destination for Day zero config file","type":"object","$ref":"#/components/schemas/oneOfDayZeroMount_pointOptionsDef"},"dayZeroFileContent":{"description":"Day zero config file","type":"object","$ref":"#/components/schemas/oneOfDayZeroDayZeroFileContentOptionsDef"},"customProperty":{"description":"custom property","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Name","type":"object","$ref":"#/components/schemas/oneOfDayZeroCustomPropertyNameOptionsDef"},"val":{"description":"Value","type":"object","$ref":"#/components/schemas/oneOfDayZeroCustomPropertyValOptionsDef"},"encrypted_val":{"description":"Encrypted value","type":"object","$ref":"#/components/schemas/oneOfDayZeroCustomPropertyEncrypted_valOptionsDef"}}},"additionalProperties":false}},"required":["mount_point","dayZeroFileContent"],"additionalProperties":false}},"interfaces":{"description":"Interface name","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"name":{"description":"Set network or interface","type":"object","$ref":"#/components/schemas/oneOfInterfacesNameOptionsDef"},"nicid":{"description":"Set Nicid","type":"object","$ref":"#/components/schemas/oneOfInterfacesNicidOptionsDef"},"sriov":{"description":"Set sriov","type":"object","$ref":"#/components/schemas/oneOfInterfacesSriovOptionsDef"},"mode":{"description":"Set type of switch port: access/trunk","type":"object","$ref":"#/components/schemas/oneOfModeOptionsDef"},"vlan":{"description":"Set vlan","type":"object","$ref":"#/components/schemas/$defs-oneOfVlanOptionsDef"}},"additionalProperties":false,"allOf":[{"if":{"properties":{"sriov":{"properties":{"value":{"const":true}}}}},"then":{"required":["nicid","name"]},"else":{"required":["nicid"]}}]}},"additionalDisks":{"description":"Additional disks","type":"array","minItems":0,"maxItems":2,"items":{"type":"object","properties":{"disk_size":{"description":"Set disk size","type":"object","$ref":"#/components/schemas/oneOfAdditionalDisksDiskSizeOptionsDef"},"mount_path":{"description":"Mount path","type":"object","$ref":"#/components/schemas/oneOfAdditionalDisksMount_pathOptionsDef"}},"required":["disk_size"],"additionalProperties":false}}},"required":["name","image","vcpus","memory_mb"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/request_schema_$defs-nameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfImageOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/imageDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfBootup_timeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/bootup_timeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDeployment_datastoreOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/deployment_datastoreDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVcpusOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vcpusDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfMemory_mbOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/memory_mbDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRoot_disk_mbOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/root_disk_mbDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDayZeroMount_pointOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroMount_pointDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroDayZeroFileContentOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroDayZeroFileContentDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroCustomPropertyNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroCustomPropertyValOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyValDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfCustomVarNameValueDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfDayZeroCustomPropertyEncrypted_valOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/dayZeroCustomPropertyEncrypted_valDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/variableOptionTypeDef"},"value":{"$ref":"#/components/schemas/oneOfCustomVarNameValueDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfInterfacesNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesNicidOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/interfacesNicidDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfInterfacesSriovOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfAdditionalDisksDiskSizeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/disk_sizeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfAdditionalDisksMount_pathOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/mount_pathDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"nameDef":{"minLength":1,"type":"string","maxLength":128},"imageDef":{"minLength":1,"type":"string","maxLength":128},"bootup_timeDef":{"default":-1,"type":"integer"},"deployment_datastoreDef":{"type":"string","enum":["datastore1","datastore2","datastore3"]},"vcpusDef":{"type":"integer","minimum":1,"maximum":16},"memory_mbDef":{"type":"integer","minimum":256,"maximum":73728},"root_disk_mbDef":{"type":"integer","minimum":1024,"maximum":2048000},"mount_pathDef":{"type":"string"},"disk_sizeDef":{"type":"integer","minimum":0,"maximum":2048000},"dayZeroMount_pointDef":{"minLength":1,"type":"string","maxLength":128},"dayZeroDayZeroFileContentDef":{"minLength":1,"type":"string"},"dayZeroCustomPropertyNameDef":{"type":"string"},"dayZeroCustomPropertyValDef":{"type":"string"},"dayZeroCustomPropertyEncrypted_valDef":{"type":"string"},"interfacesNameDef":{"minimum":1,"maximum":32,"type":"string"},"interfacesNicidDef":{"type":"integer","minimum":0,"maximum":65535},"modeDef":{"enum":["access","trunk"],"type":"string"},"vlanDef":{"type":"integer","minimum":1,"maximum":4094},"oneOfCustomVarNameValueDef":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"name":{"optionType":"global","value":"xxx"},"image":{"optionType":"global","value":"xxx"},"bootup_time":{"optionType":"default","value":-1},"deployment_datastore":{"optionType":"global","value":"xxx"},"vcpus":{"optionType":"global","value":"xxx"},"memory_mb":{"optionType":"global","value":"xxx"},"root_disk_mb":{"optionType":"global","value":"xxx"},"dayZero":{"mount_point":{"optionType":"global","value":"xxx"},"dayZeroFileContent":{"optionType":"global","value":"xxx"},"customProperty":{"val":{"optionType":"global","value":"xxx"},"encrypted_val":{"optionType":"global","value":"xxx"}}},"interfaces":{"name":{"optionType":"global","value":"xxx"},"nicid":{"optionType":"global","value":"xxx"},"sriov":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/vnf-attributes/vnf/put/request_schema.json","title":"VNF Parcel Schema","description":"VNF profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"image":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bootup_time":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":-1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"deployment_datastore":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["datastore1","datastore2","datastore3"]}},"required":["optionType","value"],"additionalProperties":false}]},"vcpus":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":16}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"memory_mb":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":256,"maximum":73728}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"root_disk_mb":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1024,"maximum":2048000}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"dayZero":{"description":"DayZero file","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"mount_point":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"dayZeroFileContent":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"customProperty":{"description":"custom property","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"val":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]}},"required":["optionType","value"],"additionalProperties":false}]},"encrypted_val":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"oneOf":[{"type":"string","pattern":"^\\{\\{([a-zA-Z0-9.\\-_]+):([a-zA-Z0-9.\\-_]+)\\}\\}$","minLength":1,"maxLength":256},{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":64}]}},"required":["optionType","value"],"additionalProperties":false}]}}},"additionalProperties":false}},"required":["mount_point","dayZeroFileContent"],"additionalProperties":false}},"interfaces":{"description":"Interface name","type":"array","uniqueItems":true,"minItems":0,"maxItems":8,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":32,"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"nicid":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":0,"maximum":65535}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"sriov":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["access","trunk"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4094}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"allOf":[{"if":{"properties":{"sriov":{"properties":{"value":{"const":true}}}}},"then":{"required":["nicid","name"]},"else":{"required":["nicid"]}}]}},"additionalDisks":{"description":"Additional disks","type":"array","minItems":0,"maxItems":2,"items":{"type":"object","properties":{"disk_size":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":0,"maximum":2048000}},"required":["optionType","value"],"additionalProperties":false}]},"mount_path":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["disk_size"],"additionalProperties":false}}},"required":["name","image","vcpus","memory_mb"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"name":{"optionType":"global","value":"xxx"},"image":{"optionType":"global","value":"xxx"},"bootup_time":{"optionType":"default","value":-1},"deployment_datastore":{"optionType":"global","value":"xxx"},"vcpus":{"optionType":"global","value":"xxx"},"memory_mb":{"optionType":"global","value":"xxx"},"root_disk_mb":{"optionType":"global","value":"xxx"},"dayZero":{"mount_point":{"optionType":"global","value":"xxx"},"dayZeroFileContent":{"optionType":"global","value":"xxx"},"customProperty":{"val":{"optionType":"global","value":"xxx"},"encrypted_val":{"optionType":"global","value":"xxx"}}},"interfaces":{"name":{"optionType":"global","value":"xxx"},"nicid":{"optionType":"global","value":"xxx"},"sriov":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"xxx"},"vlan":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"colorDef":{"enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"],"type":"string"},"oneOfColorOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/colorDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"wanInterfaceNameDef":{"type":"string"},"oneOfWanInterfaceNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/wanInterfaceNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema_$defs-modeDef":{"enum":["trunk","access"],"type":"string"},"request_schema_$defs-oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/request_schema_$defs-modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultModeDef"}},"required":["optionType"],"additionalProperties":false}]},"$defs-oneOfDhcpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"ipv4AddressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"oneOfIpv4AddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfShutdownOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"defaultGatewayDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"oneOfDefaultGatewayOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultGatewayDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"typeDef":{"type":"string","enum":["primary","secondary(1)","none"]},"oneOfTypeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-37":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/wan/post/request_schema.json","title":"WAN Parcel Schema","description":"WAN profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"color":{"description":"Color","type":"object","$ref":"#/components/schemas/oneOfColorOptionsDef"},"interface_name":{"description":"WAN interface or Port name","type":"object","$ref":"#/components/schemas/oneOfWanInterfaceNameOptionsDef"},"network_name":{"description":"Name of the WAN Network","type":"object","$ref":"#/components/schemas/oneOfNetwork_nameOptionsDef"},"bridge":{"description":"Name of the WAN Bridge","type":"object","$ref":"#/components/schemas/$defs-oneOfBridgeOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","$ref":"#/components/schemas/request_schema_$defs-oneOfModeOptionsDef"},"dhcp":{"description":"dhcp","type":"object","$ref":"#/components/schemas/$defs-oneOfDhcpOptionsDef"},"ip_address":{"description":"IPv4 address on WAN interface","type":"object","$ref":"#/components/schemas/oneOfIpv4AddressOptionsDef"},"netmask":{"description":"subnet mask","type":"object","$ref":"#/components/schemas/oneOfNetmaskOptionsDef"},"shutdown":{"description":"Shutdown for WAN Interface","type":"object","$ref":"#/components/schemas/oneOfShutdownOptionsDef"},"defaultGateway":{"description":"Set Default Gateway","type":"object","$ref":"#/components/schemas/oneOfDefaultGatewayOptionsDef"},"type":{"description":"Set admin distance","type":"object","$ref":"#/components/schemas/oneOfTypeOptionsDef"},"vlan":{"description":"Range of VLANs for the network","type":"object","$ref":"#/components/schemas/oneOfVlanOptionsDef"},"native_vlan":{"description":"Native Vlan for the network","type":"object","$ref":"#/components/schemas/oneOfNative_vlanOptionsDef"}},"additionalProperties":false,"allOf":[{"if":{"properties":{"dhcp":{"properties":{"value":{"const":false}}}}},"then":{"required":["color","interface_name","ip_address","netmask","type"]},"else":{"required":["color"]}}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfColorOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/colorDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfWanInterfaceNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/wanInterfaceNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetwork_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/network_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/request_schema_$defs-modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultModeDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfDhcpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfIpv4AddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfShutdownOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfDefaultGatewayOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultGatewayDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTypeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"colorDef":{"enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"],"type":"string"},"wanInterfaceNameDef":{"type":"string"},"network_nameDef":{"type":"string","maxLength":12},"bridgeDef":{"type":"string","maxLength":15},"modeDef":{"enum":["trunk","access"],"type":"string"},"ipv4AddressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"netmaskDef":{"type":"string"},"defaultGatewayDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"defaultModeDef":{"enum":["trunk"],"type":"string"},"typeDef":{"type":"string","enum":["primary","secondary(1)","none"]},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"native_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for WAN Interface profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"WANInterfaceParcelGlobalDefault":{"value":{"data":{"color":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"xxx"}},"name":"WANInterfaceParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/wan/post/request_schema.json","title":"WAN Parcel Schema","description":"WAN profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"color":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"network_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":12}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bridge":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":15}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["trunk","access"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["trunk"],"type":"string"}},"required":["optionType"],"additionalProperties":false}]},"dhcp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType"],"additionalProperties":false}]},"ip_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"netmask":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"shutdown":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType"],"additionalProperties":false}]},"defaultGateway":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["primary","secondary(1)","none"]}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"allOf":[{"if":{"properties":{"dhcp":{"properties":{"value":{"const":false}}}}},"then":{"required":["color","interface_name","ip_address","netmask","type"]},"else":{"required":["color"]}}]},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for WAN Interface profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"color":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"xxx"}},"name":"WANInterfaceParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-38":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/wan/put/request_schema.json","title":"WAN Parcel Schema","description":"WAN profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"color":{"description":"Color","type":"object","$ref":"#/components/schemas/oneOfColorOptionsDef"},"interface_name":{"description":"WAN interface or Port name","type":"object","$ref":"#/components/schemas/oneOfWanInterfaceNameOptionsDef"},"network_name":{"description":"Name of the WAN Network","type":"object","$ref":"#/components/schemas/oneOfNetwork_nameOptionsDef"},"bridge":{"description":"Name of the WAN Bridge","type":"object","$ref":"#/components/schemas/$defs-oneOfBridgeOptionsDef"},"mode":{"description":"Trunk or Access Mode of the Interface","type":"object","$ref":"#/components/schemas/request_schema_$defs-oneOfModeOptionsDef"},"dhcp":{"description":"dhcp","type":"object","$ref":"#/components/schemas/$defs-oneOfDhcpOptionsDef"},"ip_address":{"description":"IPv4 address on WAN interface","type":"object","$ref":"#/components/schemas/oneOfIpv4AddressOptionsDef"},"netmask":{"description":"subnet mask","type":"object","$ref":"#/components/schemas/oneOfNetmaskOptionsDef"},"shutdown":{"description":"Shutdown for WAN Interface","type":"object","$ref":"#/components/schemas/oneOfShutdownOptionsDef"},"defaultGateway":{"description":"Set Default Gateway","type":"object","$ref":"#/components/schemas/oneOfDefaultGatewayOptionsDef"},"type":{"description":"Set admin distance","type":"object","$ref":"#/components/schemas/oneOfTypeOptionsDef"},"vlan":{"description":"Range of VLANs for the network","type":"object","$ref":"#/components/schemas/oneOfVlanOptionsDef"},"native_vlan":{"description":"Native Vlan for the network","type":"object","$ref":"#/components/schemas/oneOfNative_vlanOptionsDef"}},"additionalProperties":false,"allOf":[{"if":{"properties":{"dhcp":{"properties":{"value":{"const":false}}}}},"then":{"required":["color","interface_name","ip_address","netmask","type"]},"else":{"required":["color"]}}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfColorOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/colorDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfWanInterfaceNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/wanInterfaceNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetwork_nameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/network_nameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBridgeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-bridgeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfModeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/request_schema_$defs-modeDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultModeDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfDhcpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfIpv4AddressOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNetmaskOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/ipv4SubnetMaskDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfShutdownOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfDefaultGatewayOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultGatewayDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTypeOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/typeDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfVlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfNative_vlanOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/native_vlanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"colorDef":{"enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"],"type":"string"},"wanInterfaceNameDef":{"type":"string"},"network_nameDef":{"type":"string","maxLength":12},"bridgeDef":{"type":"string","maxLength":15},"modeDef":{"enum":["trunk","access"],"type":"string"},"ipv4AddressDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"netmaskDef":{"type":"string"},"defaultGatewayDef":{"type":"string","anyOf":[{"format":"ipv4"}]},"defaultModeDef":{"enum":["trunk"],"type":"string"},"typeDef":{"type":"string","enum":["primary","secondary(1)","none"]},"vlanDef":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"},"native_vlanDef":{"type":"integer","minimum":1,"maximum":4095},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for WAN Interface profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"WANInterfaceParcelGlobalDefault":{"value":{"data":{"color":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"xxx"}},"name":"WANInterfaceParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/networks/wan/put/request_schema.json","title":"WAN Parcel Schema","description":"WAN profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"color":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["default","mpls","metro-ethernet","biz-internet","public-internet","lte","3g","red","green","blue","gold","silver","bronze","custom1","custom2","custom3","private1","private2","private3","private4","private5","private6"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"interface_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"network_name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":12}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"bridge":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","maxLength":15}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"mode":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["trunk","access"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["trunk"],"type":"string"}},"required":["optionType"],"additionalProperties":false}]},"dhcp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType"],"additionalProperties":false}]},"ip_address":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"netmask":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["255.255.255.255","255.255.255.254","255.255.255.252","255.255.255.248","255.255.255.240","255.255.255.224","255.255.255.192","255.255.255.128","255.255.255.0","255.255.254.0","255.255.252.0","255.255.248.0","255.255.240.0","255.255.224.0","255.255.192.0","255.255.128.0","255.255.0.0","255.254.0.0","255.252.0.0","255.240.0.0","255.224.0.0","255.192.0.0","255.128.0.0","255.0.0.0","254.0.0.0","252.0.0.0","248.0.0.0","240.0.0.0","224.0.0.0","192.0.0.0","128.0.0.0","0.0.0.0"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"shutdown":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType"],"additionalProperties":false}]},"defaultGateway":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"type":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["primary","secondary(1)","none"]}},"required":["optionType","value"],"additionalProperties":false}]},"vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","pattern":"((([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5])(-([1-9][0-9]{0,2}|1[0-9]{3}|2[0-2][0-9]{2}|23[0-4][0-9]|24[5-9][0-9]|2[5-9][0-9][0-9]|3[0-9]{3}|40[0-8][0-9]|409[0-5]))?))"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"native_vlan":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"integer","minimum":1,"maximum":4095}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"allOf":[{"if":{"properties":{"dhcp":{"properties":{"value":{"const":false}}}}},"then":{"required":["color","interface_name","ip_address","netmask","type"]},"else":{"required":["color"]}}]},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for WAN Interface profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"color":{"optionType":"global","value":"xxx"},"interface_name":{"optionType":"global","value":"xxx"},"network_name":{"optionType":"global","value":"xxx"},"bridge":{"optionType":"global","value":"xxx"},"mode":{"optionType":"global","value":"trunk"},"dhcp":{"optionType":"default","value":false},"ip_address":{"optionType":"global","value":"xxx"},"netmask":{"optionType":"global","value":"xxx"},"shutdown":{"optionType":"default","value":false},"defaultGateway":{"optionType":"global","value":"xxx"}},"name":"WANInterfaceParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"$defs-userNameDef":{"minLength":1,"type":"string","maxLength":128},"$defs-oneOfUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-userNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"$defs-userPasswordDef":{"type":"string"},"$defs-oneOfUserPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-userPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"userRoleDef":{"enum":["administrators","operators","auditors"],"type":"string"},"oneOfUserRoleOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userRoleDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"authOrderAuthenticationDef":{"enum":["local","tacacs"],"type":"string"},"oneOfAuthOrderAuthenticationOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/authOrderAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"tacacsHostDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"oneOfTacacsHostOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsHostDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"tacacsKeyEnumDef":{"default":"0","enum":["0","7"],"type":"string"},"oneOfTacacsKeyEnumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsKeyEnumDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"tacacsSharedSecretDef":{"type":"string"},"oneOfTacacsSharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsSharedSecretDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"tacacsAdminPrivDef":{"default":15,"maximum":15,"minimum":1,"type":"integer"},"oneOfTacacsAdminPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsAdminPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"tacacsOperPrivDef":{"default":11,"maximum":15,"minimum":1,"type":"integer"},"oneOfTacacsOperPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsOperPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]},"radiusHostDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"oneOfRadiusHostOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusHostDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"radiusKeyEnumDef":{"default":"0","enum":["0","7"],"type":"string"},"oneOfRadiusKeyEnumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusKeyEnumDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"radiusSharedSecretDef":{"type":"string"},"oneOfRadiusSharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusSharedSecretDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"radiusAdminPrivDef":{"default":15,"maximum":15,"minimum":1,"type":"integer"},"oneOfRadiusAdminPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusAdminPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"radiusOperPrivDef":{"default":11,"maximum":15,"minimum":1,"type":"integer"},"oneOfRadiusOperPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusOperPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]},"request_schema-39":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/aaa/post/request_schema.json","title":"AAA Parcel Schema","description":"AAA profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"name":{"description":"Set the username","type":"object","$ref":"#/components/schemas/$defs-oneOfUserNameOptionsDef"},"nfvisPassword":{"description":"Set the user password","type":"object","$ref":"#/components/schemas/$defs-oneOfUserPasswordOptionsDef"},"role":{"description":"Set Role for this user","type":"object","$ref":"#/components/schemas/oneOfUserRoleOptionsDef"}},"required":["name","nfvisPassword","role"],"additionalProperties":false}},"auth-order":{"description":"Set order to try different authentication methods","type":"array","uniqueItems":true,"maxItems":2,"items":{"type":"object","properties":{"authentication":{"description":"Authentication method","type":"object","$ref":"#/components/schemas/oneOfAuthOrderAuthenticationOptionsDef"}},"required":["authentication"],"additionalProperties":false}},"tacacs":{"description":"Configure the TACACS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"description":"Set IP address of TACACS server","type":"object","$ref":"#/components/schemas/oneOfTacacsHostOptionsDef"},"key":{"description":"Set Key for Tacacs","type":"object","$ref":"#/components/schemas/oneOfTacacsKeyEnumOptionsDef"},"shared-secret":{"description":"Shared Secret for TACACS","type":"object","$ref":"#/components/schemas/oneOfTacacsSharedSecretOptionsDef"},"admin-priv":{"description":"Admin Privileges of TACACS server","type":"object","$ref":"#/components/schemas/oneOfTacacsAdminPrivOptionsDef"},"oper-priv":{"description":"Oper Privileges the TACACS server","type":"object","$ref":"#/components/schemas/oneOfTacacsOperPrivOptionsDef"}},"required":["host"],"additionalProperties":false}},"radius":{"description":"Configure the RADIUS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"description":"Set IP address of RADIUS server","type":"object","$ref":"#/components/schemas/oneOfRadiusHostOptionsDef"},"key":{"description":"Set Key for RADIUS","type":"object","$ref":"#/components/schemas/oneOfRadiusKeyEnumOptionsDef"},"shared-secret":{"description":"Shared Secret for RADIUS","type":"object","$ref":"#/components/schemas/oneOfRadiusSharedSecretOptionsDef"},"admin-priv":{"description":"Admin Privileges of RADIUS server","type":"object","$ref":"#/components/schemas/oneOfRadiusAdminPrivOptionsDef"},"oper-priv":{"description":"Oper Privileges the RADIUS server","type":"object","$ref":"#/components/schemas/oneOfRadiusOperPrivOptionsDef"}},"required":["host"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-userNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-userPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserRoleOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userRoleDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfAuthOrderAuthenticationOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/authOrderAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTacacsHostOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsHostDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTacacsKeyEnumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsKeyEnumDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTacacsSharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsSharedSecretDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTacacsAdminPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsAdminPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTacacsOperPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsOperPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusHostOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusHostDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRadiusKeyEnumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusKeyEnumDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusSharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusSharedSecretDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRadiusAdminPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusAdminPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusOperPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusOperPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]},"userNameDef":{"minLength":1,"type":"string","maxLength":128},"userPasswordDef":{"type":"string"},"userRoleDef":{"enum":["administrators","operators","auditors"],"type":"string"},"authOrderAuthenticationDef":{"enum":["local","tacacs"],"type":"string"},"tacacsHostDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"tacacsKeyEnumDef":{"default":"0","enum":["0","7"],"type":"string"},"tacacsSharedSecretDef":{"type":"string"},"tacacsAdminPrivDef":{"default":15,"maximum":15,"minimum":1,"type":"integer"},"tacacsOperPrivDef":{"default":11,"maximum":15,"minimum":1,"type":"integer"},"radiusHostDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"radiusKeyEnumDef":{"default":"0","enum":["0","7"],"type":"string"},"radiusSharedSecretDef":{"type":"string"},"radiusAdminPrivDef":{"default":15,"maximum":15,"minimum":1,"type":"integer"},"radiusOperPrivDef":{"default":11,"maximum":15,"minimum":1,"type":"integer"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"user":{"name":{"optionType":"global","value":"xxx"},"nfvisPassword":{"optionType":"global","value":"xxx"},"privilege":{"optionType":"default","value":"15"}},"auth-order":{"authentication":{"optionType":"global","value":"xxx"}},"tacacs":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}},"radius":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/aaa/post/request_schema.json","title":"AAA Parcel Schema","description":"AAA profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"nfvisPassword":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"role":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["administrators","operators","auditors"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","nfvisPassword","role"],"additionalProperties":false}},"auth-order":{"description":"Set order to try different authentication methods","type":"array","uniqueItems":true,"maxItems":2,"items":{"type":"object","properties":{"authentication":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["local","tacacs"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["authentication"],"additionalProperties":false}},"tacacs":{"description":"Configure the TACACS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"key":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"0","enum":["0","7"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"shared-secret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"admin-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":15,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oper-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":11,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["host"],"additionalProperties":false}},"radius":{"description":"Configure the RADIUS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"key":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"0","enum":["0","7"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"shared-secret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"admin-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":15,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oper-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":11,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["host"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"user":{"name":{"optionType":"global","value":"xxx"},"nfvisPassword":{"optionType":"global","value":"xxx"},"privilege":{"optionType":"default","value":"15"}},"auth-order":{"authentication":{"optionType":"global","value":"xxx"}},"tacacs":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}},"radius":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-40":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/aaa/put/request_schema.json","title":"AAA Parcel Schema","description":"AAA profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"name":{"description":"Set the username","type":"object","$ref":"#/components/schemas/$defs-oneOfUserNameOptionsDef"},"nfvisPassword":{"description":"Set the user password","type":"object","$ref":"#/components/schemas/$defs-oneOfUserPasswordOptionsDef"},"role":{"description":"Set Role for this user","type":"object","$ref":"#/components/schemas/oneOfUserRoleOptionsDef"}},"required":["name","nfvisPassword","role"],"additionalProperties":false}},"auth-order":{"description":"Set order to try different authentication methods","type":"array","uniqueItems":true,"maxItems":2,"items":{"type":"object","properties":{"authentication":{"description":"Authentication method","type":"object","$ref":"#/components/schemas/oneOfAuthOrderAuthenticationOptionsDef"}},"required":["authentication"],"additionalProperties":false}},"tacacs":{"description":"Configure the TACACS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"description":"Set IP address of TACACS server","type":"object","$ref":"#/components/schemas/oneOfTacacsHostOptionsDef"},"key":{"description":"Set Key for Tacacs","type":"object","$ref":"#/components/schemas/oneOfTacacsKeyEnumOptionsDef"},"shared-secret":{"description":"Shared Secret for TACACS","type":"object","$ref":"#/components/schemas/oneOfTacacsSharedSecretOptionsDef"},"admin-priv":{"description":"Admin Privileges of TACACS server","type":"object","$ref":"#/components/schemas/oneOfTacacsAdminPrivOptionsDef"},"oper-priv":{"description":"Oper Privileges the TACACS server","type":"object","$ref":"#/components/schemas/oneOfTacacsOperPrivOptionsDef"}},"required":["host"],"additionalProperties":false}},"radius":{"description":"Configure the RADIUS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"description":"Set IP address of RADIUS server","type":"object","$ref":"#/components/schemas/oneOfRadiusHostOptionsDef"},"key":{"description":"Set Key for RADIUS","type":"object","$ref":"#/components/schemas/oneOfRadiusKeyEnumOptionsDef"},"shared-secret":{"description":"Shared Secret for RADIUS","type":"object","$ref":"#/components/schemas/oneOfRadiusSharedSecretOptionsDef"},"admin-priv":{"description":"Admin Privileges of RADIUS server","type":"object","$ref":"#/components/schemas/oneOfRadiusAdminPrivOptionsDef"},"oper-priv":{"description":"Oper Privileges the RADIUS server","type":"object","$ref":"#/components/schemas/oneOfRadiusOperPrivOptionsDef"}},"required":["host"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-userNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserPasswordOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-userPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserRoleOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userRoleDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfAuthOrderAuthenticationOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/authOrderAuthenticationDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTacacsHostOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsHostDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTacacsKeyEnumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsKeyEnumDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTacacsSharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsSharedSecretDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfTacacsAdminPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsAdminPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfTacacsOperPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/tacacsOperPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusHostOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusHostDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRadiusKeyEnumOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusKeyEnumDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusSharedSecretOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusSharedSecretDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfRadiusAdminPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusAdminPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfRadiusOperPrivOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/radiusOperPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]},"userNameDef":{"minLength":1,"type":"string","maxLength":128},"userPasswordDef":{"type":"string"},"userRoleDef":{"enum":["administrators","operators","auditors"],"type":"string"},"authOrderAuthenticationDef":{"enum":["local","tacacs"],"type":"string"},"tacacsHostDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"tacacsKeyEnumDef":{"default":"0","enum":["0","7"],"type":"string"},"tacacsSharedSecretDef":{"type":"string"},"tacacsAdminPrivDef":{"default":15,"maximum":15,"minimum":1,"type":"integer"},"tacacsOperPrivDef":{"default":11,"maximum":15,"minimum":1,"type":"integer"},"radiusHostDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"radiusKeyEnumDef":{"default":"0","enum":["0","7"],"type":"string"},"radiusSharedSecretDef":{"type":"string"},"radiusAdminPrivDef":{"default":15,"maximum":15,"minimum":1,"type":"integer"},"radiusOperPrivDef":{"default":11,"maximum":15,"minimum":1,"type":"integer"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"user":{"name":{"optionType":"global","value":"xxx"},"nfvisPassword":{"optionType":"global","value":"xxx"},"privilege":{"optionType":"default","value":"15"}},"auth-order":{"authentication":{"optionType":"global","value":"xxx"}},"tacacs":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}},"radius":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/aaa/put/request_schema.json","title":"AAA Parcel Schema","description":"AAA profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"user":{"description":"Create local login account","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"nfvisPassword":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"role":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["administrators","operators","auditors"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","nfvisPassword","role"],"additionalProperties":false}},"auth-order":{"description":"Set order to try different authentication methods","type":"array","uniqueItems":true,"maxItems":2,"items":{"type":"object","properties":{"authentication":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["local","tacacs"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["authentication"],"additionalProperties":false}},"tacacs":{"description":"Configure the TACACS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"key":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"0","enum":["0","7"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"shared-secret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"admin-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":15,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oper-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":11,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["host"],"additionalProperties":false}},"radius":{"description":"Configure the RADIUS server","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"host":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"key":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"0","enum":["0","7"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["0"]}},"required":["optionType","value"],"additionalProperties":false}]},"shared-secret":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"admin-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":15,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":15,"maximum":15,"minimum":15}},"required":["optionType","value"],"additionalProperties":false}]},"oper-priv":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":11,"maximum":15,"minimum":1,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"integer","default":11,"maximum":11,"minimum":11}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["host"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"user":{"name":{"optionType":"global","value":"xxx"},"nfvisPassword":{"optionType":"global","value":"xxx"},"privilege":{"optionType":"default","value":"15"}},"auth-order":{"authentication":{"optionType":"global","value":"xxx"}},"tacacs":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}},"radius":{"host":{"optionType":"global","value":"xxx"},"key":{"optionType":"global","value":"xxx"},"shared-secret":{"optionType":"global","value":"xxx"},"admin-priv":{"optionType":"global","value":"xxx"},"oper-priv":{"optionType":"global","value":"xxx"}}},"name":"[parcelType]ParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"loginDef":{"minLength":1,"type":"string","maxLength":2048},"oneOfLoginOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/loginDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"motdDef":{"minLength":1,"type":"string","maxLength":2048},"oneOfMotdOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/motdDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"request_schema-41":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/banner/post/request_schema.json","title":"Banner Parcel Schema","description":"Banner profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"login":{"description":"Set message to display before login prompt","type":"object","$ref":"#/components/schemas/oneOfLoginOptionsDef"},"motd":{"description":"Set message to display after a user logs in","type":"object","$ref":"#/components/schemas/oneOfMotdOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfLoginOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/loginDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"oneOfMotdOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/motdDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"loginDef":{"minLength":1,"type":"string","maxLength":2048},"motdDef":{"minLength":1,"type":"string","maxLength":2048},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for banner profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"login":{"optionType":"global","value":"xxx"},"motd":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/banner/post/request_schema.json","title":"Banner Parcel Schema","description":"Banner profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"login":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":2048}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"motd":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":2048}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for banner profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"login":{"optionType":"global","value":"xxx"},"motd":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-42":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/banner/put/request_schema.json","title":"Banner Parcel Schema","description":"Banner profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"login":{"description":"Set message to display before login prompt","type":"object","$ref":"#/components/schemas/oneOfLoginOptionsDef"},"motd":{"description":"Set message to display after a user logs in","type":"object","$ref":"#/components/schemas/oneOfMotdOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfLoginOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/loginDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"oneOfMotdOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/motdDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"$ref":"#/components/schemas/defaultOptionNoDefaultDef"}]},"loginDef":{"minLength":1,"type":"string","maxLength":2048},"motdDef":{"minLength":1,"type":"string","maxLength":2048},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for banner profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"login":{"optionType":"global","value":"xxx"},"motd":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/banner/put/request_schema.json","title":"Banner Parcel Schema","description":"Banner profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"login":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":2048}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]},"motd":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":2048}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]}},"required":["optionType"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for banner profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"login":{"optionType":"global","value":"xxx"},"motd":{"optionType":"global","value":"xxx"}},"name":"[parcelType]ParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"hostIpAddressNameDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"oneOfHostIpAddressNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostIpAddressNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"severityDef":{"default":"information","enum":["emergency","alert","critical","error","warn","notice","information","debug"],"type":"string"},"defaultSeverityDef":{"type":"string","enum":["information"]},"oneOfSeverityOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/severityDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultSeverityDef"}},"required":["optionType"],"additionalProperties":false}]},"request_schema-43":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/logging/post/request_schema.json","title":"[parcelType] Parcel Schema","description":"Logging profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"host-ip-address":{"description":"Enable logging to remote server","type":"array","uniqueItems":true,"minItems":0,"maxItems":4,"items":{"type":"object","properties":{"name":{"description":"Set hostname or IPv4 address of server","type":"object","$ref":"#/components/schemas/oneOfHostIpAddressNameOptionsDef"}},"required":["name"],"additionalProperties":false}},"severity":{"description":"Set logging level for messages logged","type":"object","$ref":"#/components/schemas/oneOfSeverityOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfHostIpAddressNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostIpAddressNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfSeverityOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/severityDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultSeverityDef"}},"required":["optionType"],"additionalProperties":false}]},"hostIpAddressNameDef":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]},"defaultSeverityDef":{"type":"string","enum":["information"]},"severityDef":{"default":"information","enum":["emergency","alert","critical","error","warn","notice","information","debug"],"type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"host-ip-address":{"name":{"optionType":"global","value":"xxx"}},"severity":{"optionType":"default","value":"information"}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/logging/post/request_schema.json","title":"[parcelType] Parcel Schema","description":"Logging profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"host-ip-address":{"description":"Enable logging to remote server","type":"array","uniqueItems":true,"minItems":0,"maxItems":4,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"hostname"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name"],"additionalProperties":false}},"severity":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"information","enum":["emergency","alert","critical","error","warn","notice","information","debug"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["information"]}},"required":["optionType"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"host-ip-address":{"name":{"optionType":"global","value":"xxx"}},"severity":{"optionType":"default","value":"information"}},"name":"[parcelType]ParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"$defs-hostIpAddressNameDef":{"type":"string"},"$defs-oneOfHostIpAddressNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-hostIpAddressNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-44":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/logging/put/request_schema.json","title":"[parcelType] Parcel Schema","description":"Logging profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"host-ip-address":{"description":"Enable logging to remote server","type":"array","uniqueItems":true,"minItems":0,"maxItems":4,"items":{"type":"object","properties":{"name":{"description":"Set hostname or IPv4 address of server","type":"object","$ref":"#/components/schemas/$defs-oneOfHostIpAddressNameOptionsDef"}},"required":["name"],"additionalProperties":false}},"severity":{"description":"Set logging level for messages logged","type":"object","$ref":"#/components/schemas/oneOfSeverityOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfHostIpAddressNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/$defs-hostIpAddressNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfSeverityOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/severityDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultSeverityDef"}},"required":["optionType"],"additionalProperties":false}]},"hostIpAddressNameDef":{"type":"string"},"defaultSeverityDef":{"type":"string","enum":["information"]},"severityDef":{"default":"information","enum":["emergency","alert","critical","error","warn","notice","information","debug"],"type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"host-ip-address":{"name":{"optionType":"global","value":"xxx"}},"severity":{"optionType":"default","value":"information"}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/logging/put/request_schema.json","title":"[parcelType] Parcel Schema","description":"Logging profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"host-ip-address":{"description":"Enable logging to remote server","type":"array","uniqueItems":true,"minItems":0,"maxItems":4,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name"],"additionalProperties":false}},"severity":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"information","enum":["emergency","alert","critical","error","warn","notice","information","debug"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["information"]}},"required":["optionType"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for [parcelType] profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"host-ip-address":{"name":{"optionType":"global","value":"xxx"}},"severity":{"optionType":"default","value":"information"}},"name":"[parcelType]ParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"preferred_serverDef":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]},"oneOfPreferred_serverOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/preferred_serverDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"backup_serverDef":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]},"oneOfBackup_serverOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/backup_serverDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-45":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/ntp/post/request_schema.json","title":"Ntp Parcel Schema","description":"Ntp profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"preferred_server":{"description":"Set Preferred server","type":"object","$ref":"#/components/schemas/oneOfPreferred_serverOptionsDef"},"backup_server":{"description":"Set up back up server","type":"object","$ref":"#/components/schemas/oneOfBackup_serverOptionsDef"}},"required":["preferred_server"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfPreferred_serverOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/preferred_serverDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBackup_serverOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/backup_serverDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"preferred_serverDef":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]},"backup_serverDef":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Ntp profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"NtpParcelGlobalDefault":{"value":{"data":{"preferred_server":{"optionType":"global","value":"xxx"},"backup_server":{"optionType":"global","value":"xxx"}},"name":"NtpParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/ntp/post/request_schema.json","title":"Ntp Parcel Schema","description":"Ntp profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"preferred_server":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"backup_server":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["preferred_server"],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for Ntp profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"preferred_server":{"optionType":"global","value":"xxx"},"backup_server":{"optionType":"global","value":"xxx"}},"name":"NtpParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-46":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/ntp/put/request_schema.json","title":"Ntp Parcel Schema","description":"Ntp profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"preferred_server":{"description":"Set Preferred server","type":"object","$ref":"#/components/schemas/oneOfPreferred_serverOptionsDef"},"backup_server":{"description":"Set up back up server","type":"object","$ref":"#/components/schemas/oneOfBackup_serverOptionsDef"}},"required":["preferred_server"],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfPreferred_serverOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/preferred_serverDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfBackup_serverOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/backup_serverDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"preferred_serverDef":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]},"backup_serverDef":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Ntp profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"NtpParcelGlobalDefault":{"value":{"data":{"preferred_server":{"optionType":"global","value":"xxx"},"backup_server":{"optionType":"global","value":"xxx"}},"name":"NtpParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/ntp/put/request_schema.json","title":"Ntp Parcel Schema","description":"Ntp profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"preferred_server":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"backup_server":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","anyOf":[{"format":"ipv4"},{"pattern":"((([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.)*([a-zA-Z0-9_]([a-zA-Z0-9\\-_]){0,61})?[a-zA-Z0-9]\\.?)|\\.","minLength":1,"maxLength":253}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["preferred_server"],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for Ntp profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"preferred_server":{"optionType":"global","value":"xxx"},"backup_server":{"optionType":"global","value":"xxx"}},"name":"NtpParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"communityNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"oneOfCommunityNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/communityNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"communityCommunityAccessDef":{"default":"readOnly","type":"string"},"oneOfCommunityCommunityAccessOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/communityCommunityAccessDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"oneOfGroupNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupContextDef":{"default":"snmp","minLength":1,"type":"string","maxLength":32},"oneOfGroupContextOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupContextDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupVersionDef":{"default":"1","type":"string"},"oneOfGroupVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupVersionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupSecurityLevelDef":{"default":"noAuthNoPriv","type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]},"oneOfGroupSecurityLevelOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupNotifyDef":{"default":"snmpNotify","type":"string","pattern":"[A-Za-z0-9_-]+"},"oneOfGroupNotifyOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupNotifyDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupReadDef":{"default":"snmpRead","type":"string","pattern":"[A-Za-z0-9_-]+"},"oneOfGroupReadOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupReadDef"}},"required":["optionType","value"],"additionalProperties":false}]},"groupWriteDef":{"default":"snmpWrite","type":"string","pattern":"[A-Za-z0-9_-]+"},"oneOfGroupWriteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupWriteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"userUserNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"oneOfUserUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userUserNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"userVersionDef":{"default":"1","type":"string"},"defaultUserVersionDef":{"type":"string","enum":["1"]},"oneOfUserVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userVersionDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultUserVersionDef"}},"required":["optionType"],"additionalProperties":false}]},"userUserGroupDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"oneOfUserUserGroupOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userUserGroupDef"}},"required":["optionType","value"],"additionalProperties":false}]},"userAuthProtocolDef":{"enum":["md5","sha"],"type":"string"},"oneOfUserAuthProtocolOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userAuthProtocolDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"userPrivProtocolDef":{"enum":["aes","des"],"type":"string"},"oneOfUserPrivProtocolOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPrivProtocolDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"userPassphraseDef":{"minimum":8,"type":"string"},"oneOfUserPassphraseOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPassphraseDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"hostHostNameDef":{"type":"string","minLength":1,"maxLength":32},"oneOfHostHostNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"hostIpDef":{"type":"string","minLength":1,"anyOf":[{"format":"ipv4"}]},"oneOfHostIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostIpDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"hostPortDef":{"default":162,"type":"integer","minimum":0,"maximum":65535},"oneOfHostPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostPortDef"}},"required":["optionType","value"],"additionalProperties":false}]},"hostHostUserNameDef":{"minLength":1,"type":"string","maxLength":32},"oneOfHostHostUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostUserNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"hostHostVersionDef":{"default":"1","type":"string"},"oneOfHostHostVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostVersionDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"hostHostSecurityLevelDef":{"type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]},"oneOfHostHostSecurityLevelOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfLinkUpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfLinkDownOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"request_schema-47":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/snmp/post/request_schema.json","title":"SNMP Parcel Schema","description":"SNMP profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"community":{"description":"Configure SNMP community","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"communityName":{"description":"Set name of the SNMP community","type":"object","$ref":"#/components/schemas/oneOfCommunityNameOptionsDef"},"communityAccess":{"description":"community access SNMP community","type":"object","$ref":"#/components/schemas/oneOfCommunityCommunityAccessOptionsDef"}},"required":["communityName"],"additionalProperties":false}},"group":{"description":"Configure an SNMP group","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"name":{"description":"Name of the SNMP group","type":"object","$ref":"#/components/schemas/oneOfGroupNameOptionsDef"},"context":{"description":"context","type":"object","$ref":"#/components/schemas/oneOfGroupContextOptionsDef"},"version":{"description":"version","type":"object","$ref":"#/components/schemas/oneOfGroupVersionOptionsDef"},"securityLevel":{"description":"Configure security level","type":"object","$ref":"#/components/schemas/oneOfGroupSecurityLevelOptionsDef"},"notify":{"description":"Configure notify level","type":"object","$ref":"#/components/schemas/oneOfGroupNotifyOptionsDef"},"read":{"description":"Configure notify level","type":"object","$ref":"#/components/schemas/oneOfGroupReadOptionsDef"},"write":{"description":"Configure write level","type":"object","$ref":"#/components/schemas/oneOfGroupWriteOptionsDef"}},"required":["name","securityLevel","context"],"additionalProperties":false}},"user":{"description":"Configure an SNMP user","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"userName":{"description":"Name of the SNMP user","type":"object","$ref":"#/components/schemas/oneOfUserUserNameOptionsDef"},"version":{"description":"Configure version ","type":"object","$ref":"#/components/schemas/oneOfUserVersionOptionsDef"},"userGroup":{"description":"Name of the SNMP group","type":"object","$ref":"#/components/schemas/oneOfUserUserGroupOptionsDef"},"authProtocol":{"description":"Configure authentication protocol","type":"object","$ref":"#/components/schemas/oneOfUserAuthProtocolOptionsDef"},"privProtocol":{"description":"Configure privacy protocol","type":"object","$ref":"#/components/schemas/oneOfUserPrivProtocolOptionsDef"},"passphrase":{"description":"Specify passphrase","type":"object","$ref":"#/components/schemas/oneOfUserPassphraseOptionsDef"}},"required":["userName","version","userGroup"],"additionalProperties":false}},"host":{"description":"Configure SNMP server to receive SNMP traps","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"hostName":{"description":"Set host name for\u00a0 SNMP server","type":"object","$ref":"#/components/schemas/oneOfHostHostNameOptionsDef"},"ip":{"description":"Set IPv4 address of SNMP server","type":"object","$ref":"#/components/schemas/oneOfHostIpOptionsDef"},"port":{"description":"Set host port number to connect to SNMP server","type":"object","$ref":"#/components/schemas/oneOfHostPortOptionsDef"},"hostUserName":{"description":"Set name of the SNMP user","type":"object","$ref":"#/components/schemas/oneOfHostHostUserNameOptionsDef"},"hostVersion":{"description":"Set version of the SNMP host","type":"object","$ref":"#/components/schemas/oneOfHostHostVersionOptionsDef"},"hostSecurityLevel":{"description":"Host security level","type":"object","$ref":"#/components/schemas/oneOfHostHostSecurityLevelOptionsDef"}},"required":["hostName","ip","port","hostUserName","hostVersion","hostSecurityLevel"],"additionalProperties":false}},"linkUp":{"description":"SNMP Trap LinkUp","type":"object","$ref":"#/components/schemas/oneOfLinkUpOptionsDef"},"linkDown":{"description":"SNMP Trap LinkDown","type":"object","$ref":"#/components/schemas/oneOfLinkDownOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfCommunityNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/communityNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfCommunityCommunityAccessOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/communityCommunityAccessDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupContextOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupContextDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupVersionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupSecurityLevelOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupNotifyOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupNotifyDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupReadOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupReadDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupWriteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupWriteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUserUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userUserNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUserVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userVersionDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultUserVersionDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfUserUserGroupOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userUserGroupDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUserAuthProtocolOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userAuthProtocolDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserPrivProtocolOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPrivProtocolDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserPassphraseOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPassphraseDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostHostNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostIpDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostPortDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfHostHostUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostUserNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfHostHostVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostVersionDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostHostSecurityLevelOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfLinkUpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfLinkDownOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"communityNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"communityCommunityAccessDef":{"default":"readOnly","type":"string"},"groupNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"groupContextDef":{"default":"snmp","minLength":1,"type":"string","maxLength":32},"groupVersionDef":{"default":"1","type":"string"},"groupSecurityLevelDef":{"default":"noAuthNoPriv","type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]},"groupNotifyDef":{"default":"snmpNotify","type":"string","pattern":"[A-Za-z0-9_-]+"},"groupReadDef":{"default":"snmpRead","type":"string","pattern":"[A-Za-z0-9_-]+"},"groupWriteDef":{"default":"snmpWrite","type":"string","pattern":"[A-Za-z0-9_-]+"},"userUserNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"defaultUserVersionDef":{"type":"string","enum":["1"]},"userVersionDef":{"default":"1","type":"string"},"userUserGroupDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"userAuthProtocolDef":{"enum":["md5","sha"],"type":"string"},"userPrivProtocolDef":{"enum":["aes","des"],"type":"string"},"userPassphraseDef":{"minimum":8,"type":"string"},"hostHostNameDef":{"type":"string","minLength":1,"maxLength":32},"hostHostSecurityLevelDef":{"type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]},"hostIpDef":{"type":"string","minLength":1,"anyOf":[{"format":"ipv4"}]},"hostPortDef":{"default":162,"type":"integer","minimum":0,"maximum":65535},"hostHostUserNameDef":{"minLength":1,"type":"string","maxLength":32},"hostHostVersionDef":{"default":"1","type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for SNMP profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"community":{"name":{"optionType":"global","value":"xxx"},"communityAccess":{"optionType":"default","value":"readOnly"}},"group":{"name":{"optionType":"global","value":"xxx"},"context":{"optionType":"default","value":"snmp"},"version":{"optionType":"default","value":"1"},"securityLevel":{"optionType":"default","value":"noAuthNoPriv"},"notify":{"optionType":"default","value":"snmpNotify"},"read":{"optionType":"default","value":"snmpRead"},"write":{"optionType":"default","value":"snmpWrite"}},"user":{"userName":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"1"},"userGroup":{"optionType":"global","value":"xxx"},"authProtocol":{"optionType":"global","value":"xxx"},"privProtocol":{"optionType":"global","value":"xxx"},"passphrase":{"optionType":"global","value":"xxx"}},"host":{"hostName":{"optionType":"global","value":"xxx"},"ip":{"optionType":"global","value":"xxx"},"port":{"optionType":"default","value":162},"hostUserName":{"optionType":"global","value":"xxx"},"hostVersion":{"optionType":"default","value":"1"},"hostSecurityLevel":{"optionType":"global","value":"xxx"}},"linkUp":{"optionType":"default","value":false},"linkDown":{"optionType":"default","value":false}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/snmp/post/request_schema.json","title":"SNMP Parcel Schema","description":"SNMP profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"community":{"description":"Configure SNMP community","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"communityName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"communityAccess":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"readOnly","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["communityName"],"additionalProperties":false}},"group":{"description":"Configure an SNMP group","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"context":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmp","minLength":1,"type":"string","maxLength":32}},"required":["optionType","value"],"additionalProperties":false}]},"version":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"1","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"securityLevel":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"noAuthNoPriv","type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]}},"required":["optionType","value"],"additionalProperties":false}]},"notify":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmpNotify","type":"string","pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"read":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmpRead","type":"string","pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"write":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmpWrite","type":"string","pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","securityLevel","context"],"additionalProperties":false}},"user":{"description":"Configure an SNMP user","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"userName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"version":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"1","type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["1"]}},"required":["optionType"],"additionalProperties":false}]},"userGroup":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"authProtocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["md5","sha"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"privProtocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["aes","des"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"passphrase":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":8,"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["userName","version","userGroup"],"additionalProperties":false}},"host":{"description":"Configure SNMP server to receive SNMP traps","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"hostName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1,"maxLength":32}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"ip":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1,"anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":162,"type":"integer","minimum":0,"maximum":65535}},"required":["optionType","value"],"additionalProperties":false}]},"hostUserName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32}},"required":["optionType","value"],"additionalProperties":false}]},"hostVersion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"1","type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"hostSecurityLevel":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["hostName","ip","port","hostUserName","hostVersion","hostSecurityLevel"],"additionalProperties":false}},"linkUp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"linkDown":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for SNMP profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"community":{"name":{"optionType":"global","value":"xxx"},"communityAccess":{"optionType":"default","value":"readOnly"}},"group":{"name":{"optionType":"global","value":"xxx"},"context":{"optionType":"default","value":"snmp"},"version":{"optionType":"default","value":"1"},"securityLevel":{"optionType":"default","value":"noAuthNoPriv"},"notify":{"optionType":"default","value":"snmpNotify"},"read":{"optionType":"default","value":"snmpRead"},"write":{"optionType":"default","value":"snmpWrite"}},"user":{"userName":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"1"},"userGroup":{"optionType":"global","value":"xxx"},"authProtocol":{"optionType":"global","value":"xxx"},"privProtocol":{"optionType":"global","value":"xxx"},"passphrase":{"optionType":"global","value":"xxx"}},"host":{"hostName":{"optionType":"global","value":"xxx"},"ip":{"optionType":"global","value":"xxx"},"port":{"optionType":"default","value":162},"hostUserName":{"optionType":"global","value":"xxx"},"hostVersion":{"optionType":"default","value":"1"},"hostSecurityLevel":{"optionType":"global","value":"xxx"}},"linkUp":{"optionType":"default","value":false},"linkDown":{"optionType":"default","value":false}},"name":"[parcelType]ParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"request_schema-48":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/snmp/put/request_schema.json","title":"SNMP Parcel Schema","description":"SNMP profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"community":{"description":"Configure SNMP community","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"communityName":{"description":"Set name of the SNMP community","type":"object","$ref":"#/components/schemas/oneOfCommunityNameOptionsDef"},"communityAccess":{"description":"community access SNMP community","type":"object","$ref":"#/components/schemas/oneOfCommunityCommunityAccessOptionsDef"}},"required":["communityName"],"additionalProperties":false}},"group":{"description":"Configure an SNMP group","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"name":{"description":"Name of the SNMP group","type":"object","$ref":"#/components/schemas/oneOfGroupNameOptionsDef"},"context":{"description":"context","type":"object","$ref":"#/components/schemas/oneOfGroupContextOptionsDef"},"version":{"description":"version","type":"object","$ref":"#/components/schemas/oneOfGroupVersionOptionsDef"},"securityLevel":{"description":"Configure security level","type":"object","$ref":"#/components/schemas/oneOfGroupSecurityLevelOptionsDef"},"notify":{"description":"Configure notify level","type":"object","$ref":"#/components/schemas/oneOfGroupNotifyOptionsDef"},"read":{"description":"Configure notify level","type":"object","$ref":"#/components/schemas/oneOfGroupReadOptionsDef"},"write":{"description":"Configure write level","type":"object","$ref":"#/components/schemas/oneOfGroupWriteOptionsDef"}},"required":["name","securityLevel","context"],"additionalProperties":false}},"user":{"description":"Configure an SNMP user","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"userName":{"description":"Name of the SNMP user","type":"object","$ref":"#/components/schemas/oneOfUserUserNameOptionsDef"},"version":{"description":"Configure version ","type":"object","$ref":"#/components/schemas/oneOfUserVersionOptionsDef"},"userGroup":{"description":"Name of the SNMP group","type":"object","$ref":"#/components/schemas/oneOfUserUserGroupOptionsDef"},"authProtocol":{"description":"Configure authentication protocol","type":"object","$ref":"#/components/schemas/oneOfUserAuthProtocolOptionsDef"},"privProtocol":{"description":"Configure privacy protocol","type":"object","$ref":"#/components/schemas/oneOfUserPrivProtocolOptionsDef"},"passphrase":{"description":"Specify passphrase","type":"object","$ref":"#/components/schemas/oneOfUserPassphraseOptionsDef"}},"required":["userName","version","userGroup"],"additionalProperties":false}},"host":{"description":"Configure SNMP server to receive SNMP traps","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"hostName":{"description":"Set host name for\u00a0 SNMP server","type":"object","$ref":"#/components/schemas/oneOfHostHostNameOptionsDef"},"ip":{"description":"Set IPv4 address of SNMP server","type":"object","$ref":"#/components/schemas/oneOfHostIpOptionsDef"},"port":{"description":"Set host port number to connect to SNMP server","type":"object","$ref":"#/components/schemas/oneOfHostPortOptionsDef"},"hostUserName":{"description":"Set name of the SNMP user","type":"object","$ref":"#/components/schemas/oneOfHostHostUserNameOptionsDef"},"hostVersion":{"description":"Set version of the SNMP host","type":"object","$ref":"#/components/schemas/oneOfHostHostVersionOptionsDef"},"hostSecurityLevel":{"description":"Host security level","type":"object","$ref":"#/components/schemas/oneOfHostHostSecurityLevelOptionsDef"}},"required":["hostName","ip","port","hostUserName","hostVersion","hostSecurityLevel"],"additionalProperties":false}},"linkUp":{"description":"SNMP Trap LinkUp","type":"object","$ref":"#/components/schemas/oneOfLinkUpOptionsDef"},"linkDown":{"description":"SNMP Trap LinkDown","type":"object","$ref":"#/components/schemas/oneOfLinkDownOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfCommunityNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/communityNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfCommunityCommunityAccessOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/communityCommunityAccessDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupContextOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupContextDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupVersionDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupSecurityLevelOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupNotifyOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupNotifyDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupReadOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupReadDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfGroupWriteOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/groupWriteDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUserUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userUserNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUserVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userVersionDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/defaultUserVersionDef"}},"required":["optionType"],"additionalProperties":false}]},"oneOfUserUserGroupOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userUserGroupDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfUserAuthProtocolOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userAuthProtocolDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserPrivProtocolOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPrivProtocolDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfUserPassphraseOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/userPassphraseDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostHostNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostIpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostIpDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostPortOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostPortDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfHostHostUserNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostUserNameDef"}},"required":["optionType","value"],"additionalProperties":false}]},"oneOfHostHostVersionOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostVersionDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfHostHostSecurityLevelOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/hostHostSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfLinkUpOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfLinkDownOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"communityNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"communityCommunityAccessDef":{"default":"readOnly","type":"string"},"groupNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"groupContextDef":{"default":"snmp","minLength":1,"type":"string","maxLength":32},"groupVersionDef":{"default":"1","type":"string"},"groupSecurityLevelDef":{"default":"noAuthNoPriv","type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]},"groupNotifyDef":{"default":"snmpNotify","type":"string","pattern":"[A-Za-z0-9_-]+"},"groupReadDef":{"default":"snmpRead","type":"string","pattern":"[A-Za-z0-9_-]+"},"groupWriteDef":{"default":"snmpWrite","type":"string","pattern":"[A-Za-z0-9_-]+"},"userUserNameDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"defaultUserVersionDef":{"type":"string","enum":["1"]},"userVersionDef":{"default":"1","type":"string"},"userUserGroupDef":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"},"userAuthProtocolDef":{"enum":["md5","sha"],"type":"string"},"userPrivProtocolDef":{"enum":["aes","des"],"type":"string"},"userPassphraseDef":{"minimum":8,"type":"string"},"hostHostNameDef":{"type":"string","minLength":1,"maxLength":32},"hostHostSecurityLevelDef":{"type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]},"hostIpDef":{"type":"string","minLength":1,"anyOf":[{"format":"ipv4"}]},"hostPortDef":{"default":162,"type":"integer","minimum":0,"maximum":65535},"hostHostUserNameDef":{"minLength":1,"type":"string","maxLength":32},"hostHostVersionDef":{"default":"1","type":"string"},"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for SNMP profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"[parcelType]ParcelGlobalDefault":{"value":{"data":{"community":{"name":{"optionType":"global","value":"xxx"},"communityAccess":{"optionType":"default","value":"readOnly"}},"group":{"name":{"optionType":"global","value":"xxx"},"context":{"optionType":"default","value":"snmp"},"version":{"optionType":"default","value":"1"},"securityLevel":{"optionType":"default","value":"noAuthNoPriv"},"notify":{"optionType":"default","value":"snmpNotify"},"read":{"optionType":"default","value":"snmpRead"},"write":{"optionType":"default","value":"snmpWrite"}},"user":{"userName":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"1"},"userGroup":{"optionType":"global","value":"xxx"},"authProtocol":{"optionType":"global","value":"xxx"},"privProtocol":{"optionType":"global","value":"xxx"},"passphrase":{"optionType":"global","value":"xxx"}},"host":{"hostName":{"optionType":"global","value":"xxx"},"ip":{"optionType":"global","value":"xxx"},"port":{"optionType":"default","value":162},"hostUserName":{"optionType":"global","value":"xxx"},"hostVersion":{"optionType":"default","value":"1"},"hostSecurityLevel":{"optionType":"global","value":"xxx"}},"linkUp":{"optionType":"default","value":false},"linkDown":{"optionType":"default","value":false}},"name":"[parcelType]ParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/snmp/put/request_schema.json","title":"SNMP Parcel Schema","description":"SNMP profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"community":{"description":"Configure SNMP community","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"communityName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"communityAccess":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"readOnly","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["communityName"],"additionalProperties":false}},"group":{"description":"Configure an SNMP group","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"context":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmp","minLength":1,"type":"string","maxLength":32}},"required":["optionType","value"],"additionalProperties":false}]},"version":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"1","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"securityLevel":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"noAuthNoPriv","type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]}},"required":["optionType","value"],"additionalProperties":false}]},"notify":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmpNotify","type":"string","pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"read":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmpRead","type":"string","pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"write":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"snmpWrite","type":"string","pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name","securityLevel","context"],"additionalProperties":false}},"user":{"description":"Configure an SNMP user","type":"array","uniqueItems":true,"maxItems":10,"items":{"type":"object","properties":{"userName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"version":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"1","type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"string","enum":["1"]}},"required":["optionType"],"additionalProperties":false}]},"userGroup":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"[A-Za-z0-9_-]+"}},"required":["optionType","value"],"additionalProperties":false}]},"authProtocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["md5","sha"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"privProtocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["aes","des"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"passphrase":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":8,"type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["userName","version","userGroup"],"additionalProperties":false}},"host":{"description":"Configure SNMP server to receive SNMP traps","type":"array","uniqueItems":true,"maxItems":4,"items":{"type":"object","properties":{"hostName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1,"maxLength":32}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"ip":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","minLength":1,"anyOf":[{"format":"ipv4"}]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":162,"type":"integer","minimum":0,"maximum":65535}},"required":["optionType","value"],"additionalProperties":false}]},"hostUserName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"type":"string","maxLength":32}},"required":["optionType","value"],"additionalProperties":false}]},"hostVersion":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"default":"1","type":"string"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"hostSecurityLevel":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","enum":["noAuthNoPriv","authNoPriv","authPriv"]}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["hostName","ip","port","hostUserName","hostVersion","hostSecurityLevel"],"additionalProperties":false}},"linkUp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]},"linkDown":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for SNMP profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"community":{"name":{"optionType":"global","value":"xxx"},"communityAccess":{"optionType":"default","value":"readOnly"}},"group":{"name":{"optionType":"global","value":"xxx"},"context":{"optionType":"default","value":"snmp"},"version":{"optionType":"default","value":"1"},"securityLevel":{"optionType":"default","value":"noAuthNoPriv"},"notify":{"optionType":"default","value":"snmpNotify"},"read":{"optionType":"default","value":"snmpRead"},"write":{"optionType":"default","value":"snmpWrite"}},"user":{"userName":{"optionType":"global","value":"xxx"},"version":{"optionType":"default","value":"1"},"userGroup":{"optionType":"global","value":"xxx"},"authProtocol":{"optionType":"global","value":"xxx"},"privProtocol":{"optionType":"global","value":"xxx"},"passphrase":{"optionType":"global","value":"xxx"}},"host":{"hostName":{"optionType":"global","value":"xxx"},"ip":{"optionType":"global","value":"xxx"},"port":{"optionType":"default","value":162},"hostUserName":{"optionType":"global","value":"xxx"},"hostVersion":{"optionType":"default","value":"1"},"hostSecurityLevel":{"optionType":"global","value":"xxx"}},"linkUp":{"optionType":"default","value":false},"linkDown":{"optionType":"default","value":false}},"name":"[parcelType]ParcelGlobalDefault"}]}},"required":["data"],"not":{"required":["documentation","metadata"]},"additionalProperties":false}}},"additionalProperties":false},"nameServerNameDef":{"type":"string","format":"ipv4"},"oneOfNameServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/nameServerNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDpdkOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"request_schema-49":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/system-settings/post/request_schema.json","title":"SystemSettings Parcel Schema","description":"SystemSettings profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"nameServer":{"description":"Name Server","type":"array","maxItems":3,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Set hostname or IPv4 address of server","type":"object","$ref":"#/components/schemas/oneOfNameServerNameOptionsDef"}},"required":["name"],"additionalProperties":false}},"dpdk":{"description":"Enable/Disable Data Plane Development Kit","type":"object","$ref":"#/components/schemas/oneOfDpdkOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/nameServerNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDpdkOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"nameServerNameDef":{"type":"string","format":"ipv4"},"additionalProperties":false,"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for SystemSettings profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"SystemSettingsParcelGlobalDefault":{"value":{"data":{"nameServer":{"name":{"optionType":"global","value":"xxx"}},"dpdk":{"optionType":"default","value":false}},"name":"SystemSettingsParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/system-settings/post/request_schema.json","title":"SystemSettings Parcel Schema","description":"SystemSettings profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"nameServer":{"description":"Name Server","type":"array","maxItems":3,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","format":"ipv4"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name"],"additionalProperties":false}},"dpdk":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for POST request schema for SystemSettings profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"nameServer":{"name":{"optionType":"global","value":"xxx"}},"dpdk":{"optionType":"default","value":false}},"name":"SystemSettingsParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]}}}}},"request_schema-50":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/system-settings/put/request_schema.json","title":"SystemSettings Parcel Schema","description":"SystemSettings profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"nameServer":{"description":"Name Server","type":"array","maxItems":3,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Set hostname or IPv4 address of server","type":"object","$ref":"#/components/schemas/oneOfNameServerNameOptionsDef"}},"required":["name"],"additionalProperties":false}},"dpdk":{"description":"Enable/Disable Data Plane Development Kit","type":"object","$ref":"#/components/schemas/oneOfDpdkOptionsDef"}},"required":[],"additionalProperties":false},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"$defs":{"oneOfNameServerNameOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/nameServerNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"$ref":"#/components/schemas/variableOptionTypeObjectDef"}]},"oneOfDpdkOptionsDef":{"oneOf":[{"properties":{"optionType":{"$ref":"#/components/schemas/globalOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"$ref":"#/components/schemas/defaultOptionTypeDef"},"value":{"$ref":"#/components/schemas/booleanFalseDef"}},"required":["optionType"],"additionalProperties":false}]},"nameServerNameDef":{"type":"string","format":"ipv4"},"additionalProperties":false,"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for SystemSettings profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":{"SystemSettingsParcelGlobalDefault":{"value":{"data":{"nameServer":{"name":{"optionType":"global","value":"xxx"}},"dpdk":{"optionType":"default","value":false}},"name":"SystemSettingsParcelGlobalDefault"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/nfvirtual/system/system-settings/put/request_schema.json","title":"SystemSettings Parcel Schema","description":"SystemSettings profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"nameServer":{"description":"Name Server","type":"array","maxItems":3,"uniqueItems":true,"items":{"type":"object","properties":{"name":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","format":"ipv4"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}},"required":["name"],"additionalProperties":false}},"dpdk":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"boolean"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"type":"boolean","enum":[false]}},"required":["optionType"],"additionalProperties":false}]}},"required":[],"additionalProperties":false},"documentation":{"description":"This is the documentation for PUT request schema for SystemSettings profile parcel","details-1":"variable name should be present with given format as specified in schema if optionType value is variable","details-2":"variable name should not be present if optionType value is NOT variable","details-3":"when option Type is global, value should be present with given format/restrictions as specified in schema","details-4":"when option Type is default, value should be present with given default value as specified in schema","examples":[{"data":{"nameServer":{"name":{"optionType":"global","value":"xxx"}},"dpdk":{"optionType":"default","value":false}},"name":"SystemSettingsParcelGlobalDefault"}]},"metadata":{"minVManageVersion":"20.15.1"}},"required":["data"],"not":{"required":["documentation","metadata"]}}}}},"request_schema-51":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/sd-routing/cli/config/post/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for POST request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"}},"required":["name","data"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for POST request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","properties":{"clisSupportedForEncryption":{"$ref":"../../../../../common/common_defs_schema.json#/properties/encryptionSupportedClisForSdRouting"}},"examples":{"CliAddOnFeature1":{"value":{"data":{"config":"bfd default-dscp 48\nbfd app-route multiplier 6\nbfd app-route poll-interval 600000"},"name":"CliAddOnFeature1"}},"CliAddOnFeature2":{"value":{"data":{"config":"vrf definition 100"},"name":"CliAddOnFeature2"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/sd-routing/cli/config/post/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for POST request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for POST request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","properties":{"clisSupportedForEncryption":{"description":"The section below lists the specific CLI's which support type 6 encryption. In the CLI's below, only the fields specified as 'encryptionSupportedField' are supported for type 6 encryption.","cliList":[{"cliSyntax":"aaa group server radius \n server-private key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"aaa group server tacacs+ \n server-private key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"radius-server key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"tacacs-server key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"aaa server radius dynamic-author\n server-key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"aaa server radius dynamic-author\n client vrf server-key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host ","encryptionSupportedField":""},{"cliSyntax":"snmp-server community ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host udp-port ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host vrf ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host vrf udp-port ","encryptionSupportedField":""},{"cliSyntax":"snmp mib community-map <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"secure-internet-gateway\n umbrella api-secret ","encryptionSupportedField":""},{"cliSyntax":"parameter-map type umbrella global\n secret <0,6> ","encryptionSupportedField":""},{"cliSyntax":"secure-internet-gateway\n zscaler password ","encryptionSupportedField":""},{"cliSyntax":"cts credentials id password <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"cts sxp default password <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"username secret <0/5/8/9> ","encryptionSupportedField":""},{"cliSyntax":"router bgp <1-4294967295>\n neighbor password ","encryptionSupportedField":""},{"cliSyntax":"router bgp <1-4294967295>\n address-family ipv4 unicast vrf \n neighbor password ","encryptionSupportedField":""},{"cliSyntax":"router bgp <1-4294967295>\n address-family ipv6 unicast vrf \n neighbor password ","encryptionSupportedField":""},{"cliSyntax":"key chain \n key-string <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"ntp authentication-key <1-4294967295> md5 ","encryptionSupportedField":""},{"cliSyntax":"controller Cellular myCellular\n profile id apn authentication username password ","encryptionSupportedField":""},{"cliSyntax":"interface Loopback\n ip ospf message-digest-key md5 ","encryptionSupportedField":""},{"cliSyntax":"interface GigabitEthernet\n ip ospf message-digest-key md5 ","encryptionSupportedField":""},{"cliSyntax":"interface TenGigabitEthernet\n ip ospf message-digest-key md5 ","encryptionSupportedField":""},{"cliSyntax":"interface HundredGigE\n ip ospf message-digest-key md5 ","encryptionSupportedField":""},{"cliSyntax":"interface FortyGigabitEthernet\n ip ospf message-digest-key md5 ","encryptionSupportedField":""},{"cliSyntax":"interface Vlan\n ip ospf message-digest-key md5 ","encryptionSupportedField":""},{"cliSyntax":"ip msdp vrf password peer ","encryptionSupportedField":""}]}},"examples":[{"data":{"config":"bfd default-dscp 48\nbfd app-route multiplier 6\nbfd app-route poll-interval 600000"},"name":"CliAddOnFeature1"},{"data":{"config":"vrf definition 100"},"name":"CliAddOnFeature2"}]}},"required":["name","data"],"not":{"required":["metadata","documentation"]},"additionalProperties":false}}}},"request_schema-52":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/sd-routing/cli/config/put/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for PUT request","type":"object","properties":{"name":{"$ref":"#/components/schemas/cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"}},"required":["name","data"],"additionalProperties":false,"$defs":{"Schema2HubGeneratedDocumentation":{"description":"This is the documentation for PUT request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","properties":{"clisSupportedForEncryption":{"$ref":"../../../../../common/common_defs_schema.json#/properties/encryptionSupportedClisForSdRouting"}},"examples":{"CliAddOnFeature1":{"value":{"data":{"config":"bfd default-dscp 48\nbfd app-route multiplier 6\nbfd app-route poll-interval 600000"},"name":"CliAddOnFeature1"}},"CliAddOnFeature2":{"value":{"data":{"config":"vrf definition 100"},"name":"CliAddOnFeature2"}}},"resolved":{"$schema":"http://json-schema.org/draft/2019-09/schema","$id":"https://cisco.com/schema/profileparcel/sd-routing/cli/config/put/request_schema.json","title":"Config Parcel Schema","description":"Config profile parcel schema for PUT request","type":"object","properties":{"name":{"type":"string","pattern":"^[^&<>! \"]+$","minLength":1,"maxLength":128},"description":{"type":"string"},"data":{"type":"object","properties":{"config":{"type":"string"}},"required":["config"],"additionalProperties":false},"metadata":{"supportedDeviceTypes":["all"],"minVManageVersion":"20.15.1"},"documentation":{"description":"This is the documentation for PUT request schema for Config profile parcel","details-1":"data.config attribute will have device CLI configuration as string","properties":{"clisSupportedForEncryption":{"description":"The section below lists the specific CLI's which support type 6 encryption. In the CLI's below, only the fields specified as 'encryptionSupportedField' are supported for type 6 encryption.","cliList":[{"cliSyntax":"aaa group server radius \n server-private key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"aaa group server tacacs+ \n server-private key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"radius-server key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"tacacs-server key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"aaa server radius dynamic-author\n server-key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"aaa server radius dynamic-author\n client vrf server-key <0/6/7> ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host ","encryptionSupportedField":""},{"cliSyntax":"snmp-server community ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host udp-port ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host vrf ","encryptionSupportedField":""},{"cliSyntax":"snmp-server host vrf udp-port